Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 065b5307fe180bfdd4a5d9af134b1c9a0a1d2aba / . / docs / dyn / content_v2.datafeedstatuses.html
blob: 332b716c3e5d0aa33e768ac1c5edd9e67b293e3c [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">
78 <code><a href="#batch">batch(body)</a></code></p>
79<p class="firstline">A description of how to use this function</p>
80<p class="toc_element">
81 <code><a href="#custombatch">custombatch(body)</a></code></p>
82<p class="firstline">A description of how to use this function</p>
83<p class="toc_element">
84 <code><a href="#get">get(merchantId, datafeedId)</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)</a></code></p>
88<p class="firstline">Lists the statuses of the datafeeds in your Merchant Center account.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="batch">batch(body)</code>
92 <pre>A description of how to use this function
93
94Args:
95 body: object, The request body. (required)
96 The object takes the form of:
97
98{
99 "entrys": [
100 {
101 "batchId": 42,
102 "methodName": "A String",
103 },
104 ],
105 }
106
107
108Returns:
109 An object of the form:
110
111 {
112 "entrys": [
113 {
114 "batchId": 42,
115 "datafeedstatusesgetresponse": {
116 "kind": "content#datafeedstatusesGetResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesGetResponse".
117 "resource": {
118 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
119 "errors": [ # The list of errors occurring in the feed.
120 { # An error occurring in the feed, like "invalid price".
121 "count": 42, # The number of occurrences of the error in the feed.
122 "message": "A String", # The error message, e.g., "Invalid price".
123 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
124 "examples": [ # A list of example occurrences of the error, grouped by product.
125 { # An example occurrence for a particular error.
126 "itemId": "A String", # The ID of the example item.
127 "value": "A String", # The problematic value.
128 "lineNumber": 42, # Line number in the data feed where the example is found.
129 },
130 ],
131 },
132 ],
133 "processingStatus": "A String", # The processing status of the feed.
134 "itemsTotal": 42, # The number of items in the feed that were processed.
135 "warnings": [ # The list of errors occurring in the feed.
136 { # An error occurring in the feed, like "invalid price".
137 "count": 42, # The number of occurrences of the error in the feed.
138 "message": "A String", # The error message, e.g., "Invalid price".
139 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
140 "examples": [ # A list of example occurrences of the error, grouped by product.
141 { # An example occurrence for a particular error.
142 "itemId": "A String", # The ID of the example item.
143 "value": "A String", # The problematic value.
144 "lineNumber": 42, # Line number in the data feed where the example is found.
145 },
146 ],
147 },
148 ],
149 "itemsValid": 42, # The number of items in the feed that were valid.
150 "datafeedId": "A String", # The ID of the feed for which the status is reported.
151 },
152 },
153 },
154 ],
155 "kind": "content#datafeedstatusesBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesBatchResponse".
156 }</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="custombatch">custombatch(body)</code>
161 <pre>A description of how to use this function
162
163Args:
164 body: object, The request body. (required)
165 The object takes the form of:
166
167{
168 "entries": [
169 { # A batch entry encoding a single non-batch request to the datafeedstatuses service of the Content API for Shopping.
170 "batchId": 42, # An entry ID, unique within the batch request.
171 "datafeedId": "A String", # The ID of the data feed to get or delete.
172 "merchantId": "A String", # The ID of the managing account.
173 "method": "A String", # The method (get).
174 },
175 ],
176 }
177
178
179Returns:
180 An object of the form:
181
182 {
183 "kind": "content#datafeedstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".
184 "entries": [
185 { # A batch entry encoding a single non-batch response from the datafeedstatuses service of the Content API for Shopping.
186 "batchId": 42, # The ID of the request entry this entry responds to.
187 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
188 "message": "A String", # The message of the first error in errors.
189 "code": 42, # The HTTP status of the first error in errors.
190 "errors": [ # A list of errors.
191 { # An error returned by the API.
192 "reason": "A String", # The error code.
193 "domain": "A String", # The domain of the error.
194 "message": "A String", # A description of the error.
195 },
196 ],
197 },
198 "datafeedStatus": { # The requested data feed status. Defined if and only if the request was successful.
199 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
200 "errors": [ # The list of errors occurring in the feed.
201 { # An error occurring in the feed, like "invalid price".
202 "count": 42, # The number of occurrences of the error in the feed.
203 "message": "A String", # The error message, e.g., "Invalid price".
204 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
205 "examples": [ # A list of example occurrences of the error, grouped by product.
206 { # An example occurrence for a particular error.
207 "itemId": "A String", # The ID of the example item.
208 "value": "A String", # The problematic value.
209 "lineNumber": 42, # Line number in the data feed where the example is found.
210 },
211 ],
212 },
213 ],
214 "processingStatus": "A String", # The processing status of the feed.
215 "itemsTotal": 42, # The number of items in the feed that were processed.
216 "warnings": [ # The list of errors occurring in the feed.
217 { # An error occurring in the feed, like "invalid price".
218 "count": 42, # The number of occurrences of the error in the feed.
219 "message": "A String", # The error message, e.g., "Invalid price".
220 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
221 "examples": [ # A list of example occurrences of the error, grouped by product.
222 { # An example occurrence for a particular error.
223 "itemId": "A String", # The ID of the example item.
224 "value": "A String", # The problematic value.
225 "lineNumber": 42, # Line number in the data feed where the example is found.
226 },
227 ],
228 },
229 ],
230 "itemsValid": 42, # The number of items in the feed that were valid.
231 "datafeedId": "A String", # The ID of the feed for which the status is reported.
232 },
233 },
234 ],
235 }</pre>
236</div>
237
238<div class="method">
239 <code class="details" id="get">get(merchantId, datafeedId)</code>
240 <pre>Retrieves the status of a datafeed from your Merchant Center account.
241
242Args:
243 merchantId: string, A parameter (required)
244 datafeedId: string, A parameter (required)
245
246Returns:
247 An object of the form:
248
249 {
250 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
251 "errors": [ # The list of errors occurring in the feed.
252 { # An error occurring in the feed, like "invalid price".
253 "count": 42, # The number of occurrences of the error in the feed.
254 "message": "A String", # The error message, e.g., "Invalid price".
255 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
256 "examples": [ # A list of example occurrences of the error, grouped by product.
257 { # An example occurrence for a particular error.
258 "itemId": "A String", # The ID of the example item.
259 "value": "A String", # The problematic value.
260 "lineNumber": 42, # Line number in the data feed where the example is found.
261 },
262 ],
263 },
264 ],
265 "processingStatus": "A String", # The processing status of the feed.
266 "itemsTotal": 42, # The number of items in the feed that were processed.
267 "warnings": [ # The list of errors occurring in the feed.
268 { # An error occurring in the feed, like "invalid price".
269 "count": 42, # The number of occurrences of the error in the feed.
270 "message": "A String", # The error message, e.g., "Invalid price".
271 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
272 "examples": [ # A list of example occurrences of the error, grouped by product.
273 { # An example occurrence for a particular error.
274 "itemId": "A String", # The ID of the example item.
275 "value": "A String", # The problematic value.
276 "lineNumber": 42, # Line number in the data feed where the example is found.
277 },
278 ],
279 },
280 ],
281 "itemsValid": 42, # The number of items in the feed that were valid.
282 "datafeedId": "A String", # The ID of the feed for which the status is reported.
283 }</pre>
284</div>
285
286<div class="method">
287 <code class="details" id="list">list(merchantId)</code>
288 <pre>Lists the statuses of the datafeeds in your Merchant Center account.
289
290Args:
291 merchantId: string, A parameter (required)
292
293Returns:
294 An object of the form:
295
296 {
297 "kind": "content#datafeedstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".
298 "resources": [
299 {
300 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
301 "errors": [ # The list of errors occurring in the feed.
302 { # An error occurring in the feed, like "invalid price".
303 "count": 42, # The number of occurrences of the error in the feed.
304 "message": "A String", # The error message, e.g., "Invalid price".
305 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
306 "examples": [ # A list of example occurrences of the error, grouped by product.
307 { # An example occurrence for a particular error.
308 "itemId": "A String", # The ID of the example item.
309 "value": "A String", # The problematic value.
310 "lineNumber": 42, # Line number in the data feed where the example is found.
311 },
312 ],
313 },
314 ],
315 "processingStatus": "A String", # The processing status of the feed.
316 "itemsTotal": 42, # The number of items in the feed that were processed.
317 "warnings": [ # The list of errors occurring in the feed.
318 { # An error occurring in the feed, like "invalid price".
319 "count": 42, # The number of occurrences of the error in the feed.
320 "message": "A String", # The error message, e.g., "Invalid price".
321 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
322 "examples": [ # A list of example occurrences of the error, grouped by product.
323 { # An example occurrence for a particular error.
324 "itemId": "A String", # The ID of the example item.
325 "value": "A String", # The problematic value.
326 "lineNumber": 42, # Line number in the data feed where the example is found.
327 },
328 ],
329 },
330 ],
331 "itemsValid": 42, # The number of items in the feed that were valid.
332 "datafeedId": "A String", # The ID of the feed for which the status is reported.
333 },
334 ],
335 }</pre>
336</div>
337
338</body></html>