blob: adc22cc71efb56d860bc6fbefeb56eb39773e679 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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 -070075<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 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070078 <code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040079<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 -070081 <code><a href="#insert">insert(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<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 -070084 <code><a href="#update">update(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<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 -070087 <code><a href="#updateAvailability">updateAvailability(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040088<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">
Bu Sun Kim65020912020-05-20 12:08:20 -070091 <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, adId=None, campaignId=None, criterionId=None)</code>
John Asmuth614db982014-04-24 15:46:26 -040092 <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.
John Asmuth614db982014-04-24 15:46:26 -0400103 adId: string, Numeric ID of the ad.
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 campaignId: string, Numeric ID of the campaign.
John Asmuth614db982014-04-24 15:46:26 -0400105 criterionId: string, Numeric ID of the criterion.
106
107Returns:
108 An object of the form:
109
110 { # A list of conversions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;conversion&quot;: [ # The conversions being requested.
112 { # A conversion containing data relevant to DoubleClick Search.
113 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
114 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
115 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
116 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
117 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
118 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
119 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are:
120 # - &quot;local&quot;: a physical store
121 # - &quot;online&quot;: an online store
122 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
123 &quot;conversionId&quot;: &quot;A String&quot;, # 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.
124 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser&#x27;s Floodlight instructions.
125 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
126 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
127 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
128 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
129 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency code for the conversion&#x27;s revenue. Should be in ISO 4217 alphabetic (3-char) format.
130 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
131 { # A message containing the custome dimension.
132 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
133 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
134 },
135 ],
136 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
137 { # A message containing the custome metric.
138 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
139 &quot;value&quot;: 3.14, # Custom metric numeric value.
140 },
141 ],
142 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
143 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
144 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
145 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
146 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
147 &quot;productCountry&quot;: &quot;A String&quot;, # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
148 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
149 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
150 &quot;productLanguage&quot;: &quot;A String&quot;, # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
151 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
152 &quot;revenueMicros&quot;: &quot;A String&quot;, # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of &quot;10&quot; enter &quot;10000000&quot; (10 million) in your request.
153 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
154 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
155 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, FLOODLIGHT).
156 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
157 &quot;storeId&quot;: &quot;A String&quot;, # The ID of the local store for which the product was advertised. Applicable only when the channel is &quot;local&quot;.
158 &quot;type&quot;: &quot;A String&quot;, # 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).
159 },
160 ],
161 &quot;kind&quot;: &quot;doubleclicksearch#conversionList&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
162 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400163</div>
164
165<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700166 <code class="details" id="insert">insert(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400167 <pre>Inserts a batch of new conversions into DoubleClick Search.
168
169Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700170 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400171 The object takes the form of:
172
173{ # A list of conversions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700174 &quot;conversion&quot;: [ # The conversions being requested.
175 { # A conversion containing data relevant to DoubleClick Search.
176 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
177 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
178 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
179 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
180 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
181 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
182 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are:
183 # - &quot;local&quot;: a physical store
184 # - &quot;online&quot;: an online store
185 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
186 &quot;conversionId&quot;: &quot;A String&quot;, # 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.
187 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser&#x27;s Floodlight instructions.
188 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
189 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
190 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
191 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
192 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency code for the conversion&#x27;s revenue. Should be in ISO 4217 alphabetic (3-char) format.
193 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
194 { # A message containing the custome dimension.
195 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
196 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
197 },
198 ],
199 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
200 { # A message containing the custome metric.
201 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
202 &quot;value&quot;: 3.14, # Custom metric numeric value.
203 },
204 ],
205 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
206 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
207 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
208 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
209 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
210 &quot;productCountry&quot;: &quot;A String&quot;, # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
211 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
212 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
213 &quot;productLanguage&quot;: &quot;A String&quot;, # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
214 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
215 &quot;revenueMicros&quot;: &quot;A String&quot;, # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of &quot;10&quot; enter &quot;10000000&quot; (10 million) in your request.
216 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
217 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
218 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, FLOODLIGHT).
219 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
220 &quot;storeId&quot;: &quot;A String&quot;, # The ID of the local store for which the product was advertised. Applicable only when the channel is &quot;local&quot;.
221 &quot;type&quot;: &quot;A String&quot;, # 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).
222 },
223 ],
224 &quot;kind&quot;: &quot;doubleclicksearch#conversionList&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
225}
John Asmuth614db982014-04-24 15:46:26 -0400226
227
228Returns:
229 An object of the form:
230
231 { # A list of conversions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700232 &quot;conversion&quot;: [ # The conversions being requested.
233 { # A conversion containing data relevant to DoubleClick Search.
234 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
235 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
236 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
237 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
238 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
239 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
240 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are:
241 # - &quot;local&quot;: a physical store
242 # - &quot;online&quot;: an online store
243 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
244 &quot;conversionId&quot;: &quot;A String&quot;, # 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.
245 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser&#x27;s Floodlight instructions.
246 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
247 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
248 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
249 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
250 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency code for the conversion&#x27;s revenue. Should be in ISO 4217 alphabetic (3-char) format.
251 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
252 { # A message containing the custome dimension.
253 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
254 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
255 },
256 ],
257 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
258 { # A message containing the custome metric.
259 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
260 &quot;value&quot;: 3.14, # Custom metric numeric value.
261 },
262 ],
263 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
264 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
265 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
266 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
267 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
268 &quot;productCountry&quot;: &quot;A String&quot;, # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
269 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
270 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
271 &quot;productLanguage&quot;: &quot;A String&quot;, # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
272 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
273 &quot;revenueMicros&quot;: &quot;A String&quot;, # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of &quot;10&quot; enter &quot;10000000&quot; (10 million) in your request.
274 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
275 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
276 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, FLOODLIGHT).
277 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
278 &quot;storeId&quot;: &quot;A String&quot;, # The ID of the local store for which the product was advertised. Applicable only when the channel is &quot;local&quot;.
279 &quot;type&quot;: &quot;A String&quot;, # 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).
280 },
281 ],
282 &quot;kind&quot;: &quot;doubleclicksearch#conversionList&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
283 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400284</div>
285
286<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700287 <code class="details" id="update">update(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400288 <pre>Updates a batch of conversions in DoubleClick Search.
289
290Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700291 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400292 The object takes the form of:
293
294{ # A list of conversions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 &quot;conversion&quot;: [ # The conversions being requested.
296 { # A conversion containing data relevant to DoubleClick Search.
297 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
298 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
299 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
300 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
301 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
302 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
303 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are:
304 # - &quot;local&quot;: a physical store
305 # - &quot;online&quot;: an online store
306 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
307 &quot;conversionId&quot;: &quot;A String&quot;, # 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.
308 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser&#x27;s Floodlight instructions.
309 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
310 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
311 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
312 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
313 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency code for the conversion&#x27;s revenue. Should be in ISO 4217 alphabetic (3-char) format.
314 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
315 { # A message containing the custome dimension.
316 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
317 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
318 },
319 ],
320 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
321 { # A message containing the custome metric.
322 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
323 &quot;value&quot;: 3.14, # Custom metric numeric value.
324 },
325 ],
326 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
327 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
328 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
329 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
330 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
331 &quot;productCountry&quot;: &quot;A String&quot;, # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
332 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
333 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
334 &quot;productLanguage&quot;: &quot;A String&quot;, # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
335 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
336 &quot;revenueMicros&quot;: &quot;A String&quot;, # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of &quot;10&quot; enter &quot;10000000&quot; (10 million) in your request.
337 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
338 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
339 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, FLOODLIGHT).
340 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
341 &quot;storeId&quot;: &quot;A String&quot;, # The ID of the local store for which the product was advertised. Applicable only when the channel is &quot;local&quot;.
342 &quot;type&quot;: &quot;A String&quot;, # 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).
343 },
344 ],
345 &quot;kind&quot;: &quot;doubleclicksearch#conversionList&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
346}
John Asmuth614db982014-04-24 15:46:26 -0400347
348
349Returns:
350 An object of the form:
351
352 { # A list of conversions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700353 &quot;conversion&quot;: [ # The conversions being requested.
354 { # A conversion containing data relevant to DoubleClick Search.
355 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
356 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
357 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
358 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
359 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
360 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
361 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are:
362 # - &quot;local&quot;: a physical store
363 # - &quot;online&quot;: an online store
364 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
365 &quot;conversionId&quot;: &quot;A String&quot;, # 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.
366 # For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser&#x27;s Floodlight instructions.
367 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
368 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
369 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
370 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
371 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency code for the conversion&#x27;s revenue. Should be in ISO 4217 alphabetic (3-char) format.
372 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
373 { # A message containing the custome dimension.
374 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
375 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
376 },
377 ],
378 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
379 { # A message containing the custome metric.
380 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
381 &quot;value&quot;: 3.14, # Custom metric numeric value.
382 },
383 ],
384 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
385 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
386 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
387 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
388 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
389 &quot;productCountry&quot;: &quot;A String&quot;, # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
390 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
391 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
392 &quot;productLanguage&quot;: &quot;A String&quot;, # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
393 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
394 &quot;revenueMicros&quot;: &quot;A String&quot;, # The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of &quot;10&quot; enter &quot;10000000&quot; (10 million) in your request.
395 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
396 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
397 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, FLOODLIGHT).
398 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
399 &quot;storeId&quot;: &quot;A String&quot;, # The ID of the local store for which the product was advertised. Applicable only when the channel is &quot;local&quot;.
400 &quot;type&quot;: &quot;A String&quot;, # 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).
401 },
402 ],
403 &quot;kind&quot;: &quot;doubleclicksearch#conversionList&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
404 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400405</div>
406
407<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700408 <code class="details" id="updateAvailability">updateAvailability(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400409 <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
410
411Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700412 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400413 The object takes the form of:
414
415{ # The request to update availability.
Bu Sun Kim65020912020-05-20 12:08:20 -0700416 &quot;availabilities&quot;: [ # The availabilities being requested.
John Asmuth614db982014-04-24 15:46:26 -0400417 { # A message containing availability data relevant to DoubleClick Search.
Bu Sun Kim65020912020-05-20 12:08:20 -0700418 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
419 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
420 &quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
421 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
422 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
423 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is FLOODLIGHT).
John Asmuth614db982014-04-24 15:46:26 -0400424 },
425 ],
426 }
427
428
429Returns:
430 An object of the form:
431
432 { # The response to a update availability request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700433 &quot;availabilities&quot;: [ # The availabilities being returned.
John Asmuth614db982014-04-24 15:46:26 -0400434 { # A message containing availability data relevant to DoubleClick Search.
Bu Sun Kim65020912020-05-20 12:08:20 -0700435 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
436 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
437 &quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
438 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
439 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
440 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is FLOODLIGHT).
John Asmuth614db982014-04-24 15:46:26 -0400441 },
442 ],
443 }</pre>
444</div>
445
446</body></html>