Debian Codegraph @

docs/dyn/content_v2_1.datafeedstatuses.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_1.html">Content API for Shopping</a> . <a href="content_v2_1.datafeedstatuses.html">datafeedstatuses</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">Gets multiple Merchant Center datafeed statuses in a single request.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(merchantId, datafeedId, country=None, feedLabel=None, language=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves the status of a datafeed from your Merchant Center account.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists the statuses of the datafeeds 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>Gets multiple Merchant Center datafeed 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 datafeedstatuses request.
109 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
110 &quot;country&quot;: &quot;A String&quot;, # Deprecated. Use `feedLabel` instead. The country to get the datafeed status for. If this parameter is provided, then `language` must also be provided. Note that for multi-target datafeeds this parameter is required.
111 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the data feed to get.
112 &quot;feedLabel&quot;: &quot;A String&quot;, # The feed label to get the datafeed status for. If this parameter is provided, then `language` must also be provided. Note that for multi-target datafeeds this parameter is required.
113 &quot;language&quot;: &quot;A String&quot;, # The language to get the datafeed status for. If this parameter is provided then `country` must also be provided. Note that for multi-target datafeeds this parameter is required.
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 datafeedstatuses response.
131 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
132 &quot;datafeedStatus&quot;: { # The status of a datafeed, that is, the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. # The requested data feed status. Defined if and only if the request was successful.
133 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
134 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
135 &quot;errors&quot;: [ # The list of errors occurring in the feed.
136 { # An error occurring in the feed, like &quot;invalid price&quot;.
137 &quot;code&quot;: &quot;A String&quot;, # The code of the error, for example, &quot;validation/invalid_value&quot;.
138 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
139 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
140 { # An example occurrence for a particular error.
141 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
142 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
143 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
144 },
145 ],
146 &quot;message&quot;: &quot;A String&quot;, # The error message, for example, &quot;Invalid price&quot;.
147 },
148 ],
149 &quot;feedLabel&quot;: &quot;A String&quot;, # The feed label status is reported for.
150 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
151 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
152 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
153 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
154 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
155 &quot;processingStatus&quot;: &quot;A String&quot;, # The processing status of the feed. Acceptable values are: - &quot;`&quot;`failure`&quot;: The feed could not be processed or all items had errors.`&quot; - &quot;`in progress`&quot;: The feed is being processed. - &quot;`none`&quot;: The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - &quot;`success`&quot;: The feed was processed successfully, though some items might have had errors.
156 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
157 { # An error occurring in the feed, like &quot;invalid price&quot;.
158 &quot;code&quot;: &quot;A String&quot;, # The code of the error, for example, &quot;validation/invalid_value&quot;.
159 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
160 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
161 { # An example occurrence for a particular error.
162 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
163 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
164 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
165 },
166 ],
167 &quot;message&quot;: &quot;A String&quot;, # The error message, for example, &quot;Invalid price&quot;.
168 },
169 ],
170 },
171 &quot;errors&quot;: { # A list of errors returned by a failed batch entry. # A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
172 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
173 &quot;errors&quot;: [ # A list of errors.
174 { # An error returned by the API.
175 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
176 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
177 &quot;reason&quot;: &quot;A String&quot;, # The error code.
178 },
179 ],
180 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
181 },
182 },
183 ],
184 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedstatusesCustomBatchResponse`&quot;.
185 }</pre>
186 </div>
187
188 <div class="method">
189 <code class="details" id="get">get(merchantId, datafeedId, country=None, feedLabel=None, language=None, x__xgafv=None)</code>
190 <pre>Retrieves the status of a datafeed from your Merchant Center account.
191
192 Args:
193 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
194 datafeedId: string, The ID of the datafeed. (required)
195 country: string, Deprecated. Use `feedLabel` instead. The country to get the datafeed status for. If this parameter is provided then `language` must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.
196 feedLabel: string, The feed label to get the datafeed status for. If this parameter is provided then `language` must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.
197 language: string, The language to get the datafeed status for. If this parameter is provided then `country` must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203 Returns:
204 An object of the form:
205
206 { # The status of a datafeed, that is, the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
207 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
208 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
209 &quot;errors&quot;: [ # The list of errors occurring in the feed.
210 { # An error occurring in the feed, like &quot;invalid price&quot;.
211 &quot;code&quot;: &quot;A String&quot;, # The code of the error, for example, &quot;validation/invalid_value&quot;.
212 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
213 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
214 { # An example occurrence for a particular error.
215 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
216 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
217 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
218 },
219 ],
220 &quot;message&quot;: &quot;A String&quot;, # The error message, for example, &quot;Invalid price&quot;.
221 },
222 ],
223 &quot;feedLabel&quot;: &quot;A String&quot;, # The feed label status is reported for.
224 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
225 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
226 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
227 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
228 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
229 &quot;processingStatus&quot;: &quot;A String&quot;, # The processing status of the feed. Acceptable values are: - &quot;`&quot;`failure`&quot;: The feed could not be processed or all items had errors.`&quot; - &quot;`in progress`&quot;: The feed is being processed. - &quot;`none`&quot;: The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - &quot;`success`&quot;: The feed was processed successfully, though some items might have had errors.
230 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
231 { # An error occurring in the feed, like &quot;invalid price&quot;.
232 &quot;code&quot;: &quot;A String&quot;, # The code of the error, for example, &quot;validation/invalid_value&quot;.
233 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
234 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
235 { # An example occurrence for a particular error.
236 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
237 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
238 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
239 },
240 ],
241 &quot;message&quot;: &quot;A String&quot;, # The error message, for example, &quot;Invalid price&quot;.
242 },
243 ],
244 }</pre>
245 </div>
246
247 <div class="method">
248 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code>
249 <pre>Lists the statuses of the datafeeds in your Merchant Center account.
250
251 Args:
252 merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)
253 maxResults: integer, The maximum number of products to return in the response, used for paging.
254 pageToken: string, The token returned by the previous request.
255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260 Returns:
261 An object of the form:
262
263 {
264 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedstatusesListResponse`&quot;.
265 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of datafeed statuses.
266 &quot;resources&quot;: [
267 { # The status of a datafeed, that is, the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
268 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
269 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
270 &quot;errors&quot;: [ # The list of errors occurring in the feed.
271 { # An error occurring in the feed, like &quot;invalid price&quot;.
272 &quot;code&quot;: &quot;A String&quot;, # The code of the error, for example, &quot;validation/invalid_value&quot;.
273 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
274 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
275 { # An example occurrence for a particular error.
276 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
277 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
278 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
279 },
280 ],
281 &quot;message&quot;: &quot;A String&quot;, # The error message, for example, &quot;Invalid price&quot;.
282 },
283 ],
284 &quot;feedLabel&quot;: &quot;A String&quot;, # The feed label status is reported for.
285 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
286 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
287 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
288 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
289 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
290 &quot;processingStatus&quot;: &quot;A String&quot;, # The processing status of the feed. Acceptable values are: - &quot;`&quot;`failure`&quot;: The feed could not be processed or all items had errors.`&quot; - &quot;`in progress`&quot;: The feed is being processed. - &quot;`none`&quot;: The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - &quot;`success`&quot;: The feed was processed successfully, though some items might have had errors.
291 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
292 { # An error occurring in the feed, like &quot;invalid price&quot;.
293 &quot;code&quot;: &quot;A String&quot;, # The code of the error, for example, &quot;validation/invalid_value&quot;.
294 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
295 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
296 { # An example occurrence for a particular error.
297 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
298 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
299 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
300 },
301 ],
302 &quot;message&quot;: &quot;A String&quot;, # The error message, for example, &quot;Invalid price&quot;.
303 },
304 ],
305 },
306 ],
307 }</pre>
308 </div>
309
310 <div class="method">
311 <code class="details" id="list_next">list_next()</code>
312 <pre>Retrieves the next page of results.
313
314 Args:
315 previous_request: The request for the previous page. (required)
316 previous_response: The response from the request for the previous page. (required)
317
318 Returns:
319 A request object that you can call &#x27;execute()&#x27; on to request the next
320 page. Returns None if there are no more items in the collection.
321 </pre>
322 </div>
323
324 </body></html>