blob: e029f8b38f1eeeda52367fc602531376d7faa8f9 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<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 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070081 <code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Gets multiple Merchant Center datafeed statuses in a single request.</p>
Craig Citro065b5302014-08-14 00:47:23 -070083<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080084 <code><a href="#get">get(merchantId, datafeedId, language=None, country=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Retrieves the status of a datafeed from your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -070086<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070087 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists the statuses of the datafeeds in your Merchant Center account.</p>
Craig Citroe633be12015-03-02 13:40:36 -080089<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 -070092<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070099 <code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100 <pre>Gets multiple Merchant Center datafeed statuses in a single request.
Craig Citro065b5302014-08-14 00:47:23 -0700101
102Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700103 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700104 The object takes the form of:
105
106{
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 &quot;entries&quot;: [ # The request entries to be processed in the batch.
Craig Citroe633be12015-03-02 13:40:36 -0800108 { # A batch entry encoding a single non-batch datafeedstatuses request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800109 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry. Acceptable values are: - &quot;`get`&quot;
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800110 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800111 &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.
112 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800113 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800114 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the data feed to get.
Craig Citro065b5302014-08-14 00:47:23 -0700115 },
116 ],
117 }
118
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700123
124Returns:
125 An object of the form:
126
127 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800128 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#datafeedstatusesCustomBatchResponse&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700129 &quot;entries&quot;: [ # The result of the execution of the batch requests.
Craig Citroe633be12015-03-02 13:40:36 -0800130 { # A batch entry encoding a single non-batch datafeedstatuses response.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800131 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800132 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800133 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800134 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
135 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
136 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800137 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800138 &quot;errors&quot;: [ # The list of errors occurring in the feed.
139 { # An error occurring in the feed, like &quot;invalid price&quot;.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800140 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
141 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800142 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
143 { # An example occurrence for a particular error.
144 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
145 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
146 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
147 },
148 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800149 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800150 },
151 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800152 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800153 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
154 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
155 { # An error occurring in the feed, like &quot;invalid price&quot;.
156 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
157 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
158 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
159 { # An example occurrence for a particular error.
160 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
161 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
162 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
163 },
164 ],
165 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
166 },
167 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800168 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800169 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800170 &quot;errors&quot;: [ # A list of errors.
171 { # An error returned by the API.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800172 &quot;reason&quot;: &quot;A String&quot;, # The error code.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800173 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800174 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
175 },
176 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800177 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
178 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800179 },
180 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
Craig Citro065b5302014-08-14 00:47:23 -0700181 },
182 ],
183 }</pre>
184</div>
185
186<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800187 <code class="details" id="get">get(merchantId, datafeedId, language=None, country=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700188 <pre>Retrieves the status of a datafeed from your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700189
190Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700191 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
192 datafeedId: string, The ID of the datafeed. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800194 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 Kim673ec5c2020-11-16 11:05:03 -0700195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700199
200Returns:
201 An object of the form:
202
Craig Citroe633be12015-03-02 13:40:36 -0800203 { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800204 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800205 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800206 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
207 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
208 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800209 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800210 &quot;errors&quot;: [ # The list of errors occurring in the feed.
211 { # An error occurring in the feed, like &quot;invalid price&quot;.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800212 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
213 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800214 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
215 { # An example occurrence for a particular error.
216 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
217 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
218 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
219 },
220 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800221 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800222 },
223 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800224 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800225 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
226 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
227 { # An error occurring in the feed, like &quot;invalid price&quot;.
228 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
229 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
230 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
231 { # An example occurrence for a particular error.
232 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
233 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
234 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
235 },
236 ],
237 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
238 },
239 ],
Craig Citro065b5302014-08-14 00:47:23 -0700240 }</pre>
241</div>
242
243<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700244 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700245 <pre>Lists the statuses of the datafeeds in your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700246
247Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700248 merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700249 pageToken: string, The token returned by the previous request.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700250 maxResults: integer, The maximum number of products to return in the response, used for paging.
251 x__xgafv: string, V1 error format.
252 Allowed values
253 1 - v1 error format
254 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700255
256Returns:
257 An object of the form:
258
259 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800260 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#datafeedstatusesListResponse&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700261 &quot;resources&quot;: [
Craig Citroe633be12015-03-02 13:40:36 -0800262 { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800263 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#datafeedStatus`&quot;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800264 &quot;itemsTotal&quot;: &quot;A String&quot;, # The number of items in the feed that were processed.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800265 &quot;lastUploadDate&quot;: &quot;A String&quot;, # The last date at which the feed was uploaded.
266 &quot;language&quot;: &quot;A String&quot;, # The two-letter ISO 639-1 language for which the status is reported.
267 &quot;itemsValid&quot;: &quot;A String&quot;, # The number of items in the feed that were valid.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800268 &quot;country&quot;: &quot;A String&quot;, # The country for which the status is reported, represented as a CLDR territory code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800269 &quot;errors&quot;: [ # The list of errors occurring in the feed.
270 { # An error occurring in the feed, like &quot;invalid price&quot;.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800271 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
272 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800273 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
274 { # An example occurrence for a particular error.
275 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
276 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
277 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
278 },
279 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800280 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800281 },
282 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800283 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800284 &quot;datafeedId&quot;: &quot;A String&quot;, # The ID of the feed for which the status is reported.
285 &quot;warnings&quot;: [ # The list of errors occurring in the feed.
286 { # An error occurring in the feed, like &quot;invalid price&quot;.
287 &quot;count&quot;: &quot;A String&quot;, # The number of occurrences of the error in the feed.
288 &quot;code&quot;: &quot;A String&quot;, # The code of the error, e.g., &quot;validation/invalid_value&quot;.
289 &quot;examples&quot;: [ # A list of example occurrences of the error, grouped by product.
290 { # An example occurrence for a particular error.
291 &quot;lineNumber&quot;: &quot;A String&quot;, # Line number in the data feed where the example is found.
292 &quot;itemId&quot;: &quot;A String&quot;, # The ID of the example item.
293 &quot;value&quot;: &quot;A String&quot;, # The problematic value.
294 },
295 ],
296 &quot;message&quot;: &quot;A String&quot;, # The error message, e.g., &quot;Invalid price&quot;.
297 },
298 ],
Craig Citro065b5302014-08-14 00:47:23 -0700299 },
300 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800301 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of datafeed statuses.
Craig Citro065b5302014-08-14 00:47:23 -0700302 }</pre>
303</div>
304
Craig Citroe633be12015-03-02 13:40:36 -0800305<div class="method">
306 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
307 <pre>Retrieves the next page of results.
308
309Args:
310 previous_request: The request for the previous page. (required)
311 previous_response: The response from the request for the previous page. (required)
312
313Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700314 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800315 page. Returns None if there are no more items in the collection.
316 </pre>
317</div>
318
Craig Citro065b5302014-08-14 00:47:23 -0700319</body></html>