Debian Codegraph @

docs/dyn/doubleclicksearch_v2.conversion.html

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