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