Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / doubleclicksearch_v2.conversion.html
blob: 79eb06b1adc218b3a7773ee838ab2b82ccedd5ca [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
75<h1><a href="doubleclicksearch_v2.html">DoubleClick Search API</a> . <a href="doubleclicksearch_v2.conversion.html">conversion</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None)</a></code></p>
79<p class="firstline">Retrieves a list of conversions from a DoubleClick Search engine account.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(body)</a></code></p>
82<p class="firstline">Inserts a batch of new conversions into DoubleClick Search.</p>
83<p class="toc_element">
84 <code><a href="#patch">patch(advertiserId, agencyId, endDate, engineAccountId, rowCount, startDate, startRow, body)</a></code></p>
85<p class="firstline">Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.</p>
86<p class="toc_element">
87 <code><a href="#update">update(body)</a></code></p>
88<p class="firstline">Updates a batch of conversions in DoubleClick Search.</p>
89<p class="toc_element">
90 <code><a href="#updateAvailability">updateAvailability(body)</a></code></p>
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">
94 <code class="details" id="get">get(agencyId, advertiserId, engineAccountId, endDate, rowCount, startDate, startRow, adGroupId=None, campaignId=None, adId=None, criterionId=None)</code>
95 <pre>Retrieves a list of conversions from a DoubleClick Search engine account.
96
97Args:
98 agencyId: string, Numeric ID of the agency. (required)
99 advertiserId: string, Numeric ID of the advertiser. (required)
100 engineAccountId: string, Numeric ID of the engine account. (required)
101 endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
102 rowCount: integer, The number of conversions to return per call. (required)
103 startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
104 startRow: integer, The 0-based starting index for retrieving conversions results. (required)
105 adGroupId: string, Numeric ID of the ad group.
106 campaignId: string, Numeric ID of the campaign.
107 adId: string, Numeric ID of the ad.
108 criterionId: string, Numeric ID of the criterion.
109
110Returns:
111 An object of the form:
112
113 { # A list of conversions.
114 "conversion": [ # The conversions being requested.
115 { # A conversion containing data relevant to DoubleClick Search.
116 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
117 { # A message containing the custome dimension.
118 "name": "A String", # Custom dimension name.
119 "value": "A String", # Custom dimension value.
120 },
121 ],
122 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]123 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]124 "attributionModel": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125 "campaignId": "A String", # DS campaign ID.
126 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
127 "advertiserId": "A String", # DS advertiser ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]128 "countMillis": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
130 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]131 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]133 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]134 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]135 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 "adId": "A String", # DS ad ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]137 "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]139 "channel": "A String", # Sales channel for the product. Acceptable values are:
140 # - "local": a physical store
141 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]142 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
144 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]145 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 "quantityMillis": "A String", # The quantity of this conversion, in millis.
147 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]148 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
150 "customMetric": [ # Custom metrics for the conversion.
151 { # A message containing the custome metric.
152 "name": "A String", # Custom metric name.
153 "value": 3.14, # Custom metric numeric value.
154 },
155 ],
156 "engineAccountId": "A String", # DS engine account ID.
157 "type": "A String", # 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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]158 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]159 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
160 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 },
162 ],
163 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="insert">insert(body)</code>
169 <pre>Inserts a batch of new conversions into DoubleClick Search.
170
171Args:
172 body: object, The request body. (required)
173 The object takes the form of:
174
175{ # A list of conversions.
176 "conversion": [ # The conversions being requested.
177 { # A conversion containing data relevant to DoubleClick Search.
178 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
179 { # A message containing the custome dimension.
180 "name": "A String", # Custom dimension name.
181 "value": "A String", # Custom dimension value.
182 },
183 ],
184 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]185 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]186 "attributionModel": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 "campaignId": "A String", # DS campaign ID.
188 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
189 "advertiserId": "A String", # DS advertiser ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]190 "countMillis": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
192 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]193 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]194 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]195 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]196 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]197 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 "adId": "A String", # DS ad ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]199 "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]200 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]201 "channel": "A String", # Sales channel for the product. Acceptable values are:
202 # - "local": a physical store
203 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]204 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]205 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
206 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]207 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 "quantityMillis": "A String", # The quantity of this conversion, in millis.
209 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]210 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
212 "customMetric": [ # Custom metrics for the conversion.
213 { # A message containing the custome metric.
214 "name": "A String", # Custom metric name.
215 "value": 3.14, # Custom metric numeric value.
216 },
217 ],
218 "engineAccountId": "A String", # DS engine account ID.
219 "type": "A String", # 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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]220 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]221 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
222 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 },
224 ],
225 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
226 }
227
228
229Returns:
230 An object of the form:
231
232 { # A list of conversions.
233 "conversion": [ # The conversions being requested.
234 { # A conversion containing data relevant to DoubleClick Search.
235 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
236 { # A message containing the custome dimension.
237 "name": "A String", # Custom dimension name.
238 "value": "A String", # Custom dimension value.
239 },
240 ],
241 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]242 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]243 "attributionModel": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 "campaignId": "A String", # DS campaign ID.
245 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
246 "advertiserId": "A String", # DS advertiser ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]247 "countMillis": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]248 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
249 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]250 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]251 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]252 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]253 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]254 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]255 "adId": "A String", # DS ad ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]256 "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]257 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]258 "channel": "A String", # Sales channel for the product. Acceptable values are:
259 # - "local": a physical store
260 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]261 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
263 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]264 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]265 "quantityMillis": "A String", # The quantity of this conversion, in millis.
266 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]267 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
269 "customMetric": [ # Custom metrics for the conversion.
270 { # A message containing the custome metric.
271 "name": "A String", # Custom metric name.
272 "value": 3.14, # Custom metric numeric value.
273 },
274 ],
275 "engineAccountId": "A String", # DS engine account ID.
276 "type": "A String", # 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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]277 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]278 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
279 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 },
281 ],
282 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
283 }</pre>
284</div>
285
286<div class="method">
287 <code class="details" id="patch">patch(advertiserId, agencyId, endDate, engineAccountId, rowCount, startDate, startRow, body)</code>
288 <pre>Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.
289
290Args:
291 advertiserId: string, Numeric ID of the advertiser. (required)
292 agencyId: string, Numeric ID of the agency. (required)
293 endDate: integer, Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
294 engineAccountId: string, Numeric ID of the engine account. (required)
295 rowCount: integer, The number of conversions to return per call. (required)
296 startDate: integer, First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. (required)
297 startRow: integer, The 0-based starting index for retrieving conversions results. (required)
298 body: object, The request body. (required)
299 The object takes the form of:
300
301{ # A list of conversions.
302 "conversion": [ # The conversions being requested.
303 { # A conversion containing data relevant to DoubleClick Search.
304 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
305 { # A message containing the custome dimension.
306 "name": "A String", # Custom dimension name.
307 "value": "A String", # Custom dimension value.
308 },
309 ],
310 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]311 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]312 "attributionModel": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]313 "campaignId": "A String", # DS campaign ID.
314 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
315 "advertiserId": "A String", # DS advertiser ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]316 "countMillis": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
318 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]319 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]320 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]321 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]322 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]323 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 "adId": "A String", # DS ad ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]325 "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]327 "channel": "A String", # Sales channel for the product. Acceptable values are:
328 # - "local": a physical store
329 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]330 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]331 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
332 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]333 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]334 "quantityMillis": "A String", # The quantity of this conversion, in millis.
335 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]336 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]337 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
338 "customMetric": [ # Custom metrics for the conversion.
339 { # A message containing the custome metric.
340 "name": "A String", # Custom metric name.
341 "value": 3.14, # Custom metric numeric value.
342 },
343 ],
344 "engineAccountId": "A String", # DS engine account ID.
345 "type": "A String", # 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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]346 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]347 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
348 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]349 },
350 ],
351 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
352 }
353
354
355Returns:
356 An object of the form:
357
358 { # A list of conversions.
359 "conversion": [ # The conversions being requested.
360 { # A conversion containing data relevant to DoubleClick Search.
361 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
362 { # A message containing the custome dimension.
363 "name": "A String", # Custom dimension name.
364 "value": "A String", # Custom dimension value.
365 },
366 ],
367 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]368 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]369 "attributionModel": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]370 "campaignId": "A String", # DS campaign ID.
371 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
372 "advertiserId": "A String", # DS advertiser ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]373 "countMillis": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]374 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
375 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]376 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]377 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]378 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]379 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]380 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]381 "adId": "A String", # DS ad ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]382 "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]383 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]384 "channel": "A String", # Sales channel for the product. Acceptable values are:
385 # - "local": a physical store
386 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]387 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]388 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
389 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]390 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]391 "quantityMillis": "A String", # The quantity of this conversion, in millis.
392 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]393 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]394 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
395 "customMetric": [ # Custom metrics for the conversion.
396 { # A message containing the custome metric.
397 "name": "A String", # Custom metric name.
398 "value": 3.14, # Custom metric numeric value.
399 },
400 ],
401 "engineAccountId": "A String", # DS engine account ID.
402 "type": "A String", # 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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]403 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]404 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
405 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]406 },
407 ],
408 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
409 }</pre>
410</div>
411
412<div class="method">
413 <code class="details" id="update">update(body)</code>
414 <pre>Updates a batch of conversions in DoubleClick Search.
415
416Args:
417 body: object, The request body. (required)
418 The object takes the form of:
419
420{ # A list of conversions.
421 "conversion": [ # The conversions being requested.
422 { # A conversion containing data relevant to DoubleClick Search.
423 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
424 { # A message containing the custome dimension.
425 "name": "A String", # Custom dimension name.
426 "value": "A String", # Custom dimension value.
427 },
428 ],
429 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]430 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]431 "attributionModel": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]432 "campaignId": "A String", # DS campaign ID.
433 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
434 "advertiserId": "A String", # DS advertiser ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]435 "countMillis": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]436 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
437 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]438 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]439 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]440 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]441 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]442 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]443 "adId": "A String", # DS ad ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]444 "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]445 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]446 "channel": "A String", # Sales channel for the product. Acceptable values are:
447 # - "local": a physical store
448 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]449 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]450 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
451 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]452 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]453 "quantityMillis": "A String", # The quantity of this conversion, in millis.
454 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]455 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]456 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
457 "customMetric": [ # Custom metrics for the conversion.
458 { # A message containing the custome metric.
459 "name": "A String", # Custom metric name.
460 "value": 3.14, # Custom metric numeric value.
461 },
462 ],
463 "engineAccountId": "A String", # DS engine account ID.
464 "type": "A String", # 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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]465 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]466 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
467 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]468 },
469 ],
470 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
471 }
472
473
474Returns:
475 An object of the form:
476
477 { # A list of conversions.
478 "conversion": [ # The conversions being requested.
479 { # A conversion containing data relevant to DoubleClick Search.
480 "customDimension": [ # Custom dimensions for the conversion, which can be used to filter data in a report.
481 { # A message containing the custome dimension.
482 "name": "A String", # Custom dimension name.
483 "value": "A String", # Custom dimension value.
484 },
485 ],
486 "adGroupId": "A String", # DS ad group ID.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]487 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]488 "attributionModel": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]489 "campaignId": "A String", # DS campaign ID.
490 "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros.
491 "advertiserId": "A String", # DS advertiser ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]492 "countMillis": "A String", # This field is ignored.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]493 "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC.
494 "clickId": "A String", # DS click ID for the conversion.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]495 "dsConversionId": "A String", # ID that DoubleClick Search generates for each conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]496 "currencyCode": "A String", # The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]497 "productCountry": "A String", # The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]498 "state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]499 "deviceType": "A String", # The type of device on which the conversion occurred.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]500 "adId": "A String", # DS ad ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]501 "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]502 "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]503 "channel": "A String", # Sales channel for the product. Acceptable values are:
504 # - "local": a physical store
505 # - "online": an online store
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]506 "productId": "A String", # The product ID (SKU).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]507 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
508 "agencyId": "A String", # DS agency ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]509 "storeId": "A String", # The ID of the local store for which the product was advertised. Applicable only when the channel is "local".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]510 "quantityMillis": "A String", # The quantity of this conversion, in millis.
511 "criterionId": "A String", # DS criterion (keyword) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]512 "floodlightOrderId": "A String", # The Floodlight order ID provided by the advertiser for the conversion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]513 "segmentationType": "A String", # The segmentation type of this conversion (for example, FLOODLIGHT).
514 "customMetric": [ # Custom metrics for the conversion.
515 { # A message containing the custome metric.
516 "name": "A String", # Custom metric name.
517 "value": 3.14, # Custom metric numeric value.
518 },
519 ],
520 "engineAccountId": "A String", # DS engine account ID.
521 "type": "A String", # 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).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]522 "productGroupId": "A String", # DS product group ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]523 "inventoryAccountId": "A String", # ID that DS generates and uses to uniquely identify the inventory account that contains the product.
524 "productLanguage": "A String", # The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]525 },
526 ],
527 "kind": "doubleclicksearch#conversionList", # Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList.
528 }</pre>
529</div>
530
531<div class="method">
532 <code class="details" id="updateAvailability">updateAvailability(body)</code>
533 <pre>Updates the availabilities of a batch of floodlight activities in DoubleClick Search.
534
535Args:
536 body: object, The request body. (required)
537 The object takes the form of:
538
539{ # The request to update availability.
540 "availabilities": [ # The availabilities being requested.
541 { # A message containing availability data relevant to DoubleClick Search.
542 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
543 "agencyId": "A String", # DS agency ID.
544 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
545 "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
546 "advertiserId": "A String", # DS advertiser ID.
547 "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).
548 },
549 ],
550 }
551
552
553Returns:
554 An object of the form:
555
556 { # The response to a update availability request.
557 "availabilities": [ # The availabilities being returned.
558 { # A message containing availability data relevant to DoubleClick Search.
559 "segmentationId": "A String", # The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).
560 "agencyId": "A String", # DS agency ID.
561 "segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).
562 "availabilityTimestamp": "A String", # The time by which all conversions have been uploaded, in epoch millis UTC.
563 "advertiserId": "A String", # DS advertiser ID.
564 "segmentationType": "A String", # The segmentation type that this availability is for (its default value is FLOODLIGHT).
565 },
566 ],
567 }</pre>
568</div>
569
570</body></html>