Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 25fba648ea647b62f2a6edc54ae927c1ed381b45 / . / docs / dyn / content_v2.datafeedstatuses.html
blob: 9d72cbc148a9344fb10a75cc4005eac3545473ca [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.datafeedstatuses.html">datafeedstatuses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#custombatch">custombatch(body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Gets multiple Merchant Center datafeed statuses in a single request.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]84 <code><a href="#get">get(merchantId, datafeedId, country=None, language=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Retrieves the status of a datafeed from your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists the statuses of the datafeeds in your Merchant Center account.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code class="details" id="custombatch">custombatch(body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100 <pre>Gets multiple Merchant Center datafeed statuses in a single request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101
102Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]104 The object takes the form of:
105
106{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;entries&quot;: [ # The request entries to be processed in the batch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]108 { # A batch entry encoding a single non-batch datafeedstatuses request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
110 &quot;country&quot;: &quot;A String&quot;, # The country for which to get the datafeed status. 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;language&quot;: &quot;A String&quot;, # The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.
113 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
114 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 #
116 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 # - &quot;`get`&quot;
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]118 },
119 ],
120 }
121
122
123Returns:
124 An object of the form:
125
126 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 &quot;entries&quot;: [ # The result of the execution of the batch requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]128 { # A batch entry encoding a single non-batch datafeedstatuses response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
130 &quot;datafeedStatus&quot;: { # The status of a datafeed, i.e., 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.
131 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
132 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
133 &quot;errors&quot;: [ # The list of errors occurring in the feed.
134 { # An error occurring in the feed, like &quot;invalid price&quot;.
135 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
136 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
137 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
138 { # An example occurrence for a particular error.
139 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
140 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
141 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
142 },
143 ],
144 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
145 },
146 ],
147 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
148 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
149 &quot;kind&quot;: &quot;content#datafeedStatus&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
150 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
151 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
152 &quot;processingStatus&quot;: &quot;A String&quot;, # The processing status of the feed.
153 #
154 # Acceptable values are:
155 # - &quot;`&quot;`failure`&quot;: The feed could not be processed or all items had errors.`&quot;
156 # - &quot;`in progress`&quot;: The feed is being processed.
157 # - &quot;`none`&quot;: The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status.
158 # - &quot;`success`&quot;: The feed was processed successfully, though some items might have had errors.
159 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
160 { # An error occurring in the feed, like &quot;invalid price&quot;.
161 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
162 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
163 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
164 { # An example occurrence for a particular error.
165 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
166 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
167 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
168 },
169 ],
170 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]171 },
172 ],
173 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 &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.
175 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
176 &quot;errors&quot;: [ # A list of errors.
177 { # An error returned by the API.
178 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
179 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
180 &quot;reason&quot;: &quot;A String&quot;, # The error code.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]181 },
182 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]184 },
185 },
186 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;kind&quot;: &quot;content#datafeedstatusesCustomBatchResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#datafeedstatusesCustomBatchResponse&quot;.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]188 }</pre>
189</div>
190
191<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 <code class="details" id="get">get(merchantId, datafeedId, country=None, language=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 <pre>Retrieves the status of a datafeed from your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]194
195Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
197 datafeedId: string, The ID of the datafeed. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 country: string, The country for which to get the datafeed status. 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 language: string, The language for which to get the datafeed status. 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]200
201Returns:
202 An object of the form:
203
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]204 { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
206 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
207 &quot;errors&quot;: [ # The list of errors occurring in the feed.
208 { # An error occurring in the feed, like &quot;invalid price&quot;.
209 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
210 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
211 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]212 { # An example occurrence for a particular error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]213 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
214 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
215 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]216 },
217 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]219 },
220 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
222 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
223 &quot;kind&quot;: &quot;content#datafeedStatus&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
224 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
225 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
226 &quot;processingStatus&quot;: &quot;A String&quot;, # The processing status of the feed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 #
228 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 # - &quot;`&quot;`failure`&quot;: The feed could not be processed or all items had errors.`&quot;
230 # - &quot;`in progress`&quot;: The feed is being processed.
231 # - &quot;`none`&quot;: The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status.
232 # - &quot;`success`&quot;: The feed was processed successfully, though some items might have had errors.
233 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
234 { # An error occurring in the feed, like &quot;invalid price&quot;.
235 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
236 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
237 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]238 { # An example occurrence for a particular error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
240 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
241 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]242 },
243 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]244 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]245 },
246 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]247 }</pre>
248</div>
249
250<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 <pre>Lists the statuses of the datafeeds in your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]253
254Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]256 maxResults: integer, The maximum number of products to return in the response, used for paging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 pageToken: string, The token returned by the previous request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]258
259Returns:
260 An object of the form:
261
262 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;kind&quot;: &quot;content#datafeedstatusesListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#datafeedstatusesListResponse&quot;.
264 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of datafeed statuses.
265 &quot;resources&quot;: [
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]266 { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]267 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
268 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
269 &quot;errors&quot;: [ # The list of errors occurring in the feed.
270 { # An error occurring in the feed, like &quot;invalid price&quot;.
271 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
272 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
273 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]274 { # An example occurrence for a particular error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]275 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
276 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
277 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]278 },
279 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]280 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]281 },
282 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
284 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
285 &quot;kind&quot;: &quot;content#datafeedStatus&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
286 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
287 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
288 &quot;processingStatus&quot;: &quot;A String&quot;, # The processing status of the feed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 #
290 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 # - &quot;`&quot;`failure`&quot;: The feed could not be processed or all items had errors.`&quot;
292 # - &quot;`in progress`&quot;: The feed is being processed.
293 # - &quot;`none`&quot;: The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status.
294 # - &quot;`success`&quot;: The feed was processed successfully, though some items might have had errors.
295 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
296 { # An error occurring in the feed, like &quot;invalid price&quot;.
297 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
298 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
299 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]300 { # An example occurrence for a particular error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]301 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
302 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
303 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]304 },
305 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]306 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]307 },
308 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]309 },
310 ],
311 }</pre>
312</div>
313
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]314<div class="method">
315 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
316 <pre>Retrieves the next page of results.
317
318Args:
319 previous_request: The request for the previous page. (required)
320 previous_response: The response from the request for the previous page. (required)
321
322Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]323 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]324 page. Returns None if there are no more items in the collection.
325 </pre>
326</div>
327
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]328</body></html>