Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / content_v2.accountstatuses.html
blob: a2642b80596a9bc365124a4b7a3ff1044f5930e0 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[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="content_v2.html">Content API for Shopping</a> . <a href="content_v2.accountstatuses.html">accountstatuses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#custombatch">custombatch(body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Retrieves multiple Merchant Center account statuses in a single request.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#get">get(merchantId, accountId, destinations=None)</a></code></p>
82<p class="firstline">Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None, destinations=None)</a></code></p>
85<p class="firstline">Lists the statuses of the sub-accounts in your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]91 <code class="details" id="custombatch">custombatch(body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 <pre>Retrieves multiple Merchant Center account statuses in a single request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]93
94Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]95 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]96 The object takes the form of:
97
98{
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]99 "entries": [ # The request entries to be processed in the batch.
100 { # A batch entry encoding a single non-batch accountstatuses request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101 "batchId": 42, # An entry ID, unique within the batch request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 "method": "A String", # The method of the batch entry.
103 #
104 # Acceptable values are:
105 # - "`get`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 "destinations": [ # If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
107 "A String",
108 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]109 "merchantId": "A String", # The ID of the managing account.
110 "accountId": "A String", # The ID of the (sub-)account whose status to get.
111 },
112 ],
113 }
114
115
116Returns:
117 An object of the form:
118
119 {
120 "kind": "content#accountstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]121 "entries": [ # The result of the execution of the batch requests.
122 { # A batch entry encoding a single non-batch accountstatuses response.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]123 "batchId": 42, # The ID of the request entry this entry responds to.
124 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 "message": "A String", # The message of the first error in `errors`.
126 "code": 42, # The HTTP status of the first error in `errors`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]127 "errors": [ # A list of errors.
128 { # An error returned by the API.
129 "reason": "A String", # The error code.
130 "domain": "A String", # The domain of the error.
131 "message": "A String", # A description of the error.
132 },
133 ],
134 },
135 "accountStatus": { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. # The requested account status. Defined if and only if the request was successful.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]137 "websiteClaimed": True or False, # Whether the account's website is claimed or not.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 "accountLevelIssues": [ # A list of account level issues.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]139 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 "documentation": "A String", # The URL of a web page to help resolving this issue.
141 "severity": "A String", # Severity of the issue.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]142 #
143 # Acceptable values are:
144 # - "`critical`"
145 # - "`error`"
146 # - "`suggestion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "title": "A String", # Short description of the issue.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]148 "country": "A String", # Country for which this issue is reported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 "destination": "A String", # The destination the issue applies to.
150 "detail": "A String", # Additional details about the issue.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]151 "id": "A String", # Issue identifier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 },
153 ],
154 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
155 {
156 "country": "A String", # The country the data applies to.
157 "itemLevelIssues": [ # List of item-level issues.
158 {
159 "code": "A String", # The error code of the issue.
160 "description": "A String", # A short issue description in English.
161 "documentation": "A String", # The URL of a web page to help with resolving this issue.
162 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
163 "detail": "A String", # A detailed issue description in English.
164 "numItems": "A String", # Number of items with this issue.
165 "servability": "A String", # How this issue affects serving of the offer.
166 "resolution": "A String", # Whether the issue can be resolved by the merchant.
167 },
168 ],
169 "destination": "A String", # The destination the data applies to.
170 "channel": "A String", # The channel the data applies to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]171 #
172 # Acceptable values are:
173 # - "`local`"
174 # - "`online`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 "statistics": { # Aggregated product statistics.
176 "active": "A String", # Number of active offers.
177 "expiring": "A String", # Number of expiring offers.
178 "disapproved": "A String", # Number of disapproved offers.
179 "pending": "A String", # Number of pending offers.
180 },
181 },
182 ],
183 "dataQualityIssues": [ # DEPRECATED - never populated.
184 {
185 "displayedValue": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]186 "severity": "A String", # Acceptable values are:
187 # - "`critical`"
188 # - "`error`"
189 # - "`suggestion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 "lastChecked": "A String",
191 "country": "A String",
192 "destination": "A String",
193 "detail": "A String",
194 "submittedValue": "A String",
195 "numItems": 42,
196 "location": "A String",
197 "id": "A String",
198 "exampleItems": [
199 {
200 "itemId": "A String",
201 "submittedValue": "A String",
202 "link": "A String",
203 "valueOnLandingPage": "A String",
204 "title": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]205 },
206 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]207 },
208 ],
209 "accountId": "A String", # The ID of the account for which the status is reported.
210 },
211 },
212 ],
213 }</pre>
214</div>
215
216<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 <code class="details" id="get">get(merchantId, accountId, destinations=None)</code>
218 <pre>Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]219
220Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]221 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]222 accountId: string, The ID of the account. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]224
225Returns:
226 An object of the form:
227
228 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]229 "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]230 "websiteClaimed": True or False, # Whether the account's website is claimed or not.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231 "accountLevelIssues": [ # A list of account level issues.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]232 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 "documentation": "A String", # The URL of a web page to help resolving this issue.
234 "severity": "A String", # Severity of the issue.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]235 #
236 # Acceptable values are:
237 # - "`critical`"
238 # - "`error`"
239 # - "`suggestion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 "title": "A String", # Short description of the issue.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]241 "country": "A String", # Country for which this issue is reported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]242 "destination": "A String", # The destination the issue applies to.
243 "detail": "A String", # Additional details about the issue.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]244 "id": "A String", # Issue identifier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245 },
246 ],
247 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
248 {
249 "country": "A String", # The country the data applies to.
250 "itemLevelIssues": [ # List of item-level issues.
251 {
252 "code": "A String", # The error code of the issue.
253 "description": "A String", # A short issue description in English.
254 "documentation": "A String", # The URL of a web page to help with resolving this issue.
255 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
256 "detail": "A String", # A detailed issue description in English.
257 "numItems": "A String", # Number of items with this issue.
258 "servability": "A String", # How this issue affects serving of the offer.
259 "resolution": "A String", # Whether the issue can be resolved by the merchant.
260 },
261 ],
262 "destination": "A String", # The destination the data applies to.
263 "channel": "A String", # The channel the data applies to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 #
265 # Acceptable values are:
266 # - "`local`"
267 # - "`online`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 "statistics": { # Aggregated product statistics.
269 "active": "A String", # Number of active offers.
270 "expiring": "A String", # Number of expiring offers.
271 "disapproved": "A String", # Number of disapproved offers.
272 "pending": "A String", # Number of pending offers.
273 },
274 },
275 ],
276 "dataQualityIssues": [ # DEPRECATED - never populated.
277 {
278 "displayedValue": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]279 "severity": "A String", # Acceptable values are:
280 # - "`critical`"
281 # - "`error`"
282 # - "`suggestion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 "lastChecked": "A String",
284 "country": "A String",
285 "destination": "A String",
286 "detail": "A String",
287 "submittedValue": "A String",
288 "numItems": 42,
289 "location": "A String",
290 "id": "A String",
291 "exampleItems": [
292 {
293 "itemId": "A String",
294 "submittedValue": "A String",
295 "link": "A String",
296 "valueOnLandingPage": "A String",
297 "title": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]298 },
299 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]300 },
301 ],
302 "accountId": "A String", # The ID of the account for which the status is reported.
303 }</pre>
304</div>
305
306<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None, destinations=None)</code>
308 <pre>Lists the statuses of the sub-accounts in your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]309
310Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]312 pageToken: string, The token returned by the previous request.
313 maxResults: integer, The maximum number of account statuses to return in the response, used for paging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]315
316Returns:
317 An object of the form:
318
319 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]320 "nextPageToken": "A String", # The token for the retrieval of the next page of account statuses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]321 "kind": "content#accountstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".
322 "resources": [
323 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]324 "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]325 "websiteClaimed": True or False, # Whether the account's website is claimed or not.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 "accountLevelIssues": [ # A list of account level issues.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]327 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 "documentation": "A String", # The URL of a web page to help resolving this issue.
329 "severity": "A String", # Severity of the issue.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]330 #
331 # Acceptable values are:
332 # - "`critical`"
333 # - "`error`"
334 # - "`suggestion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 "title": "A String", # Short description of the issue.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]336 "country": "A String", # Country for which this issue is reported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]337 "destination": "A String", # The destination the issue applies to.
338 "detail": "A String", # Additional details about the issue.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]339 "id": "A String", # Issue identifier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]340 },
341 ],
342 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
343 {
344 "country": "A String", # The country the data applies to.
345 "itemLevelIssues": [ # List of item-level issues.
346 {
347 "code": "A String", # The error code of the issue.
348 "description": "A String", # A short issue description in English.
349 "documentation": "A String", # The URL of a web page to help with resolving this issue.
350 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute.
351 "detail": "A String", # A detailed issue description in English.
352 "numItems": "A String", # Number of items with this issue.
353 "servability": "A String", # How this issue affects serving of the offer.
354 "resolution": "A String", # Whether the issue can be resolved by the merchant.
355 },
356 ],
357 "destination": "A String", # The destination the data applies to.
358 "channel": "A String", # The channel the data applies to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 #
360 # Acceptable values are:
361 # - "`local`"
362 # - "`online`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 "statistics": { # Aggregated product statistics.
364 "active": "A String", # Number of active offers.
365 "expiring": "A String", # Number of expiring offers.
366 "disapproved": "A String", # Number of disapproved offers.
367 "pending": "A String", # Number of pending offers.
368 },
369 },
370 ],
371 "dataQualityIssues": [ # DEPRECATED - never populated.
372 {
373 "displayedValue": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 "severity": "A String", # Acceptable values are:
375 # - "`critical`"
376 # - "`error`"
377 # - "`suggestion`"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]378 "lastChecked": "A String",
379 "country": "A String",
380 "destination": "A String",
381 "detail": "A String",
382 "submittedValue": "A String",
383 "numItems": 42,
384 "location": "A String",
385 "id": "A String",
386 "exampleItems": [
387 {
388 "itemId": "A String",
389 "submittedValue": "A String",
390 "link": "A String",
391 "valueOnLandingPage": "A String",
392 "title": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]393 },
394 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]395 },
396 ],
397 "accountId": "A String", # The ID of the account for which the status is reported.
398 },
399 ],
400 }</pre>
401</div>
402
403<div class="method">
404 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
405 <pre>Retrieves the next page of results.
406
407Args:
408 previous_request: The request for the previous page. (required)
409 previous_response: The response from the request for the previous page. (required)
410
411Returns:
412 A request object that you can call 'execute()' on to request the next
413 page. Returns None if there are no more items in the collection.
414 </pre>
415</div>
416
417</body></html>