You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/dfareporting_v4.conversions.html
+12-8Lines changed: 12 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,7 @@ <h3>Method Details</h3>
97
97
"conversions": [ # The set of conversions to insert.
98
98
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
99
99
"adUserDataConsent": "A String", # This represents consent for ad user data.
100
-
"cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. # The cart data associated with this conversion.
100
+
"cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
101
101
"items": [ # Data of the items purchased.
102
102
{ # Contains data of the items purchased.
103
103
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -111,7 +111,7 @@ <h3>Method Details</h3>
111
111
},
112
112
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
114
+
{ # A custom floodlight variable. Can be used in both batchinsert and batchupdate. Adding this in batchupdate will update or append the variable to the existing list.
115
115
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
116
116
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-100]=" in the tags.
117
117
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -133,6 +133,7 @@ <h3>Method Details</h3>
133
133
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
134
134
"ordinal": "A String", # 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.
135
135
"quantity": "A String", # The quantity of the conversion. This is a required field.
136
+
"sessionAttributesEncoded": "A String", # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
136
137
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
137
138
"treatmentForUnderage": True or False, # 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).
138
139
"userIdentifiers": [ # The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.
@@ -177,7 +178,7 @@ <h3>Method Details</h3>
177
178
{ # The original conversion that was inserted or updated and whether there were any errors.
178
179
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
179
180
"adUserDataConsent": "A String", # This represents consent for ad user data.
180
-
"cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. # The cart data associated with this conversion.
181
+
"cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
181
182
"items": [ # Data of the items purchased.
182
183
{ # Contains data of the items purchased.
183
184
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -191,7 +192,7 @@ <h3>Method Details</h3>
191
192
},
192
193
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
195
+
{ # A custom floodlight variable. Can be used in both batchinsert and batchupdate. Adding this in batchupdate will update or append the variable to the existing list.
195
196
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
196
197
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-100]=" in the tags.
197
198
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -213,6 +214,7 @@ <h3>Method Details</h3>
213
214
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
214
215
"ordinal": "A String", # 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.
215
216
"quantity": "A String", # The quantity of the conversion. This is a required field.
217
+
"sessionAttributesEncoded": "A String", # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
216
218
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
217
219
"treatmentForUnderage": True or False, # 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).
218
220
"userIdentifiers": [ # The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.
@@ -258,7 +260,7 @@ <h3>Method Details</h3>
258
260
"conversions": [ # The set of conversions to update.
259
261
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
260
262
"adUserDataConsent": "A String", # This represents consent for ad user data.
261
-
"cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. # The cart data associated with this conversion.
263
+
"cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
262
264
"items": [ # Data of the items purchased.
263
265
{ # Contains data of the items purchased.
264
266
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -272,7 +274,7 @@ <h3>Method Details</h3>
272
274
},
273
275
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
277
+
{ # A custom floodlight variable. Can be used in both batchinsert and batchupdate. Adding this in batchupdate will update or append the variable to the existing list.
276
278
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
277
279
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-100]=" in the tags.
278
280
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -294,6 +296,7 @@ <h3>Method Details</h3>
294
296
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
295
297
"ordinal": "A String", # 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.
296
298
"quantity": "A String", # The quantity of the conversion. This is a required field.
299
+
"sessionAttributesEncoded": "A String", # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
297
300
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
298
301
"treatmentForUnderage": True or False, # 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).
299
302
"userIdentifiers": [ # The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.
@@ -338,7 +341,7 @@ <h3>Method Details</h3>
338
341
{ # The original conversion that was inserted or updated and whether there were any errors.
339
342
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
340
343
"adUserDataConsent": "A String", # This represents consent for ad user data.
341
-
"cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. # The cart data associated with this conversion.
344
+
"cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
342
345
"items": [ # Data of the items purchased.
343
346
{ # Contains data of the items purchased.
344
347
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -352,7 +355,7 @@ <h3>Method Details</h3>
352
355
},
353
356
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
358
+
{ # A custom floodlight variable. Can be used in both batchinsert and batchupdate. Adding this in batchupdate will update or append the variable to the existing list.
356
359
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
357
360
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-100]=" in the tags.
358
361
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -374,6 +377,7 @@ <h3>Method Details</h3>
374
377
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
375
378
"ordinal": "A String", # 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.
376
379
"quantity": "A String", # The quantity of the conversion. This is a required field.
380
+
"sessionAttributesEncoded": "A String", # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
377
381
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
378
382
"treatmentForUnderage": True or False, # 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).
379
383
"userIdentifiers": [ # The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.
"description": "Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate.",
11752
+
"description": " *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788)",
11753
11753
"id": "CartData",
11754
11754
"properties": {
11755
11755
"items": {
@@ -12264,6 +12264,11 @@
12264
12264
"format": "int64",
12265
12265
"type": "string"
12266
12266
},
12267
+
"sessionAttributesEncoded": {
12268
+
"description": "Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.",
12269
+
"format": "byte",
12270
+
"type": "string"
12271
+
},
12267
12272
"timestampMicros": {
12268
12273
"description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
12269
12274
"format": "int64",
@@ -14422,7 +14427,7 @@
14422
14427
"type": "object"
14423
14428
},
14424
14429
"CustomFloodlightVariable": {
14425
-
"description": "A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.",
14430
+
"description": "A custom floodlight variable. Can be used in both batchinsert and batchupdate. Adding this in batchupdate will update or append the variable to the existing list.",
0 commit comments