• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.productstatuses.html">productstatuses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#custombatch">custombatch(body, includeAttributes=None)</a></code></p>
79<p class="firstline">Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts.</p>
80<p class="toc_element">
81  <code><a href="#get">get(merchantId, productId, includeAttributes=None)</a></code></p>
82<p class="firstline">Gets the status of a product from your Merchant Center account. This method can only be called for non-multi-client accounts.</p>
83<p class="toc_element">
84  <code><a href="#list">list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None, includeAttributes=None)</a></code></p>
85<p class="firstline">Lists the statuses of the products in your Merchant Center account. This method can only be called for non-multi-client accounts.</p>
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>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="custombatch">custombatch(body, includeAttributes=None)</code>
92  <pre>Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts.
93
94Args:
95  body: object, The request body. (required)
96    The object takes the form of:
97
98{
99    "entries": [ # The request entries to be processed in the batch.
100      { # A batch entry encoding a single non-batch productstatuses request.
101        "batchId": 42, # An entry ID, unique within the batch request.
102        "productId": "A String", # The ID of the product whose status to get.
103        "merchantId": "A String", # The ID of the managing account.
104        "method": "A String",
105      },
106    ],
107  }
108
109  includeAttributes: boolean, Flag to include full product data in the results of this request. The default value is false.
110
111Returns:
112  An object of the form:
113
114    {
115    "kind": "content#productstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse".
116    "entries": [ # The result of the execution of the batch requests.
117      { # A batch entry encoding a single non-batch productstatuses response.
118        "batchId": 42, # The ID of the request entry this entry responds to.
119        "kind": "content#productstatusesCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry".
120        "errors": { # A list of errors returned by a failed batch entry. # A list of errors, if the request failed.
121          "message": "A String", # The message of the first error in errors.
122          "code": 42, # The HTTP status of the first error in errors.
123          "errors": [ # A list of errors.
124            { # An error returned by the API.
125              "reason": "A String", # The error code.
126              "domain": "A String", # The domain of the error.
127              "message": "A String", # A description of the error.
128            },
129          ],
130        },
131        "productStatus": { # The status of a product, i.e., information about a product computed asynchronously by the data quality analysis. # The requested product status. Only defined if the request was successful.
132          "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
133          "destinationStatuses": [ # The intended destinations for the product.
134            {
135              "approvalStatus": "A String", # The destination's approval status.
136              "destination": "A String", # The name of the destination
137              "intention": "A String", # Whether the destination is required, excluded, selected by default or should be validated.
138            },
139          ],
140          "title": "A String", # The title of the product.
141          "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
142          "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
143          "link": "A String", # The link to the product.
144          "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
145          "dataQualityIssues": [ # A list of data quality issues associated with the product.
146            {
147              "valueProvided": "A String", # The value the attribute had at time of evaluation.
148              "severity": "A String", # The severity of the data quality issue.
149              "timestamp": "A String", # The time stamp of the data quality issue.
150              "detail": "A String", # A more detailed error string.
151              "location": "A String", # The attribute name that is relevant for the issue.
152              "valueOnLandingPage": "A String", # The value of that attribute that was found on the landing page
153              "id": "A String", # The id of the data quality issue.
154              "fetchStatus": "A String", # The fetch status for landing_page_errors.
155            },
156          ],
157          "productId": "A String", # The id of the product for which status is reported.
158        },
159      },
160    ],
161  }</pre>
162</div>
163
164<div class="method">
165    <code class="details" id="get">get(merchantId, productId, includeAttributes=None)</code>
166  <pre>Gets the status of a product from your Merchant Center account. This method can only be called for non-multi-client accounts.
167
168Args:
169  merchantId: string, The ID of the managing account. (required)
170  productId: string, The ID of the product. (required)
171  includeAttributes: boolean, Flag to include full product data in the result of this get request. The default value is false.
172
173Returns:
174  An object of the form:
175
176    { # The status of a product, i.e., information about a product computed asynchronously by the data quality analysis.
177    "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
178    "destinationStatuses": [ # The intended destinations for the product.
179      {
180        "approvalStatus": "A String", # The destination's approval status.
181        "destination": "A String", # The name of the destination
182        "intention": "A String", # Whether the destination is required, excluded, selected by default or should be validated.
183      },
184    ],
185    "title": "A String", # The title of the product.
186    "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
187    "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
188    "link": "A String", # The link to the product.
189    "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
190    "dataQualityIssues": [ # A list of data quality issues associated with the product.
191      {
192        "valueProvided": "A String", # The value the attribute had at time of evaluation.
193        "severity": "A String", # The severity of the data quality issue.
194        "timestamp": "A String", # The time stamp of the data quality issue.
195        "detail": "A String", # A more detailed error string.
196        "location": "A String", # The attribute name that is relevant for the issue.
197        "valueOnLandingPage": "A String", # The value of that attribute that was found on the landing page
198        "id": "A String", # The id of the data quality issue.
199        "fetchStatus": "A String", # The fetch status for landing_page_errors.
200      },
201    ],
202    "productId": "A String", # The id of the product for which status is reported.
203  }</pre>
204</div>
205
206<div class="method">
207    <code class="details" id="list">list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None, includeAttributes=None)</code>
208  <pre>Lists the statuses of the products in your Merchant Center account. This method can only be called for non-multi-client accounts.
209
210Args:
211  merchantId: string, The ID of the managing account. (required)
212  includeInvalidInsertedItems: boolean, Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
213  pageToken: string, The token returned by the previous request.
214  maxResults: integer, The maximum number of product statuses to return in the response, used for paging.
215  includeAttributes: boolean, Flag to include full product data in the results of the list request. The default value is false.
216
217Returns:
218  An object of the form:
219
220    {
221    "nextPageToken": "A String", # The token for the retrieval of the next page of products statuses.
222    "kind": "content#productstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse".
223    "resources": [
224      { # The status of a product, i.e., information about a product computed asynchronously by the data quality analysis.
225        "googleExpirationDate": "A String", # Date on which the item expires in Google Shopping, in ISO 8601 format.
226        "destinationStatuses": [ # The intended destinations for the product.
227          {
228            "approvalStatus": "A String", # The destination's approval status.
229            "destination": "A String", # The name of the destination
230            "intention": "A String", # Whether the destination is required, excluded, selected by default or should be validated.
231          },
232        ],
233        "title": "A String", # The title of the product.
234        "kind": "content#productStatus", # Identifies what kind of resource this is. Value: the fixed string "content#productStatus".
235        "lastUpdateDate": "A String", # Date on which the item has been last updated, in ISO 8601 format.
236        "link": "A String", # The link to the product.
237        "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
238        "dataQualityIssues": [ # A list of data quality issues associated with the product.
239          {
240            "valueProvided": "A String", # The value the attribute had at time of evaluation.
241            "severity": "A String", # The severity of the data quality issue.
242            "timestamp": "A String", # The time stamp of the data quality issue.
243            "detail": "A String", # A more detailed error string.
244            "location": "A String", # The attribute name that is relevant for the issue.
245            "valueOnLandingPage": "A String", # The value of that attribute that was found on the landing page
246            "id": "A String", # The id of the data quality issue.
247            "fetchStatus": "A String", # The fetch status for landing_page_errors.
248          },
249        ],
250        "productId": "A String", # The id of the product for which status is reported.
251      },
252    ],
253  }</pre>
254</div>
255
256<div class="method">
257    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
258  <pre>Retrieves the next page of results.
259
260Args:
261  previous_request: The request for the previous page. (required)
262  previous_response: The response from the request for the previous page. (required)
263
264Returns:
265  A request object that you can call 'execute()' on to request the next
266  page. Returns None if there are no more items in the collection.
267    </pre>
268</div>
269
270</body></html>