1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="doubleclicksearch_v2.html">Search Ads 360 API</a> . <a href="doubleclicksearch_v2.conversion.html">conversion</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, customerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
<p class="toc_element">
<code><a href="#getByCustomerId">getByCustomerId(customerId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, advertiserId=None, agencyId=None, campaignId=None, criterionId=None, engineAccountId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p>
<p class="toc_element">
<code><a href="#update">update(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a batch of conversions in DoubleClick Search.</p>
<p class="toc_element">
<code><a href="#updateAvailability">updateAvailability(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the availabilities of a batch of floodlight activities in DoubleClick Search.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None, customerId=None, x__xgafv=None)</code>
<pre>Retrieves a list of conversions from a DoubleClick Search engine account.
Args:
agencyId: string, Numeric ID of the agency. (required)
advertiserId: string, Numeric ID of the advertiser. (required)
engineAccountId: string, Numeric ID of the engine account. (required)
endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
rowCount: integer, The number of conversions to return per call. (required)
startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
startRow: integer, The 0-based starting index for retrieving conversions results. (required)
adGroupId: string, Numeric ID of the ad group.
adId: string, Numeric ID of the ad.
campaignId: string, Numeric ID of the campaign.
criterionId: string, Numeric ID of the criterion.
customerId: string, Customer ID of a client account in the new Search Ads 360 experience.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of conversions.
"conversion": [ # The conversions being requested.
{ # A conversion containing data relevant to DoubleClick Search. Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"adUserDataConsent": "A String", # Represents consent for core platform services (CPS) preferences in settings. No default value. Acceptable values are: GRANTED: The desired consent status is to grant. Read the CPS preferences from GTE settings. DENIED: The desired consent status is to deny; CPS list is empty.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"campaignId": "A String", # DS campaign ID.
"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
"clickId": "A String", # DS click ID for the conversion.
"conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"criterionId": "A String", # DS criterion (keyword) ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
{ # A message containing the custom dimension.
"name": "A String", # Custom dimension name.
"value": "A String", # Custom dimension value.
},
],
"customMetric": [ # Custom metrics for the conversion.
{ # A message containing the custom metric.
"name": "A String", # Custom metric name.
"value": 3.14, # Custom metric numeric value.
},
],
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"deviceType": "A String", # The type of device on which the conversion occurred.
"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
"engineAccountId": "A String", # DS engine account ID.
"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
"productGroupId": "A String", # DS product group ID.
"productId": "A String", # The product ID (SKU).
"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"revenueMicros": "A String", # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`).
"state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).
},
],
"kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
}</pre>
</div>
<div class="method">
<code class="details" id="getByCustomerId">getByCustomerId(customerId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, advertiserId=None, agencyId=None, campaignId=None, criterionId=None, engineAccountId=None, x__xgafv=None)</code>
<pre>Retrieves a list of conversions from a DoubleClick Search engine account.
Args:
customerId: string, Customer ID of a client account in the new Search Ads 360 experience. (required)
endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
rowCount: integer, The number of conversions to return per call. (required)
startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
startRow: integer, The 0-based starting index for retrieving conversions results. (required)
adGroupId: string, Numeric ID of the ad group.
adId: string, Numeric ID of the ad.
advertiserId: string, Numeric ID of the advertiser.
agencyId: string, Numeric ID of the agency.
campaignId: string, Numeric ID of the campaign.
criterionId: string, Numeric ID of the criterion.
engineAccountId: string, Numeric ID of the engine account.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of conversions.
"conversion": [ # The conversions being requested.
{ # A conversion containing data relevant to DoubleClick Search. Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"adUserDataConsent": "A String", # Represents consent for core platform services (CPS) preferences in settings. No default value. Acceptable values are: GRANTED: The desired consent status is to grant. Read the CPS preferences from GTE settings. DENIED: The desired consent status is to deny; CPS list is empty.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"campaignId": "A String", # DS campaign ID.
"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
"clickId": "A String", # DS click ID for the conversion.
"conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"criterionId": "A String", # DS criterion (keyword) ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
{ # A message containing the custom dimension.
"name": "A String", # Custom dimension name.
"value": "A String", # Custom dimension value.
},
],
"customMetric": [ # Custom metrics for the conversion.
{ # A message containing the custom metric.
"name": "A String", # Custom metric name.
"value": 3.14, # Custom metric numeric value.
},
],
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"deviceType": "A String", # The type of device on which the conversion occurred.
"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
"engineAccountId": "A String", # DS engine account ID.
"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
"productGroupId": "A String", # DS product group ID.
"productId": "A String", # The product ID (SKU).
"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"revenueMicros": "A String", # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`).
"state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).
},
],
"kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
<pre>Inserts a batch of new conversions into DoubleClick Search.
Args:
body: object, The request body.
The object takes the form of:
{ # A list of conversions.
"conversion": [ # The conversions being requested.
{ # A conversion containing data relevant to DoubleClick Search. Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"adUserDataConsent": "A String", # Represents consent for core platform services (CPS) preferences in settings. No default value. Acceptable values are: GRANTED: The desired consent status is to grant. Read the CPS preferences from GTE settings. DENIED: The desired consent status is to deny; CPS list is empty.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"campaignId": "A String", # DS campaign ID.
"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
"clickId": "A String", # DS click ID for the conversion.
"conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"criterionId": "A String", # DS criterion (keyword) ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
{ # A message containing the custom dimension.
"name": "A String", # Custom dimension name.
"value": "A String", # Custom dimension value.
},
],
"customMetric": [ # Custom metrics for the conversion.
{ # A message containing the custom metric.
"name": "A String", # Custom metric name.
"value": 3.14, # Custom metric numeric value.
},
],
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"deviceType": "A String", # The type of device on which the conversion occurred.
"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
"engineAccountId": "A String", # DS engine account ID.
"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
"productGroupId": "A String", # DS product group ID.
"productId": "A String", # The product ID (SKU).
"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"revenueMicros": "A String", # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`).
"state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).
},
],
"kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of conversions.
"conversion": [ # The conversions being requested.
{ # A conversion containing data relevant to DoubleClick Search. Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"adUserDataConsent": "A String", # Represents consent for core platform services (CPS) preferences in settings. No default value. Acceptable values are: GRANTED: The desired consent status is to grant. Read the CPS preferences from GTE settings. DENIED: The desired consent status is to deny; CPS list is empty.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"campaignId": "A String", # DS campaign ID.
"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
"clickId": "A String", # DS click ID for the conversion.
"conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"criterionId": "A String", # DS criterion (keyword) ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
{ # A message containing the custom dimension.
"name": "A String", # Custom dimension name.
"value": "A String", # Custom dimension value.
},
],
"customMetric": [ # Custom metrics for the conversion.
{ # A message containing the custom metric.
"name": "A String", # Custom metric name.
"value": 3.14, # Custom metric numeric value.
},
],
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"deviceType": "A String", # The type of device on which the conversion occurred.
"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
"engineAccountId": "A String", # DS engine account ID.
"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
"productGroupId": "A String", # DS product group ID.
"productId": "A String", # The product ID (SKU).
"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"revenueMicros": "A String", # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`).
"state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).
},
],
"kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(body=None, x__xgafv=None)</code>
<pre>Updates a batch of conversions in DoubleClick Search.
Args:
body: object, The request body.
The object takes the form of:
{ # A list of conversions.
"conversion": [ # The conversions being requested.
{ # A conversion containing data relevant to DoubleClick Search. Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"adUserDataConsent": "A String", # Represents consent for core platform services (CPS) preferences in settings. No default value. Acceptable values are: GRANTED: The desired consent status is to grant. Read the CPS preferences from GTE settings. DENIED: The desired consent status is to deny; CPS list is empty.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"campaignId": "A String", # DS campaign ID.
"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
"clickId": "A String", # DS click ID for the conversion.
"conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"criterionId": "A String", # DS criterion (keyword) ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
{ # A message containing the custom dimension.
"name": "A String", # Custom dimension name.
"value": "A String", # Custom dimension value.
},
],
"customMetric": [ # Custom metrics for the conversion.
{ # A message containing the custom metric.
"name": "A String", # Custom metric name.
"value": 3.14, # Custom metric numeric value.
},
],
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"deviceType": "A String", # The type of device on which the conversion occurred.
"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
"engineAccountId": "A String", # DS engine account ID.
"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
"productGroupId": "A String", # DS product group ID.
"productId": "A String", # The product ID (SKU).
"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"revenueMicros": "A String", # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`).
"state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).
},
],
"kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of conversions.
"conversion": [ # The conversions being requested.
{ # A conversion containing data relevant to DoubleClick Search. Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33
"adGroupId": "A String", # DS ad group ID.
"adId": "A String", # DS ad ID.
"adUserDataConsent": "A String", # Represents consent for core platform services (CPS) preferences in settings. No default value. Acceptable values are: GRANTED: The desired consent status is to grant. Read the CPS preferences from GTE settings. DENIED: The desired consent status is to deny; CPS list is empty.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"campaignId": "A String", # DS campaign ID.
"channel": "A String", # Sales channel for the product. Acceptable values are: - "`local`": a physical store - "`online`": an online store
"clickId": "A String", # DS click ID for the conversion.
"conversionId": "A String", # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser's Floodlight instructions.
"conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
"conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
"countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
"criterionId": "A String", # DS criterion (keyword) ID.
"currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
"customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
{ # A message containing the custom dimension.
"name": "A String", # Custom dimension name.
"value": "A String", # Custom dimension value.
},
],
"customMetric": [ # Custom metrics for the conversion.
{ # A message containing the custom metric.
"name": "A String", # Custom metric name.
"value": 3.14, # Custom metric numeric value.
},
],
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"deviceType": "A String", # The type of device on which the conversion occurred.
"dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
"engineAccountId": "A String", # DS engine account ID.
"floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
"inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
"productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
"productGroupId": "A String", # DS product group ID.
"productId": "A String", # The product ID (SKU).
"productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
"quantityMillis": "A String", # The quantity of this conversion, in millis.
"revenueMicros": "A String", # The revenue amount of this `TRANSACTION` conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type of this conversion (for example, `FLOODLIGHT`).
"state": "A String", # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
"storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "`local`".
"type": "A String", # The type of the conversion, that is, either `ACTION` or `TRANSACTION`. An `ACTION` conversion is an action by the user that has no monetarily quantifiable value, while a `TRANSACTION` conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (`ACTION`) versus ecommerce purchases (`TRANSACTION`).
},
],
"kind": "A String", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
}</pre>
</div>
<div class="method">
<code class="details" id="updateAvailability">updateAvailability(body=None, x__xgafv=None)</code>
<pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
Args:
body: object, The request body.
The object takes the form of:
{ # The request to update availability.
"availabilities": [ # The availabilities being requested.
{ # A message containing availability data relevant to DoubleClick Search.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a update availability request.
"availabilities": [ # The availabilities being returned.
{ # A message containing availability data relevant to DoubleClick Search.
"advertiserId": "A String", # DS advertiser ID.
"agencyId": "A String", # DS agency ID.
"availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
"customerId": "A String", # Customer ID of a client account in the new Search Ads 360 experience.
"segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
"segmentationType": "A String", # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
},
],
}</pre>
</div>
</body></html>
|
