Syncing customer data via file

Column names and descriptions for customer data in TSV files

CitrusAd only supports TSV format for customer data. The table below describes the names of columns in a TSV file and their descriptions. For customer data, the only required column is customer_id.

Column nameRequired/optionalData typeDescription
customer_idRequiredTextThis is the identifier of the customer in the retailer's system.
year_of_birthOptionalNumberThis is the birthday year of the customer. This must be a number.
genderOptionalTextThis is the gender of the customer. If the value is provided, it must be one of the values {“UNDEFINED”, “FEMALE”, “MALE”, “OTHER”}.
The value is case-insensitive.
postcodeOptionalTextThis is the postcode of the contact address of the customer.
suburbOptionalTextThis is the suburb of the contact address of the customer.
target_dataOptionalJson mapIf the value is provided, it must be a json map, e.g.
{"customer_type" : "corporate", "customer_country" : "Australia"}
customer_targeting:KEYOptionalTextIf this type of column is used, retailers must provide a value for KEY, e.g. the column name could be “customer_targeting:customer_type” and the value of a cell in the column can be “corporate”, “smb” or “retailer”.

There could be several columns with this syntax in a TSV file.

An example of a TSV file with a heading row and three data rows for customers can be seen in the table below. Please note that the raw data is a text file, but it is represented in a table so that we can read it easily.