- JSON representation
- CustomFloodlightVariable
- Type
- UserIdentifier
- OfflineUserAddressInfo
- ConsentStatus
- CartData
- Item
A Conversion represents when a user successfully performs a desired action after seeing an ad.
JSON representation |
---|
{ "floodlightConfigurationId": string, "floodlightActivityId": string, "encryptedUserId": string, "mobileDeviceId": string, "timestampMicros": string, "value": number, "quantity": string, "ordinal": string, "customVariables": [ { object ( |
Fields | |
---|---|
floodlightConfigurationId |
Floodlight Configuration ID of this conversion. This is a required field. |
floodlightActivityId |
Floodlight Activity ID of this conversion. This is a required field. |
encryptedUserId |
The alphanumeric encrypted user ID. When set,
should also be specified. This field is mutually exclusive with
,
,
,
,
, and
. This or
or
or
or
or
or
is a required field. |
mobileDeviceId |
The mobile device ID. This field is mutually exclusive with
,
,
,
,
, and
. This or
or
or
or
or
or
is a required field. |
timestampMicros |
The timestamp of conversion, in Unix epoch micros. This is a required field. |
value |
The value of the conversion. This is a required field. |
quantity |
The quantity of the conversion. This is a required field. |
ordinal |
The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. |
customVariables[] |
Custom floodlight variables. |
limitAdTracking |
Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. |
childDirectedTreatment |
Whether this particular request may come from a user under the age of 13, under COPPA compliance. |
encryptedUserIdCandidates[] |
A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set,
should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with
,
,
,
, and
. This or
or
or
or
or
or
is a required field. |
gclid |
The Google click ID. This field is mutually exclusive with
,
,
,
,
, and
. This or
or
or
or
or
or
is a required field. |
nonPersonalizedAd |
Whether the conversion was for a non personalized ad. |
treatmentForUnderage |
Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). |
matchId |
The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with
,
,
,
,
, and
. This or
or
or
or
or
or
is a required field. |
dclid |
The display click ID. This field is mutually exclusive with
,
,
,
,
, and
. This or
or
or
or
or
or
is a required field. |
impressionId |
The impression ID. This field is mutually exclusive with
,
,
,
, and
. One of these identifiers must be set. |
userIdentifiers[] |
The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
adUserDataConsent |
This represents consent for ad user data. |
cartData |
The cart data associated with this conversion. |
CustomFloodlightVariable
A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
The type of custom floodlight variable to supply a value for. These map to the "
" in the tags. |
value |
The value of the custom floodlight variable. The length of string must not exceed 100 characters. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
Type
Enums | |
---|---|
U1 |
|
U2 |
|
U3 |
|
U4 |
|
U5 |
|
U6 |
|
U7 |
|
U8 |
|
U9 |
|
U10 |
|
U11 |
|
U12 |
|
U13 |
|
U14 |
|
U15 |
|
U16 |
|
U17 |
|
U18 |
|
U19 |
|
U20 |
|
U21 |
|
U22 |
|
U23 |
|
U24 |
|
U25 |
|
U26 |
|
U27 |
|
U28 |
|
U29 |
|
U30 |
|
U31 |
|
U32 |
|
U33 |
|
U34 |
|
U35 |
|
U36 |
|
U37 |
|
U38 |
|
U39 |
|
U40 |
|
U41 |
|
U42 |
|
U43 |
|
U44 |
|
U45 |
|
U46 |
|
U47 |
|
U48 |
|
U49 |
|
U50 |
|
U51 |
|
U52 |
|
U53 |
|
U54 |
|
U55 |
|
U56 |
|
U57 |
|
U58 |
|
U59 |
|
U60 |
|
U61 |
|
U62 |
|
U63 |
|
U64 |
|
U65 |
|
U66 |
|
U67 |
|
U68 |
|
U69 |
|
U70 |
|
U71 |
|
U72 |
|
U73 |
|
U74 |
|
U75 |
|
U76 |
|
U77 |
|
U78 |
|
U79 |
|
U80 |
|
U81 |
|
U82 |
|
U83 |
|
U84 |
|
U85 |
|
U86 |
|
U87 |
|
U88 |
|
U89 |
|
U90 |
|
U91 |
|
U92 |
|
U93 |
|
U94 |
|
U95 |
|
U96 |
|
U97 |
|
U98 |
|
U99 |
|
U100 |
UserIdentifier
User identifying information. Exactly one type of identifier must be specified.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
hashedEmail |
Hashed email address using SHA-256 hash function after normalization. |
hashedPhoneNumber |
Hashed phone number using SHA-256 hash function after normalization (E164 standard). |
addressInfo |
Address information. |
OfflineUserAddressInfo
Identify a user by name and address.
JSON representation |
---|
{ "hashedFirstName": string, "hashedLastName": string, "city": string, "state": string, "countryCode": string, "postalCode": string, "hashedStreetAddress": string } |
Fields | |
---|---|
hashedFirstName |
First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between). |
hashedLastName |
Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation). |
city |
City of the address. |
state |
State code of the address. |
countryCode |
2-letter country code in ISO-3166-1 alpha-2 of the user's address. |
postalCode |
Postal code of the user's address. |
hashedStreetAddress |
The street address of the user hashed using SHA-256 hash function after normalization (lower case only). |
ConsentStatus
Enums | |
---|---|
GRANTED |
Granted. |
DENIED |
Denied. |
CartData
Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate.
JSON representation |
---|
{
"merchantId": string,
"merchantFeedLabel": string,
"merchantFeedLanguage": string,
"items": [
{
object ( |
Fields | |
---|---|
merchantId |
The Merchant Center ID where the items are uploaded. This is a required field. |
merchantFeedLabel |
The feed labels associated with the feed where your items are uploaded. For more information, please refer to https://support.google.com/merchants/answer/12453549. This is a required field. |
merchantFeedLanguage |
The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. |
items[] |
Data of the items purchased. |
Item
Contains data of the items purchased.
JSON representation |
---|
{ "itemId": string, "quantity": integer, "unitPrice": number } |
Fields | |
---|---|
itemId |
The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field. |
quantity |
Number of items sold. This is a required field. |
unitPrice |
Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. |