Skip to content

Commit 71a5f19

Browse files
feat(dfareporting): update the api
#### dfareporting:v4 The following keys were added: - schemas.Conversion.properties.sessionAttributesEncoded (Total Keys: 2)
1 parent 1d5215c commit 71a5f19

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

docs/dyn/dfareporting_v4.conversions.html

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3>Method Details</h3>
9797
&quot;conversions&quot;: [ # The set of conversions to insert.
9898
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
9999
&quot;adUserDataConsent&quot;: &quot;A String&quot;, # This represents consent for ad user data.
100-
&quot;cartData&quot;: { # 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+
&quot;cartData&quot;: { # *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.
101101
&quot;items&quot;: [ # Data of the items purchased.
102102
{ # Contains data of the items purchased.
103103
&quot;itemId&quot;: &quot;A String&quot;, # 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>
111111
},
112112
&quot;childDirectedTreatment&quot;: True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
113113
&quot;customVariables&quot;: [ # Custom floodlight variables.
114-
{ # 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.
115115
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#customFloodlightVariable&quot;.
116116
&quot;type&quot;: &quot;A String&quot;, # The type of custom floodlight variable to supply a value for. These map to the &quot;u[1-100]=&quot; in the tags.
117117
&quot;value&quot;: &quot;A String&quot;, # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -133,6 +133,7 @@ <h3>Method Details</h3>
133133
&quot;nonPersonalizedAd&quot;: True or False, # Whether the conversion was for a non personalized ad.
134134
&quot;ordinal&quot;: &quot;A String&quot;, # 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.
135135
&quot;quantity&quot;: &quot;A String&quot;, # The quantity of the conversion. This is a required field.
136+
&quot;sessionAttributesEncoded&quot;: &quot;A String&quot;, # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
136137
&quot;timestampMicros&quot;: &quot;A String&quot;, # The timestamp of conversion, in Unix epoch micros. This is a required field.
137138
&quot;treatmentForUnderage&quot;: 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&#x27;s General Data Protection Regulation (GDPR).
138139
&quot;userIdentifiers&quot;: [ # 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>
177178
{ # The original conversion that was inserted or updated and whether there were any errors.
178179
&quot;conversion&quot;: { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
179180
&quot;adUserDataConsent&quot;: &quot;A String&quot;, # This represents consent for ad user data.
180-
&quot;cartData&quot;: { # 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+
&quot;cartData&quot;: { # *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.
181182
&quot;items&quot;: [ # Data of the items purchased.
182183
{ # Contains data of the items purchased.
183184
&quot;itemId&quot;: &quot;A String&quot;, # 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>
191192
},
192193
&quot;childDirectedTreatment&quot;: True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
193194
&quot;customVariables&quot;: [ # Custom floodlight variables.
194-
{ # 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.
195196
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#customFloodlightVariable&quot;.
196197
&quot;type&quot;: &quot;A String&quot;, # The type of custom floodlight variable to supply a value for. These map to the &quot;u[1-100]=&quot; in the tags.
197198
&quot;value&quot;: &quot;A String&quot;, # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -213,6 +214,7 @@ <h3>Method Details</h3>
213214
&quot;nonPersonalizedAd&quot;: True or False, # Whether the conversion was for a non personalized ad.
214215
&quot;ordinal&quot;: &quot;A String&quot;, # 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.
215216
&quot;quantity&quot;: &quot;A String&quot;, # The quantity of the conversion. This is a required field.
217+
&quot;sessionAttributesEncoded&quot;: &quot;A String&quot;, # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
216218
&quot;timestampMicros&quot;: &quot;A String&quot;, # The timestamp of conversion, in Unix epoch micros. This is a required field.
217219
&quot;treatmentForUnderage&quot;: 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&#x27;s General Data Protection Regulation (GDPR).
218220
&quot;userIdentifiers&quot;: [ # 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>
258260
&quot;conversions&quot;: [ # The set of conversions to update.
259261
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
260262
&quot;adUserDataConsent&quot;: &quot;A String&quot;, # This represents consent for ad user data.
261-
&quot;cartData&quot;: { # 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+
&quot;cartData&quot;: { # *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.
262264
&quot;items&quot;: [ # Data of the items purchased.
263265
{ # Contains data of the items purchased.
264266
&quot;itemId&quot;: &quot;A String&quot;, # 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>
272274
},
273275
&quot;childDirectedTreatment&quot;: True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
274276
&quot;customVariables&quot;: [ # Custom floodlight variables.
275-
{ # 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.
276278
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#customFloodlightVariable&quot;.
277279
&quot;type&quot;: &quot;A String&quot;, # The type of custom floodlight variable to supply a value for. These map to the &quot;u[1-100]=&quot; in the tags.
278280
&quot;value&quot;: &quot;A String&quot;, # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -294,6 +296,7 @@ <h3>Method Details</h3>
294296
&quot;nonPersonalizedAd&quot;: True or False, # Whether the conversion was for a non personalized ad.
295297
&quot;ordinal&quot;: &quot;A String&quot;, # 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.
296298
&quot;quantity&quot;: &quot;A String&quot;, # The quantity of the conversion. This is a required field.
299+
&quot;sessionAttributesEncoded&quot;: &quot;A String&quot;, # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
297300
&quot;timestampMicros&quot;: &quot;A String&quot;, # The timestamp of conversion, in Unix epoch micros. This is a required field.
298301
&quot;treatmentForUnderage&quot;: 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&#x27;s General Data Protection Regulation (GDPR).
299302
&quot;userIdentifiers&quot;: [ # 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>
338341
{ # The original conversion that was inserted or updated and whether there were any errors.
339342
&quot;conversion&quot;: { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
340343
&quot;adUserDataConsent&quot;: &quot;A String&quot;, # This represents consent for ad user data.
341-
&quot;cartData&quot;: { # 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+
&quot;cartData&quot;: { # *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.
342345
&quot;items&quot;: [ # Data of the items purchased.
343346
{ # Contains data of the items purchased.
344347
&quot;itemId&quot;: &quot;A String&quot;, # 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>
352355
},
353356
&quot;childDirectedTreatment&quot;: True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
354357
&quot;customVariables&quot;: [ # Custom floodlight variables.
355-
{ # 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.
356359
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#customFloodlightVariable&quot;.
357360
&quot;type&quot;: &quot;A String&quot;, # The type of custom floodlight variable to supply a value for. These map to the &quot;u[1-100]=&quot; in the tags.
358361
&quot;value&quot;: &quot;A String&quot;, # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
@@ -374,6 +377,7 @@ <h3>Method Details</h3>
374377
&quot;nonPersonalizedAd&quot;: True or False, # Whether the conversion was for a non personalized ad.
375378
&quot;ordinal&quot;: &quot;A String&quot;, # 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.
376379
&quot;quantity&quot;: &quot;A String&quot;, # The quantity of the conversion. This is a required field.
380+
&quot;sessionAttributesEncoded&quot;: &quot;A String&quot;, # Session attributes for the conversion, encoded as based64 bytes. This field may only be used when calling batchinsert; it is not supported by batchupdate.
377381
&quot;timestampMicros&quot;: &quot;A String&quot;, # The timestamp of conversion, in Unix epoch micros. This is a required field.
378382
&quot;treatmentForUnderage&quot;: 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&#x27;s General Data Protection Regulation (GDPR).
379383
&quot;userIdentifiers&quot;: [ # The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.

googleapiclient/discovery_cache/documents/dfareporting.v4.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10152,7 +10152,7 @@
1015210152
}
1015310153
}
1015410154
},
10155-
"revision": "20250218",
10155+
"revision": "20250602",
1015610156
"rootUrl": "https://dfareporting.googleapis.com/",
1015710157
"schemas": {
1015810158
"Account": {
@@ -11749,7 +11749,7 @@
1174911749
"type": "object"
1175011750
},
1175111751
"CartData": {
11752-
"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)",
1175311753
"id": "CartData",
1175411754
"properties": {
1175511755
"items": {
@@ -12264,6 +12264,11 @@
1226412264
"format": "int64",
1226512265
"type": "string"
1226612266
},
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+
},
1226712272
"timestampMicros": {
1226812273
"description": "The timestamp of conversion, in Unix epoch micros. This is a required field.",
1226912274
"format": "int64",
@@ -14422,7 +14427,7 @@
1442214427
"type": "object"
1442314428
},
1442414429
"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.",
1442614431
"id": "CustomFloodlightVariable",
1442714432
"properties": {
1442814433
"kind": {

0 commit comments

Comments
 (0)