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 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

This is the birthday year of the customer. This must be a number.

gender

Optional

Text

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

This is the postcode of the contact address of the customer.

suburb

Optional

Text

This is the suburb of the contact address of the customer.

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. 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