ClickConversion

A click conversion.

Fields

gbraid

string

The click identifier for clicks associated with app conversions and originating from iOS devices starting with iOS14.

wbraid

string

The click identifier for clicks associated with web conversions and originating from iOS devices starting with iOS14.

external_attribution_data

ExternalAttributionData

Additional data about externally attributed conversions. This field is required for conversions with an externally attributed conversion action, but should not be set otherwise.

custom_variables[]

CustomVariable

The custom variables associated with this conversion.

cart_data

CartData

The cart data associated with this conversion.

user_identifiers[]

UserIdentifier

The user identifiers associated with this conversion. Only hashed_email and hashed_phone_number are supported for conversion uploads. The maximum number of user identifiers for each conversion is 5.

conversion_environment

ConversionEnvironment

The environment this conversion was recorded on, for example, App or Web.

Consent

The consent setting for the event.

gclid

string

The Google click ID (gclid) associated with this conversion.

conversion_action

string

Resource name of the conversion action associated with this conversion. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.

conversion_date_time

string

The date time at which the conversion occurred. Must be after the click time. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".

conversion_value

double

The value of the conversion for the advertiser.

currency_code

string

Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.

order_id

string

The order ID associated with the conversion. An order id can only be used for one conversion per conversion action.