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