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 name | Required/optional | Data type | Description |
|---|---|---|---|
customer_id | Required | Text | This is the identifier of the customer in the retailer's system. |
year_of_birth | Optional | Number | No longer used. This is the birthday year of the customer. This must be a number. |
gender | Optional | Text | No longer used. This 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. |
postcode | Optional | Text | No longer used. This is the postcode of the contact address of the customer. |
suburb | Optional | Text | No longer used. This is the suburb of the contact address of the customer. |
status | Required if syncing delta updates | Text | When syncing delta changes via file, this is used to signify the action to take on the customer ID. Accepted values are INSERT, UPDATE, andDELETE |
target_data | Optional | Json map | If the value is provided, it must be a json map, e.g. {"customer_type" : "corporate", "customer_country" : "Australia"} |
customer_targeting:KEY | Optional | Text | If 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 for a full file sync. Please note that the raw data is a text file, but it is represented in a table so that we can read it easily.
customer_id | year_of_birth | gender | postcode | suburb | customer_targeting:customer_type |
|---|---|---|---|---|---|
| 0937832 | 1990 | MALE | 3000 | Melbourne | Retail |
| 0347293 | 1993 | FEMALE | 4000 | Brisbane | Retail |
| 0293423 | OTHER | 4064 | Milton | Corporate |
Synchronisation options
Full update
The full update mode allows retailers to synchronise their full file of customer information. This is the typical method integrated by a retailer, as it is simpler to set up.
Delta update
Delta updates are possible by adjusting your file to synchronise only updates or changes to customers. This is a better option for larger tier retailers with large audiences.
Your file must have the status column, as this signifies the action to take on the user. The accepted values are INSERT, UPDATE, andDELETE.
An example file is below:
customer_id | status | year_of_birth | gender | postcode | suburb | customer_targeting:customer_type |
|---|---|---|---|---|---|---|
| 1 | INSERT | 1990 | MALE | 3000 | Melbourne | Retail |
| 2 | UPDATE | 1993 | FEMALE | 4000 | Brisbane | Retail |
| 3 | DELETE | OTHER | 4064 | Milton | Corporate |
You cannot synchronise delta changes in a full update feed.
In the case of the feed above, customer ID 1 is new, customer 2 is being updated, and customer 3 has been removed by the retailer.