UserAttribute

  • User attributes are used with the CUSTOMER_MATCH_WITH_ATTRIBUTES job type and include fields such as purchase dates, purchase counts and values, acquisition date, lifecycle stage, event attributes, and lifetime values.

  • Purchase and acquisition date timestamps follow a specific format and can include an optional timezone offset.

  • Several fields, including lifecycle_stage, first_purchase_date_time, and event_attribute[], are optional.

  • Lifetime value can be defined by the advertiser in micros or categorized into a bucket from 1 to 10.

  • Shopping loyalty data is available for merchants on the allow-list with user consent to enhance the user shopping experience.

User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job type.

Fields

last_purchase_date_time

string

Timestamp of the last purchase made by the user. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.

average_purchase_count

int32

Advertiser defined average number of purchases that are made by the user in a 30 day period.

average_purchase_value_micros

int64

Advertiser defined average purchase value in micros for the user.

acquisition_date_time

string

Timestamp when the user was acquired. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.

lifecycle_stage

string

Optional. Advertiser defined lifecycle stage for the user. The accepted values are "Lead", "Active" and "Churned".

first_purchase_date_time

string

Optional. Timestamp of the first purchase made by the user. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.

event_attribute[]

EventAttribute

Optional. Advertiser defined events and their attributes. All the values in the nested fields are required. Currently this field is in beta.

lifetime_value_micros

int64

Advertiser defined lifetime value for the user.

lifetime_value_bucket

int32

Advertiser defined lifetime value bucket for the user. The valid range for a lifetime value bucket is from 1 (low) to 10 (high), except for remove operation where 0 will also be accepted.

shopping_loyalty

ShoppingLoyalty

The shopping loyalty related data. Shopping utilizes this data to provide users with a better experience. Accessible only to merchants on the allow-list with the user's consent.