ClickConversion

A click conversion.

Proto definition

Fields

gbraid

string

The URL parameter for clicks associated with app conversions.

wbraid

string

The URL parameter for clicks associated with web conversions.

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.

customer_type

ConversionCustomerType

Type of the customer associated with the conversion (new or returning). Accessible only to customers on the allow-list.

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.

Union field

session_attributes

session_attributes. The session attributes for the event. session_attributes can be only one of the following:

session_attributes_encoded

bytes

The session attributes for the event, represented as a base64-encoded JSON string. The content should be generated by Google-provided library. To set session attributes individually, use session_attributes_key_value_pairs instead.

session_attributes_key_value_pairs

SessionAttributesKeyValuePairs

The session attributes for the event, represented as key-value pairs.