Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / doubleclicksearch_v2.conversion.html
blob: 0d2d3366c6f2178e045b88f6592da5812bb260a8 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]75<h1><a href="doubleclicksearch_v2.html">Search Ads 360 API</a> . <a href="doubleclicksearch_v2.conversion.html">conversion</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None)</a></code></p>
79<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#insert">insert(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#update">update(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Updates a batch of conversions in DoubleClick Search.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#updateAvailability">updateAvailability(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Updates the availabilities of a batch of floodlight activities in DoubleClick Search.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None)</code>
92 <pre>Retrieves a list of conversions from a DoubleClick Search engine account.
93
94Args:
95 agencyId: string, Numeric ID of the agency. (required)
96 advertiserId: string, Numeric ID of the advertiser. (required)
97 engineAccountId: string, Numeric ID of the engine account. (required)
98 endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
99 rowCount: integer, The number of conversions to return per call. (required)
100 startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
101 startRow: integer, The 0-based starting index for retrieving conversions results. (required)
102 adGroupId: string, Numeric ID of the ad group.
103 campaignId: string, Numeric ID of the campaign.
104 adId: string, Numeric ID of the ad.
105 criterionId: string, Numeric ID of the criterion.
106
107Returns:
108 An object of the form:
109
110 { # A list of conversions.
111 "conversion": [ # The conversions being requested.
112 { # A conversion containing data relevant to DoubleClick Search.
113 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
114 { # A message containing the custome dimension.
115 "name": "A String", # Custom dimension name.
116 "value": "A String", # Custom dimension value.
117 },
118 ],
119 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]120 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]121 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122 "campaignId": "A String", # DS campaign ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]123 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124 "advertiserId": "A String", # DS advertiser ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]125 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
127 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]128 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]130 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]131 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]132 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133 "adId": "A String", # DS ad ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]134 "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.
135 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]137 "channel": "A String", # Sales channel for the product. Acceptable values are:
138 # - "local": a physical store
139 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]140 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
142 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]143 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 "quantityMillis": "A String", # The quantity of this conversion, in millis.
145 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]146 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]147 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
148 "customMetric": [ # Custom metrics for the conversion.
149 { # A message containing the custome metric.
150 "name": "A String", # Custom metric name.
151 "value": 3.14, # Custom metric numeric value.
152 },
153 ],
154 "engineAccountId": "A String", # DS engine account ID.
155 "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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]156 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]157 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
158 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159 },
160 ],
161 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
162 }</pre>
163</div>
164
165<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]166 <code class="details" id="insert">insert(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 <pre>Inserts a batch of new conversions into DoubleClick Search.
168
169Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]170 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 The object takes the form of:
172
173{ # A list of conversions.
174 "conversion": [ # The conversions being requested.
175 { # A conversion containing data relevant to DoubleClick Search.
176 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
177 { # A message containing the custome dimension.
178 "name": "A String", # Custom dimension name.
179 "value": "A String", # Custom dimension value.
180 },
181 ],
182 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]183 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]184 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185 "campaignId": "A String", # DS campaign ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]186 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 "advertiserId": "A String", # DS advertiser ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]188 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]189 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
190 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]191 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]193 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]194 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]195 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196 "adId": "A String", # DS ad ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]197 "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.
198 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]200 "channel": "A String", # Sales channel for the product. Acceptable values are:
201 # - "local": a physical store
202 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]203 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]204 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
205 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]206 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 "quantityMillis": "A String", # The quantity of this conversion, in millis.
208 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]209 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]210 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
211 "customMetric": [ # Custom metrics for the conversion.
212 { # A message containing the custome metric.
213 "name": "A String", # Custom metric name.
214 "value": 3.14, # Custom metric numeric value.
215 },
216 ],
217 "engineAccountId": "A String", # DS engine account ID.
218 "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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]219 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]220 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
221 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 },
223 ],
224 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
225 }
226
227
228Returns:
229 An object of the form:
230
231 { # A list of conversions.
232 "conversion": [ # The conversions being requested.
233 { # A conversion containing data relevant to DoubleClick Search.
234 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
235 { # A message containing the custome dimension.
236 "name": "A String", # Custom dimension name.
237 "value": "A String", # Custom dimension value.
238 },
239 ],
240 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]241 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]242 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]243 "campaignId": "A String", # DS campaign ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]244 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]245 "advertiserId": "A String", # DS advertiser ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]246 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]247 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
248 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]249 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]252 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]253 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]254 "adId": "A String", # DS ad ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]255 "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.
256 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]257 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]258 "channel": "A String", # Sales channel for the product. Acceptable values are:
259 # - "local": a physical store
260 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]261 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
263 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]264 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]265 "quantityMillis": "A String", # The quantity of this conversion, in millis.
266 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]267 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
269 "customMetric": [ # Custom metrics for the conversion.
270 { # A message containing the custome metric.
271 "name": "A String", # Custom metric name.
272 "value": 3.14, # Custom metric numeric value.
273 },
274 ],
275 "engineAccountId": "A String", # DS engine account ID.
276 "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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]277 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]278 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
279 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 },
281 ],
282 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
283 }</pre>
284</div>
285
286<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]287 <code class="details" id="update">update(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]288 <pre>Updates a batch of conversions in DoubleClick Search.
289
290Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]292 The object takes the form of:
293
294{ # A list of conversions.
295 "conversion": [ # The conversions being requested.
296 { # A conversion containing data relevant to DoubleClick Search.
297 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
298 { # A message containing the custome dimension.
299 "name": "A String", # Custom dimension name.
300 "value": "A String", # Custom dimension value.
301 },
302 ],
303 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]304 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]305 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]306 "campaignId": "A String", # DS campaign ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]307 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]308 "advertiserId": "A String", # DS advertiser ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]309 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]310 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
311 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]312 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]313 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]314 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]315 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]316 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 "adId": "A String", # DS ad ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]318 "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.
319 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]320 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]321 "channel": "A String", # Sales channel for the product. Acceptable values are:
322 # - "local": a physical store
323 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]324 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]325 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
326 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]327 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328 "quantityMillis": "A String", # The quantity of this conversion, in millis.
329 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]330 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]331 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
332 "customMetric": [ # Custom metrics for the conversion.
333 { # A message containing the custome metric.
334 "name": "A String", # Custom metric name.
335 "value": 3.14, # Custom metric numeric value.
336 },
337 ],
338 "engineAccountId": "A String", # DS engine account ID.
339 "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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]340 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]341 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
342 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]343 },
344 ],
345 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
346 }
347
348
349Returns:
350 An object of the form:
351
352 { # A list of conversions.
353 "conversion": [ # The conversions being requested.
354 { # A conversion containing data relevant to DoubleClick Search.
355 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
356 { # A message containing the custome dimension.
357 "name": "A String", # Custom dimension name.
358 "value": "A String", # Custom dimension value.
359 },
360 ],
361 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]362 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]363 "attributionModel": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]364 "campaignId": "A String", # DS campaign ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]365 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]366 "advertiserId": "A String", # DS advertiser ID.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]367 "countMillis": "A String", # Available to advertisers only after contacting DoubleClick Search customer support.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]368 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
369 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]370 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]371 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]372 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]373 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]374 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]375 "adId": "A String", # DS ad ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]376 "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.
377 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]378 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]379 "channel": "A String", # Sales channel for the product. Acceptable values are:
380 # - "local": a physical store
381 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]382 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]383 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
384 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]385 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]386 "quantityMillis": "A String", # The quantity of this conversion, in millis.
387 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]388 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]389 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
390 "customMetric": [ # Custom metrics for the conversion.
391 { # A message containing the custome metric.
392 "name": "A String", # Custom metric name.
393 "value": 3.14, # Custom metric numeric value.
394 },
395 ],
396 "engineAccountId": "A String", # DS engine account ID.
397 "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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]398 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]399 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
400 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]401 },
402 ],
403 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
404 }</pre>
405</div>
406
407<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]408 <code class="details" id="updateAvailability">updateAvailability(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]409 <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
410
411Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]413 The object takes the form of:
414
415{ # The request to update availability.
416 "availabilities": [ # The availabilities being requested.
417 { # A message containing availability data relevant to DoubleClick Search.
418 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
419 "agencyId": "A String", # DS agency ID.
420 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
421 "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
422 "advertiserId": "A String", # DS advertiser ID.
423 "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).
424 },
425 ],
426 }
427
428
429Returns:
430 An object of the form:
431
432 { # The response to a update availability request.
433 "availabilities": [ # The availabilities being returned.
434 { # A message containing availability data relevant to DoubleClick Search.
435 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
436 "agencyId": "A String", # DS agency ID.
437 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
438 "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
439 "advertiserId": "A String", # DS advertiser ID.
440 "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).
441 },
442 ],
443 }</pre>
444</div>
445
446</body></html>