blob: e22d03b822077e057e41cb74d35b6876659ed127 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Dan O'Mearadd494642020-05-01 07:42:23 -070075<h1><a href="doubleclicksearch_v2.html">Search Ads 360 API</a> . <a href="doubleclicksearch_v2.conversion.html">conversion</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <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, adId=None, adGroupId=None, campaignId=None, criterionId=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<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 -070084 <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<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 -070087 <code><a href="#update">update(body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040088<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 -070090 <code><a href="#updateAvailability">updateAvailability(body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040091<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 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
99 <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adId=None, adGroupId=None, campaignId=None, criterionId=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400100 <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)
John Asmuth614db982014-04-24 15:46:26 -0400110 adId: string, Numeric ID of the ad.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700111 adGroupId: string, Numeric ID of the ad group.
112 campaignId: string, Numeric ID of the campaign.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113 criterionId: string, Numeric ID of the criterion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 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 -0400118
119Returns:
120 An object of the form:
121
122 { # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700123 &quot;conversion&quot;: [ # The conversions being requested.
124 { # A conversion containing data relevant to DoubleClick Search.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700125 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
126 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700127 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700128 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700129 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700131 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
132 { # A message containing the custom metric.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700133 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700134 &quot;value&quot;: 3.14, # Custom metric numeric value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700135 },
136 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700137 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
138 &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.
139 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
140 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700141 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700142 &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.
143 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700144 &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.
145 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700146 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
147 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
148 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700149 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
150 { # A message containing the custom dimension.
151 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
152 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
153 },
154 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700155 &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
156 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700157 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700158 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
159 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
160 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
161 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
162 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
163 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
164 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
165 &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`).
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;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700168 },
169 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700170 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700171 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400172</div>
173
174<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700175 <code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400176 <pre>Inserts a batch of new conversions into DoubleClick Search.
177
178Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700179 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400180 The object takes the form of:
181
182{ # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 &quot;conversion&quot;: [ # The conversions being requested.
184 { # A conversion containing data relevant to DoubleClick Search.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
186 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700187 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700188 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700189 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700190 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700191 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
192 { # A message containing the custom metric.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700193 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700194 &quot;value&quot;: 3.14, # Custom metric numeric value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700195 },
196 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700197 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
198 &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.
199 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
200 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700201 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700202 &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.
203 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700204 &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.
205 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700206 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
207 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
208 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700209 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
210 { # A message containing the custom dimension.
211 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
212 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
213 },
214 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700215 &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;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700217 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700218 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
219 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
220 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
221 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
222 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
223 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
224 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
225 &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`).
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;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700228 },
229 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700230 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700231 }
John Asmuth614db982014-04-24 15:46:26 -0400232
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700233 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 -0400237
238Returns:
239 An object of the form:
240
241 { # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700242 &quot;conversion&quot;: [ # The conversions being requested.
243 { # A conversion containing data relevant to DoubleClick Search.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700244 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
245 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700246 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700247 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700248 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700250 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
251 { # A message containing the custom metric.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700252 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700253 &quot;value&quot;: 3.14, # Custom metric numeric value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700254 },
255 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700256 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
257 &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.
258 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
259 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700260 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700261 &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.
262 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700263 &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.
264 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700265 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
266 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
267 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700268 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
269 { # A message containing the custom dimension.
270 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
271 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
272 },
273 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700274 &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
275 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700276 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700277 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
278 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
279 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
280 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
281 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
282 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
283 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
284 &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`).
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;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700287 },
288 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700289 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700290 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400291</div>
292
293<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700294 <code class="details" id="update">update(body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400295 <pre>Updates a batch of conversions in DoubleClick Search.
296
297Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700298 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400299 The object takes the form of:
300
301{ # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700302 &quot;conversion&quot;: [ # The conversions being requested.
303 { # A conversion containing data relevant to DoubleClick Search.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700304 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
305 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700306 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700307 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700308 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700309 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700310 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
311 { # A message containing the custom metric.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700312 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700313 &quot;value&quot;: 3.14, # Custom metric numeric value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700314 },
315 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700316 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
317 &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.
318 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
319 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700320 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700321 &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.
322 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700323 &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.
324 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700325 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
326 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
327 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700328 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
329 { # A message containing the custom dimension.
330 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
331 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
332 },
333 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700334 &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
335 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700336 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700337 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
338 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
339 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
340 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
341 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
342 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
343 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
344 &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`).
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;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700347 },
348 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700349 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700350 }
John Asmuth614db982014-04-24 15:46:26 -0400351
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700352 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 -0400356
357Returns:
358 An object of the form:
359
360 { # A list of conversions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700361 &quot;conversion&quot;: [ # The conversions being requested.
362 { # A conversion containing data relevant to DoubleClick Search.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700363 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type of this conversion (for example, `FLOODLIGHT`).
364 &quot;productId&quot;: &quot;A String&quot;, # The product ID (SKU).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700365 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700366 &quot;deviceType&quot;: &quot;A String&quot;, # The type of device on which the conversion occurred.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700367 &quot;campaignId&quot;: &quot;A String&quot;, # DS campaign ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700368 &quot;adGroupId&quot;: &quot;A String&quot;, # DS ad group ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700369 &quot;customMetric&quot;: [ # Custom metrics for the conversion.
370 { # A message containing the custom metric.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700371 &quot;name&quot;: &quot;A String&quot;, # Custom metric name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700372 &quot;value&quot;: 3.14, # Custom metric numeric value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700373 },
374 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700375 &quot;dsConversionId&quot;: &quot;A String&quot;, # ID that DoubleClick Search generates for each conversion.
376 &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.
377 &quot;conversionModifiedTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion was last modified, in epoch millis UTC.
378 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700379 &quot;quantityMillis&quot;: &quot;A String&quot;, # The quantity of this conversion, in millis.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700380 &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.
381 &quot;countMillis&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700382 &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.
383 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700384 &quot;clickId&quot;: &quot;A String&quot;, # DS click ID for the conversion.
385 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
386 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700387 &quot;customDimension&quot;: [ # Custom dimensions for the conversion, which can be used to filter data in a report.
388 { # A message containing the custom dimension.
389 &quot;value&quot;: &quot;A String&quot;, # Custom dimension value.
390 &quot;name&quot;: &quot;A String&quot;, # Custom dimension name.
391 },
392 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700393 &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
394 &quot;floodlightOrderId&quot;: &quot;A String&quot;, # The Floodlight order ID provided by the advertiser for the conversion.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700395 &quot;adId&quot;: &quot;A String&quot;, # DS ad ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700396 &quot;productGroupId&quot;: &quot;A String&quot;, # DS product group ID.
397 &quot;attributionModel&quot;: &quot;A String&quot;, # Available to advertisers only after contacting DoubleClick Search customer support.
398 &quot;state&quot;: &quot;A String&quot;, # The state of the conversion, that is, either `ACTIVE` or `REMOVED`. Note: state DELETED is deprecated.
399 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
400 &quot;engineAccountId&quot;: &quot;A String&quot;, # DS engine account ID.
401 &quot;conversionTimestamp&quot;: &quot;A String&quot;, # The time at which the conversion took place, in epoch millis UTC.
402 &quot;criterionId&quot;: &quot;A String&quot;, # DS criterion (keyword) ID.
403 &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`).
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;inventoryAccountId&quot;: &quot;A String&quot;, # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700406 },
407 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700408 &quot;kind&quot;: &quot;A String&quot;, # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700409 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400410</div>
411
412<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700413 <code class="details" id="updateAvailability">updateAvailability(body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400414 <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
415
416Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700417 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400418 The object takes the form of:
419
420{ # The request to update availability.
Bu Sun Kim65020912020-05-20 12:08:20 -0700421 &quot;availabilities&quot;: [ # The availabilities being requested.
John Asmuth614db982014-04-24 15:46:26 -0400422 { # A message containing availability data relevant to DoubleClick Search.
Bu Sun Kim65020912020-05-20 12:08:20 -0700423 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700424 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
425 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700426 &quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
427 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
428 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
John Asmuth614db982014-04-24 15:46:26 -0400429 },
430 ],
431 }
432
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700433 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 -0400437
438Returns:
439 An object of the form:
440
441 { # The response to a update availability request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700442 &quot;availabilities&quot;: [ # The availabilities being returned.
John Asmuth614db982014-04-24 15:46:26 -0400443 { # A message containing availability data relevant to DoubleClick Search.
Bu Sun Kim65020912020-05-20 12:08:20 -0700444 &quot;agencyId&quot;: &quot;A String&quot;, # DS agency ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700445 &quot;advertiserId&quot;: &quot;A String&quot;, # DS advertiser ID.
446 &quot;segmentationId&quot;: &quot;A String&quot;, # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700447 &quot;availabilityTimestamp&quot;: &quot;A String&quot;, # The time by which all conversions have been uploaded, in epoch millis UTC.
448 &quot;segmentationType&quot;: &quot;A String&quot;, # The segmentation type that this availability is for (its default value is `FLOODLIGHT`).
449 &quot;segmentationName&quot;: &quot;A String&quot;, # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
John Asmuth614db982014-04-24 15:46:26 -0400450 },
451 ],
452 }</pre>
453</div>
454
455</body></html>