Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / doubleclicksearch_v2.conversion.html
blob: 599990bd870fe83de4101209f00fbedd4157d5cd [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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]81 <code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, criterionId=None, adId=None, campaignId=None, adGroupId=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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]99 <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, criterionId=None, adId=None, campaignId=None, adGroupId=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)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110 criterionId: string, Numeric ID of the criterion.
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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]113 adGroupId: string, Numeric ID of the ad group.
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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]123 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]124 &quot;conversion&quot;: [ # The conversions being requested.
125 { # A conversion containing data relevant to DoubleClick Search.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]126 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]127 &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.
128 &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.
129 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
130 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
131 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
132 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]133 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
134 { # A message containing the custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]135 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]136 &quot;value&quot;: 3.14, # Custom metric numeric value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]137 },
138 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]139 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
140 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
141 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
142 &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.
143 &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;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]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 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]150 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
151 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
152 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]153 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]154 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]155 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156 &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`).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]157 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
158 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
159 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
160 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
161 &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
162 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
163 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
164 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
165 &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.
166 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
167 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
168 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]169 },
170 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]183 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]184 &quot;conversion&quot;: [ # The conversions being requested.
185 { # A conversion containing data relevant to DoubleClick Search.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]186 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]187 &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.
188 &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.
189 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
190 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
191 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
192 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]193 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
194 { # A message containing the custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]195 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]196 &quot;value&quot;: 3.14, # Custom metric numeric value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]197 },
198 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]199 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
200 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
201 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
202 &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.
203 &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;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]204 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
205 { # A message containing the custom dimension.
206 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
207 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
208 },
209 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]210 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
211 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
212 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]213 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]214 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]215 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]216 &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`).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]217 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
218 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
219 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
220 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
221 &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
222 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
223 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
224 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
225 &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.
226 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
227 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
228 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]229 },
230 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]242 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]243 &quot;conversion&quot;: [ # The conversions being requested.
244 { # A conversion containing data relevant to DoubleClick Search.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]245 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]246 &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.
247 &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.
248 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
249 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
250 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
251 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]252 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
253 { # A message containing the custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]254 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]255 &quot;value&quot;: 3.14, # Custom metric numeric value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]256 },
257 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]258 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
259 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
260 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
261 &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.
262 &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;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]263 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
264 { # A message containing the custom dimension.
265 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
266 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
267 },
268 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]269 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
270 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
271 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]272 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]273 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]274 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]275 &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`).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]276 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
277 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
278 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
279 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
280 &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
281 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
282 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
283 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
284 &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.
285 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
286 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
287 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]288 },
289 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]302 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]303 &quot;conversion&quot;: [ # The conversions being requested.
304 { # A conversion containing data relevant to DoubleClick Search.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]305 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]306 &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.
307 &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.
308 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
309 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
310 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
311 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]312 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
313 { # A message containing the custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]314 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]315 &quot;value&quot;: 3.14, # Custom metric numeric value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]316 },
317 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]318 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
319 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
320 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
321 &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.
322 &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;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]323 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
324 { # A message containing the custom dimension.
325 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
326 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
327 },
328 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]329 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
330 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
331 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]332 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]333 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]334 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]335 &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`).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]336 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
337 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
338 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
339 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
340 &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
341 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
342 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
343 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
344 &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.
345 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
346 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
347 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]348 },
349 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]361 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]362 &quot;conversion&quot;: [ # The conversions being requested.
363 { # A conversion containing data relevant to DoubleClick Search.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]364 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]365 &quot;conversionId&quot;: &quot;A String&quot;, # For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the `dsConversionId` or `floodlightOrderId` into this property depending on the advertiser&#x27;s Floodlight instructions.
366 &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.
367 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
368 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
369 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
370 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]371 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
372 { # A message containing the custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]373 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]374 &quot;value&quot;: 3.14, # Custom metric numeric value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]375 },
376 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]377 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
378 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
379 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
380 &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.
381 &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;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]382 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
383 { # A message containing the custom dimension.
384 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
385 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
386 },
387 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]388 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
389 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
390 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]391 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]392 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]393 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]394 &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`).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]395 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
396 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
397 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
398 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
399 &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
400 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
401 &quot;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
402 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
403 &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.
404 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
405 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
406 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]407 },
408 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]421 &quot;availabilities&quot;: [ # The availabilities being requested.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]422 { # A message containing availability data relevant to DoubleClick Search.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]423 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]426 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]427 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]428 &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 -0400[diff] [blame]429 },
430 ],
431 }
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]442 &quot;availabilities&quot;: [ # The availabilities being returned.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]443 { # A message containing availability data relevant to DoubleClick Search.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]444 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]447 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]448 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]449 &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 -0400[diff] [blame]450 },
451 ],
452 }</pre>
453</div>
454
455</body></html>