Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0e5b9bfd8a498fec87ed1237a0ed383f9329ed8f / . / docs / dyn / content_v2.datafeedstatuses.html
blob: 664415669bb82cf4ef4d9686751ae7db28070d9c [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">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]78 <code><a href="#custombatch">custombatch(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="#get">get(merchantId, datafeedId)</a></code></p>
82<p class="firstline">Retrieves the status of a datafeed from your Merchant Center account.</p>
83<p class="toc_element">
84 <code><a href="#list">list(merchantId)</a></code></p>
85<p class="firstline">Lists the statuses of the datafeeds in your Merchant Center account.</p>
86<h3>Method Details</h3>
87<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]88 <code class="details" id="custombatch">custombatch(body)</code>
89 <pre>A description of how to use this function
90
91Args:
92 body: object, The request body. (required)
93 The object takes the form of:
94
95{
96 "entries": [
97 { # A batch entry encoding a single non-batch request to the datafeedstatuses service of the Content API for Shopping.
98 "batchId": 42, # An entry ID, unique within the batch request.
99 "datafeedId": "A String", # The ID of the data feed to get or delete.
100 "merchantId": "A String", # The ID of the managing account.
101 "method": "A String", # The method (get).
102 },
103 ],
104 }
105
106
107Returns:
108 An object of the form:
109
110 {
111 "kind": "content#datafeedstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".
112 "entries": [
113 { # A batch entry encoding a single non-batch response from the datafeedstatuses service of the Content API for Shopping.
114 "batchId": 42, # The ID of the request entry this entry responds to.
115 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
116 "message": "A String", # The message of the first error in errors.
117 "code": 42, # The HTTP status of the first error in errors.
118 "errors": [ # A list of errors.
119 { # An error returned by the API.
120 "reason": "A String", # The error code.
121 "domain": "A String", # The domain of the error.
122 "message": "A String", # A description of the error.
123 },
124 ],
125 },
126 "datafeedStatus": { # The requested data feed status. Defined if and only if the request was successful.
127 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
128 "errors": [ # The list of errors occurring in the feed.
129 { # An error occurring in the feed, like "invalid price".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]130 "count": "A String", # The number of occurrences of the error in the feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]131 "message": "A String", # The error message, e.g., "Invalid price".
132 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
133 "examples": [ # A list of example occurrences of the error, grouped by product.
134 { # An example occurrence for a particular error.
135 "itemId": "A String", # The ID of the example item.
136 "value": "A String", # The problematic value.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]137 "lineNumber": "A String", # Line number in the data feed where the example is found.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]138 },
139 ],
140 },
141 ],
142 "processingStatus": "A String", # The processing status of the feed.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]143 "itemsTotal": "A String", # The number of items in the feed that were processed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]144 "warnings": [ # The list of errors occurring in the feed.
145 { # An error occurring in the feed, like "invalid price".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]146 "count": "A String", # The number of occurrences of the error in the feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]147 "message": "A String", # The error message, e.g., "Invalid price".
148 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
149 "examples": [ # A list of example occurrences of the error, grouped by product.
150 { # An example occurrence for a particular error.
151 "itemId": "A String", # The ID of the example item.
152 "value": "A String", # The problematic value.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]153 "lineNumber": "A String", # Line number in the data feed where the example is found.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]154 },
155 ],
156 },
157 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]158 "itemsValid": "A String", # The number of items in the feed that were valid.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]159 "datafeedId": "A String", # The ID of the feed for which the status is reported.
160 },
161 },
162 ],
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="get">get(merchantId, datafeedId)</code>
168 <pre>Retrieves the status of a datafeed from your Merchant Center account.
169
170Args:
171 merchantId: string, A parameter (required)
172 datafeedId: string, A parameter (required)
173
174Returns:
175 An object of the form:
176
177 {
178 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
179 "errors": [ # The list of errors occurring in the feed.
180 { # An error occurring in the feed, like "invalid price".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]181 "count": "A String", # The number of occurrences of the error in the feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 "message": "A String", # The error message, e.g., "Invalid price".
183 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
184 "examples": [ # A list of example occurrences of the error, grouped by product.
185 { # An example occurrence for a particular error.
186 "itemId": "A String", # The ID of the example item.
187 "value": "A String", # The problematic value.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]188 "lineNumber": "A String", # Line number in the data feed where the example is found.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]189 },
190 ],
191 },
192 ],
193 "processingStatus": "A String", # The processing status of the feed.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]194 "itemsTotal": "A String", # The number of items in the feed that were processed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]195 "warnings": [ # The list of errors occurring in the feed.
196 { # An error occurring in the feed, like "invalid price".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]197 "count": "A String", # The number of occurrences of the error in the feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]198 "message": "A String", # The error message, e.g., "Invalid price".
199 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
200 "examples": [ # A list of example occurrences of the error, grouped by product.
201 { # An example occurrence for a particular error.
202 "itemId": "A String", # The ID of the example item.
203 "value": "A String", # The problematic value.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]204 "lineNumber": "A String", # Line number in the data feed where the example is found.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]205 },
206 ],
207 },
208 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]209 "itemsValid": "A String", # The number of items in the feed that were valid.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]210 "datafeedId": "A String", # The ID of the feed for which the status is reported.
211 }</pre>
212</div>
213
214<div class="method">
215 <code class="details" id="list">list(merchantId)</code>
216 <pre>Lists the statuses of the datafeeds in your Merchant Center account.
217
218Args:
219 merchantId: string, A parameter (required)
220
221Returns:
222 An object of the form:
223
224 {
225 "kind": "content#datafeedstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".
226 "resources": [
227 {
228 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
229 "errors": [ # The list of errors occurring in the feed.
230 { # An error occurring in the feed, like "invalid price".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]231 "count": "A String", # The number of occurrences of the error in the feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]232 "message": "A String", # The error message, e.g., "Invalid price".
233 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
234 "examples": [ # A list of example occurrences of the error, grouped by product.
235 { # An example occurrence for a particular error.
236 "itemId": "A String", # The ID of the example item.
237 "value": "A String", # The problematic value.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]238 "lineNumber": "A String", # Line number in the data feed where the example is found.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]239 },
240 ],
241 },
242 ],
243 "processingStatus": "A String", # The processing status of the feed.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]244 "itemsTotal": "A String", # The number of items in the feed that were processed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]245 "warnings": [ # The list of errors occurring in the feed.
246 { # An error occurring in the feed, like "invalid price".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]247 "count": "A String", # The number of occurrences of the error in the feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]248 "message": "A String", # The error message, e.g., "Invalid price".
249 "code": "A String", # The code of the error, e.g., "validation/invalid_value".
250 "examples": [ # A list of example occurrences of the error, grouped by product.
251 { # An example occurrence for a particular error.
252 "itemId": "A String", # The ID of the example item.
253 "value": "A String", # The problematic value.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]254 "lineNumber": "A String", # Line number in the data feed where the example is found.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]255 },
256 ],
257 },
258 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]259 "itemsValid": "A String", # The number of items in the feed that were valid.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260 "datafeedId": "A String", # The ID of the feed for which the status is reported.
261 },
262 ],
263 }</pre>
264</div>
265
266</body></html>