Debian Codegraph @

docs/dyn/content_v2.accountstatuses.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">
78 <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="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves multiple Merchant Center account statuses in a single request.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(merchantId, accountId, destinations=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(merchantId, destinations=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists the statuses of the sub-accounts in your Merchant Center account.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <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="custombatch">custombatch(body=None, x__xgafv=None)</code>
100 <pre>Retrieves multiple Merchant Center account statuses in a single request.
101
102 Args:
103 body: object, The request body.
104 The object takes the form of:
105
106 {
107 &quot;entries&quot;: [ # The request entries to be processed in the batch.
108 { # A batch entry encoding a single non-batch accountstatuses request.
109 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the (sub-)account whose status to get.
110 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
111 &quot;destinations&quot;: [ # If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
112 &quot;A String&quot;,
113 ],
114 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
115 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry. Acceptable values are: - &quot;`get`&quot;
116 },
117 ],
118 }
119
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125 Returns:
126 An object of the form:
127
128 {
129 &quot;entries&quot;: [ # The result of the execution of the batch requests.
130 { # A batch entry encoding a single non-batch accountstatuses response.
131 &quot;accountStatus&quot;: { # 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.
132 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account for which the status is reported.
133 &quot;accountLevelIssues&quot;: [ # A list of account level issues.
134 {
135 &quot;country&quot;: &quot;A String&quot;, # Country for which this issue is reported.
136 &quot;destination&quot;: &quot;A String&quot;, # The destination the issue applies to. If this field is empty then the issue applies to all available destinations.
137 &quot;detail&quot;: &quot;A String&quot;, # Additional details about the issue.
138 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help resolving this issue.
139 &quot;id&quot;: &quot;A String&quot;, # Issue identifier.
140 &quot;severity&quot;: &quot;A String&quot;, # Severity of the issue. Acceptable values are: - &quot;`critical`&quot; - &quot;`error`&quot; - &quot;`suggestion`&quot;
141 &quot;title&quot;: &quot;A String&quot;, # Short description of the issue.
142 },
143 ],
144 &quot;dataQualityIssues&quot;: [ # DEPRECATED - never populated.
145 {
146 &quot;country&quot;: &quot;A String&quot;,
147 &quot;destination&quot;: &quot;A String&quot;,
148 &quot;detail&quot;: &quot;A String&quot;,
149 &quot;displayedValue&quot;: &quot;A String&quot;,
150 &quot;exampleItems&quot;: [
151 {
152 &quot;itemId&quot;: &quot;A String&quot;,
153 &quot;link&quot;: &quot;A String&quot;,
154 &quot;submittedValue&quot;: &quot;A String&quot;,
155 &quot;title&quot;: &quot;A String&quot;,
156 &quot;valueOnLandingPage&quot;: &quot;A String&quot;,
157 },
158 ],
159 &quot;id&quot;: &quot;A String&quot;,
160 &quot;lastChecked&quot;: &quot;A String&quot;,
161 &quot;location&quot;: &quot;A String&quot;,
162 &quot;numItems&quot;: 42,
163 &quot;severity&quot;: &quot;A String&quot;, # Acceptable values are: - &quot;`critical`&quot; - &quot;`error`&quot; - &quot;`suggestion`&quot;
164 &quot;submittedValue&quot;: &quot;A String&quot;,
165 },
166 ],
167 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accountStatus`&quot;
168 &quot;products&quot;: [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
169 {
170 &quot;channel&quot;: &quot;A String&quot;, # The channel the data applies to. Acceptable values are: - &quot;`local`&quot; - &quot;`online`&quot;
171 &quot;country&quot;: &quot;A String&quot;, # The country the data applies to.
172 &quot;destination&quot;: &quot;A String&quot;, # The destination the data applies to.
173 &quot;itemLevelIssues&quot;: [ # List of item-level issues.
174 {
175 &quot;attributeName&quot;: &quot;A String&quot;, # The attribute&#x27;s name, if the issue is caused by a single attribute.
176 &quot;code&quot;: &quot;A String&quot;, # The error code of the issue.
177 &quot;description&quot;: &quot;A String&quot;, # A short issue description in English.
178 &quot;detail&quot;: &quot;A String&quot;, # A detailed issue description in English.
179 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help with resolving this issue.
180 &quot;numItems&quot;: &quot;A String&quot;, # Number of items with this issue.
181 &quot;resolution&quot;: &quot;A String&quot;, # Whether the issue can be resolved by the merchant.
182 &quot;servability&quot;: &quot;A String&quot;, # How this issue affects serving of the offer.
183 },
184 ],
185 &quot;statistics&quot;: { # Aggregated product statistics.
186 &quot;active&quot;: &quot;A String&quot;, # Number of active offers.
187 &quot;disapproved&quot;: &quot;A String&quot;, # Number of disapproved offers.
188 &quot;expiring&quot;: &quot;A String&quot;, # Number of expiring offers.
189 &quot;pending&quot;: &quot;A String&quot;, # Number of pending offers.
190 },
191 },
192 ],
193 &quot;websiteClaimed&quot;: True or False, # Whether the account&#x27;s website is claimed or not.
194 },
195 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
196 &quot;errors&quot;: { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
197 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
198 &quot;errors&quot;: [ # A list of errors.
199 { # An error returned by the API.
200 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
201 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
202 &quot;reason&quot;: &quot;A String&quot;, # The error code.
203 },
204 ],
205 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
206 },
207 },
208 ],
209 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountstatusesCustomBatchResponse&quot;.
210 }</pre>
211 </div>
212
213 <div class="method">
214 <code class="details" id="get">get(merchantId, accountId, destinations=None, x__xgafv=None)</code>
215 <pre>Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.
216
217 Args:
218 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)
219 accountId: string, The ID of the account. (required)
220 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated)
221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
225
226 Returns:
227 An object of the form:
228
229 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
230 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account for which the status is reported.
231 &quot;accountLevelIssues&quot;: [ # A list of account level issues.
232 {
233 &quot;country&quot;: &quot;A String&quot;, # Country for which this issue is reported.
234 &quot;destination&quot;: &quot;A String&quot;, # The destination the issue applies to. If this field is empty then the issue applies to all available destinations.
235 &quot;detail&quot;: &quot;A String&quot;, # Additional details about the issue.
236 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help resolving this issue.
237 &quot;id&quot;: &quot;A String&quot;, # Issue identifier.
238 &quot;severity&quot;: &quot;A String&quot;, # Severity of the issue. Acceptable values are: - &quot;`critical`&quot; - &quot;`error`&quot; - &quot;`suggestion`&quot;
239 &quot;title&quot;: &quot;A String&quot;, # Short description of the issue.
240 },
241 ],
242 &quot;dataQualityIssues&quot;: [ # DEPRECATED - never populated.
243 {
244 &quot;country&quot;: &quot;A String&quot;,
245 &quot;destination&quot;: &quot;A String&quot;,
246 &quot;detail&quot;: &quot;A String&quot;,
247 &quot;displayedValue&quot;: &quot;A String&quot;,
248 &quot;exampleItems&quot;: [
249 {
250 &quot;itemId&quot;: &quot;A String&quot;,
251 &quot;link&quot;: &quot;A String&quot;,
252 &quot;submittedValue&quot;: &quot;A String&quot;,
253 &quot;title&quot;: &quot;A String&quot;,
254 &quot;valueOnLandingPage&quot;: &quot;A String&quot;,
255 },
256 ],
257 &quot;id&quot;: &quot;A String&quot;,
258 &quot;lastChecked&quot;: &quot;A String&quot;,
259 &quot;location&quot;: &quot;A String&quot;,
260 &quot;numItems&quot;: 42,
261 &quot;severity&quot;: &quot;A String&quot;, # Acceptable values are: - &quot;`critical`&quot; - &quot;`error`&quot; - &quot;`suggestion`&quot;
262 &quot;submittedValue&quot;: &quot;A String&quot;,
263 },
264 ],
265 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accountStatus`&quot;
266 &quot;products&quot;: [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
267 {
268 &quot;channel&quot;: &quot;A String&quot;, # The channel the data applies to. Acceptable values are: - &quot;`local`&quot; - &quot;`online`&quot;
269 &quot;country&quot;: &quot;A String&quot;, # The country the data applies to.
270 &quot;destination&quot;: &quot;A String&quot;, # The destination the data applies to.
271 &quot;itemLevelIssues&quot;: [ # List of item-level issues.
272 {
273 &quot;attributeName&quot;: &quot;A String&quot;, # The attribute&#x27;s name, if the issue is caused by a single attribute.
274 &quot;code&quot;: &quot;A String&quot;, # The error code of the issue.
275 &quot;description&quot;: &quot;A String&quot;, # A short issue description in English.
276 &quot;detail&quot;: &quot;A String&quot;, # A detailed issue description in English.
277 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help with resolving this issue.
278 &quot;numItems&quot;: &quot;A String&quot;, # Number of items with this issue.
279 &quot;resolution&quot;: &quot;A String&quot;, # Whether the issue can be resolved by the merchant.
280 &quot;servability&quot;: &quot;A String&quot;, # How this issue affects serving of the offer.
281 },
282 ],
283 &quot;statistics&quot;: { # Aggregated product statistics.
284 &quot;active&quot;: &quot;A String&quot;, # Number of active offers.
285 &quot;disapproved&quot;: &quot;A String&quot;, # Number of disapproved offers.
286 &quot;expiring&quot;: &quot;A String&quot;, # Number of expiring offers.
287 &quot;pending&quot;: &quot;A String&quot;, # Number of pending offers.
288 },
289 },
290 ],
291 &quot;websiteClaimed&quot;: True or False, # Whether the account&#x27;s website is claimed or not.
292 }</pre>
293 </div>
294
295 <div class="method">
296 <code class="details" id="list">list(merchantId, destinations=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
297 <pre>Lists the statuses of the sub-accounts in your Merchant Center account.
298
299 Args:
300 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
301 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated)
302 maxResults: integer, The maximum number of account statuses to return in the response, used for paging.
303 pageToken: string, The token returned by the previous request.
304 x__xgafv: string, V1 error format.
305 Allowed values
306 1 - v1 error format
307 2 - v2 error format
308
309 Returns:
310 An object of the form:
311
312 {
313 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountstatusesListResponse&quot;.
314 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of account statuses.
315 &quot;resources&quot;: [
316 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
317 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account for which the status is reported.
318 &quot;accountLevelIssues&quot;: [ # A list of account level issues.
319 {
320 &quot;country&quot;: &quot;A String&quot;, # Country for which this issue is reported.
321 &quot;destination&quot;: &quot;A String&quot;, # The destination the issue applies to. If this field is empty then the issue applies to all available destinations.
322 &quot;detail&quot;: &quot;A String&quot;, # Additional details about the issue.
323 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help resolving this issue.
324 &quot;id&quot;: &quot;A String&quot;, # Issue identifier.
325 &quot;severity&quot;: &quot;A String&quot;, # Severity of the issue. Acceptable values are: - &quot;`critical`&quot; - &quot;`error`&quot; - &quot;`suggestion`&quot;
326 &quot;title&quot;: &quot;A String&quot;, # Short description of the issue.
327 },
328 ],
329 &quot;dataQualityIssues&quot;: [ # DEPRECATED - never populated.
330 {
331 &quot;country&quot;: &quot;A String&quot;,
332 &quot;destination&quot;: &quot;A String&quot;,
333 &quot;detail&quot;: &quot;A String&quot;,
334 &quot;displayedValue&quot;: &quot;A String&quot;,
335 &quot;exampleItems&quot;: [
336 {
337 &quot;itemId&quot;: &quot;A String&quot;,
338 &quot;link&quot;: &quot;A String&quot;,
339 &quot;submittedValue&quot;: &quot;A String&quot;,
340 &quot;title&quot;: &quot;A String&quot;,
341 &quot;valueOnLandingPage&quot;: &quot;A String&quot;,
342 },
343 ],
344 &quot;id&quot;: &quot;A String&quot;,
345 &quot;lastChecked&quot;: &quot;A String&quot;,
346 &quot;location&quot;: &quot;A String&quot;,
347 &quot;numItems&quot;: 42,
348 &quot;severity&quot;: &quot;A String&quot;, # Acceptable values are: - &quot;`critical`&quot; - &quot;`error`&quot; - &quot;`suggestion`&quot;
349 &quot;submittedValue&quot;: &quot;A String&quot;,
350 },
351 ],
352 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accountStatus`&quot;
353 &quot;products&quot;: [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
354 {
355 &quot;channel&quot;: &quot;A String&quot;, # The channel the data applies to. Acceptable values are: - &quot;`local`&quot; - &quot;`online`&quot;
356 &quot;country&quot;: &quot;A String&quot;, # The country the data applies to.
357 &quot;destination&quot;: &quot;A String&quot;, # The destination the data applies to.
358 &quot;itemLevelIssues&quot;: [ # List of item-level issues.
359 {
360 &quot;attributeName&quot;: &quot;A String&quot;, # The attribute&#x27;s name, if the issue is caused by a single attribute.
361 &quot;code&quot;: &quot;A String&quot;, # The error code of the issue.
362 &quot;description&quot;: &quot;A String&quot;, # A short issue description in English.
363 &quot;detail&quot;: &quot;A String&quot;, # A detailed issue description in English.
364 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help with resolving this issue.
365 &quot;numItems&quot;: &quot;A String&quot;, # Number of items with this issue.
366 &quot;resolution&quot;: &quot;A String&quot;, # Whether the issue can be resolved by the merchant.
367 &quot;servability&quot;: &quot;A String&quot;, # How this issue affects serving of the offer.
368 },
369 ],
370 &quot;statistics&quot;: { # Aggregated product statistics.
371 &quot;active&quot;: &quot;A String&quot;, # Number of active offers.
372 &quot;disapproved&quot;: &quot;A String&quot;, # Number of disapproved offers.
373 &quot;expiring&quot;: &quot;A String&quot;, # Number of expiring offers.
374 &quot;pending&quot;: &quot;A String&quot;, # Number of pending offers.
375 },
376 },
377 ],
378 &quot;websiteClaimed&quot;: True or False, # Whether the account&#x27;s website is claimed or not.
379 },
380 ],
381 }</pre>
382 </div>
383
384 <div class="method">
385 <code class="details" id="list_next">list_next()</code>
386 <pre>Retrieves the next page of results.
387
388 Args:
389 previous_request: The request for the previous page. (required)
390 previous_response: The response from the request for the previous page. (required)
391
392 Returns:
393 A request object that you can call &#x27;execute()&#x27; on to request the next
394 page. Returns None if there are no more items in the collection.
395 </pre>
396 </div>
397
398 </body></html>