blob: cb6ffcfe14ab1db79937248ed539e62abc28b27c [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 Kimd059ad82020-07-22 17:02:09 -070078 <code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adId=None, criterionId=None, adGroupId=None, campaignId=None, x__xgafv=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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#insert">insert(body=None, x__xgafv=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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <code><a href="#update">update(body=None, x__xgafv=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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#updateAvailability">updateAvailability(body=None, x__xgafv=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 Kimd059ad82020-07-22 17:02:09 -070091 <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adId=None, criterionId=None, adGroupId=None, campaignId=None, x__xgafv=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)
John Asmuth614db982014-04-24 15:46:26 -0400102 adId: string, Numeric ID of the ad.
103 criterionId: string, Numeric ID of the criterion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700104 adGroupId: string, Numeric ID of the ad group.
105 campaignId: string, Numeric ID of the campaign.
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400110
111Returns:
112 An object of the form:
113
114 { # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700115 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
116 &quot;conversion&quot;: [ # The conversions being requested.
117 { # A conversion containing data relevant to DoubleClick Search.
118 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
119 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
120 &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.
121 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
122 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
123 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
124 { # A message containing the custom metric.
125 &quot;value&quot;: 3.14, # Custom metric numeric value.
126 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
127 },
128 ],
129 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
130 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
131 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
132 &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.
133 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
134 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
135 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
136 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
137 &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.
138 &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.
139 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
140 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are: - &quot;`local`&quot;: a physical store - &quot;`online`&quot;: an online store
141 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
142 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
143 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
144 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
145 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
146 { # A message containing the custom dimension.
147 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
148 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
149 },
150 ],
151 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
152 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
153 &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;.
154 &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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser&#x27;s Floodlight instructions.
155 &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`).
156 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
157 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
158 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
159 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
160 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
161 },
162 ],
163 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400164</div>
165
166<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700167 <code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400168 <pre>Inserts a batch of new conversions into DoubleClick Search.
169
170Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700171 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400172 The object takes the form of:
173
174{ # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700175 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
176 &quot;conversion&quot;: [ # The conversions being requested.
177 { # A conversion containing data relevant to DoubleClick Search.
178 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
179 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
180 &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.
181 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
182 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
183 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
184 { # A message containing the custom metric.
185 &quot;value&quot;: 3.14, # Custom metric numeric value.
186 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
187 },
188 ],
189 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
190 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
191 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
192 &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.
193 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
194 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
195 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
196 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
197 &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.
198 &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.
199 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
200 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are: - &quot;`local`&quot;: a physical store - &quot;`online`&quot;: an online store
201 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
202 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
203 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
204 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
205 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
206 { # A message containing the custom dimension.
207 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
208 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
209 },
210 ],
211 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
212 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
213 &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;.
214 &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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser&#x27;s Floodlight instructions.
215 &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`).
216 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
217 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
218 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
219 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
220 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
221 },
222 ],
223 }
John Asmuth614db982014-04-24 15:46:26 -0400224
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700225 x__xgafv: string, V1 error format.
226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400229
230Returns:
231 An object of the form:
232
233 { # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700234 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
235 &quot;conversion&quot;: [ # The conversions being requested.
236 { # A conversion containing data relevant to DoubleClick Search.
237 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
238 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
239 &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.
240 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
241 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
242 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
243 { # A message containing the custom metric.
244 &quot;value&quot;: 3.14, # Custom metric numeric value.
245 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
246 },
247 ],
248 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
249 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
250 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
251 &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.
252 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
253 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
254 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
255 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
256 &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.
257 &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.
258 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
259 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are: - &quot;`local`&quot;: a physical store - &quot;`online`&quot;: an online store
260 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
261 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
262 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
263 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
264 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
265 { # A message containing the custom dimension.
266 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
267 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
268 },
269 ],
270 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
271 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
272 &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;.
273 &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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser&#x27;s Floodlight instructions.
274 &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`).
275 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
276 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
277 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
278 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
279 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
280 },
281 ],
282 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400283</div>
284
285<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700286 <code class="details" id="update">update(body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400287 <pre>Updates a batch of conversions in DoubleClick Search.
288
289Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700290 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400291 The object takes the form of:
292
293{ # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700294 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
295 &quot;conversion&quot;: [ # The conversions being requested.
296 { # A conversion containing data relevant to DoubleClick Search.
297 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
298 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
299 &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.
300 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
301 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
302 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
303 { # A message containing the custom metric.
304 &quot;value&quot;: 3.14, # Custom metric numeric value.
305 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
306 },
307 ],
308 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
309 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
310 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
311 &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.
312 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
313 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
314 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
315 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
316 &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.
317 &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.
318 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
319 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are: - &quot;`local`&quot;: a physical store - &quot;`online`&quot;: an online store
320 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
321 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
322 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
323 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
324 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
325 { # A message containing the custom dimension.
326 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
327 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
328 },
329 ],
330 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
331 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
332 &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;.
333 &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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser&#x27;s Floodlight instructions.
334 &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`).
335 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
336 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
337 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
338 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
339 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
340 },
341 ],
342 }
John Asmuth614db982014-04-24 15:46:26 -0400343
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700344 x__xgafv: string, V1 error format.
345 Allowed values
346 1 - v1 error format
347 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400348
349Returns:
350 An object of the form:
351
352 { # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700353 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
354 &quot;conversion&quot;: [ # The conversions being requested.
355 { # A conversion containing data relevant to DoubleClick Search.
356 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
357 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
358 &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.
359 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
360 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
361 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
362 { # A message containing the custom metric.
363 &quot;value&quot;: 3.14, # Custom metric numeric value.
364 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
365 },
366 ],
367 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
368 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
369 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
370 &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.
371 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
372 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
373 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
374 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
375 &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.
376 &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.
377 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
378 &quot;channel&quot;: &quot;A String&quot;, # Sales channel for the product. Acceptable values are: - &quot;`local`&quot;: a physical store - &quot;`online`&quot;: an online store
379 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
380 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
381 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
382 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
383 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
384 { # A message containing the custom dimension.
385 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
386 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
387 },
388 ],
389 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
390 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
391 &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;.
392 &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. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser&#x27;s Floodlight instructions.
393 &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`).
394 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
395 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
396 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
397 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
398 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
399 },
400 ],
401 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400402</div>
403
404<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700405 <code class="details" id="updateAvailability">updateAvailability(body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400406 <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
407
408Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700409 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400410 The object takes the form of:
411
412{ # The request to update availability.
Bu Sun Kim65020912020-05-20 12:08:20 -0700413 &quot;availabilities&quot;: [ # The availabilities being requested.
John Asmuth614db982014-04-24 15:46:26 -0400414 { # A message containing availability data relevant to DoubleClick Search.
Bu Sun Kim65020912020-05-20 12:08:20 -0700415 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700416 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
Bu Sun Kim65020912020-05-20 12:08:20 -0700417 &quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
Bu Sun Kim65020912020-05-20 12:08:20 -0700418 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700419 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
420 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
John Asmuth614db982014-04-24 15:46:26 -0400421 },
422 ],
423 }
424
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700425 x__xgafv: string, V1 error format.
426 Allowed values
427 1 - v1 error format
428 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400429
430Returns:
431 An object of the form:
432
433 { # The response to a update availability request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700434 &quot;availabilities&quot;: [ # The availabilities being returned.
John Asmuth614db982014-04-24 15:46:26 -0400435 { # A message containing availability data relevant to DoubleClick Search.
Bu Sun Kim65020912020-05-20 12:08:20 -0700436 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700437 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
Bu Sun Kim65020912020-05-20 12:08:20 -0700438 &quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
Bu Sun Kim65020912020-05-20 12:08:20 -0700439 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700440 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
441 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
John Asmuth614db982014-04-24 15:46:26 -0400442 },
443 ],
444 }</pre>
445</div>
446
447</body></html>