• 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.accountstatuses.html">accountstatuses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
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, accountId)</a></code></p>
82<p class="firstline">Retrieves the status of a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.</p>
83<p class="toc_element">
84  <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
85<p class="firstline">Lists the statuses of the sub-accounts in your Merchant Center account. This method can only be called for 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)</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    "entries": [ # The request entries to be processed in the batch.
100      { # A batch entry encoding a single non-batch accountstatuses request.
101        "batchId": 42, # An entry ID, unique within the batch request.
102        "method": "A String", # The method (get).
103        "merchantId": "A String", # The ID of the managing account.
104        "accountId": "A String", # The ID of the (sub-)account whose status to get.
105      },
106    ],
107  }
108
109
110Returns:
111  An object of the form:
112
113    {
114    "kind": "content#accountstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse".
115    "entries": [ # The result of the execution of the batch requests.
116      { # A batch entry encoding a single non-batch accountstatuses response.
117        "batchId": 42, # The ID of the request entry this entry responds to.
118        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
119          "message": "A String", # The message of the first error in errors.
120          "code": 42, # The HTTP status of the first error in errors.
121          "errors": [ # A list of errors.
122            { # An error returned by the API.
123              "reason": "A String", # The error code.
124              "domain": "A String", # The domain of the error.
125              "message": "A String", # A description of the error.
126            },
127          ],
128        },
129        "accountStatus": { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. # The requested account status. Defined if and only if the request was successful.
130          "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
131          "websiteClaimed": True or False, # Whether the account's website is claimed or not.
132          "dataQualityIssues": [ # A list of data quality issues.
133            {
134              "displayedValue": "A String", # Actual value displayed on the landing page.
135              "severity": "A String", # Severity of the problem.
136              "lastChecked": "A String", # Last time the account was checked for this issue.
137              "country": "A String", # Country for which this issue is reported.
138              "detail": "A String", # A more detailed description of the issue.
139              "submittedValue": "A String", # Submitted value that causes the issue.
140              "numItems": 42, # Number of items in the account found to have the said issue.
141              "location": "A String", # The attribute name that is relevant for the issue.
142              "id": "A String", # Issue identifier.
143              "exampleItems": [ # Example items featuring the issue.
144                { # An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
145                  "itemId": "A String", # Unique item ID as specified in the uploaded product data.
146                  "submittedValue": "A String", # The item value that was submitted.
147                  "link": "A String", # Landing page of the item.
148                  "valueOnLandingPage": "A String", # The actual value on the landing page.
149                  "title": "A String", # Title of the item.
150                },
151              ],
152            },
153          ],
154          "accountId": "A String", # The ID of the account for which the status is reported.
155        },
156      },
157    ],
158  }</pre>
159</div>
160
161<div class="method">
162    <code class="details" id="get">get(merchantId, accountId)</code>
163  <pre>Retrieves the status of a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
164
165Args:
166  merchantId: string, The ID of the managing account. (required)
167  accountId: string, The ID of the account. (required)
168
169Returns:
170  An object of the form:
171
172    { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
173    "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
174    "websiteClaimed": True or False, # Whether the account's website is claimed or not.
175    "dataQualityIssues": [ # A list of data quality issues.
176      {
177        "displayedValue": "A String", # Actual value displayed on the landing page.
178        "severity": "A String", # Severity of the problem.
179        "lastChecked": "A String", # Last time the account was checked for this issue.
180        "country": "A String", # Country for which this issue is reported.
181        "detail": "A String", # A more detailed description of the issue.
182        "submittedValue": "A String", # Submitted value that causes the issue.
183        "numItems": 42, # Number of items in the account found to have the said issue.
184        "location": "A String", # The attribute name that is relevant for the issue.
185        "id": "A String", # Issue identifier.
186        "exampleItems": [ # Example items featuring the issue.
187          { # An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
188            "itemId": "A String", # Unique item ID as specified in the uploaded product data.
189            "submittedValue": "A String", # The item value that was submitted.
190            "link": "A String", # Landing page of the item.
191            "valueOnLandingPage": "A String", # The actual value on the landing page.
192            "title": "A String", # Title of the item.
193          },
194        ],
195      },
196    ],
197    "accountId": "A String", # The ID of the account for which the status is reported.
198  }</pre>
199</div>
200
201<div class="method">
202    <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
203  <pre>Lists the statuses of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
204
205Args:
206  merchantId: string, The ID of the managing account. (required)
207  pageToken: string, The token returned by the previous request.
208  maxResults: integer, The maximum number of account statuses to return in the response, used for paging.
209
210Returns:
211  An object of the form:
212
213    {
214    "nextPageToken": "A String", # The token for the retrieval of the next page of account statuses.
215    "kind": "content#accountstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".
216    "resources": [
217      { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
218        "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus".
219        "websiteClaimed": True or False, # Whether the account's website is claimed or not.
220        "dataQualityIssues": [ # A list of data quality issues.
221          {
222            "displayedValue": "A String", # Actual value displayed on the landing page.
223            "severity": "A String", # Severity of the problem.
224            "lastChecked": "A String", # Last time the account was checked for this issue.
225            "country": "A String", # Country for which this issue is reported.
226            "detail": "A String", # A more detailed description of the issue.
227            "submittedValue": "A String", # Submitted value that causes the issue.
228            "numItems": 42, # Number of items in the account found to have the said issue.
229            "location": "A String", # The attribute name that is relevant for the issue.
230            "id": "A String", # Issue identifier.
231            "exampleItems": [ # Example items featuring the issue.
232              { # An example of an item that has poor data quality. An item value on the landing page differs from what is submitted, or conflicts with a policy.
233                "itemId": "A String", # Unique item ID as specified in the uploaded product data.
234                "submittedValue": "A String", # The item value that was submitted.
235                "link": "A String", # Landing page of the item.
236                "valueOnLandingPage": "A String", # The actual value on the landing page.
237                "title": "A String", # Title of the item.
238              },
239            ],
240          },
241        ],
242        "accountId": "A String", # The ID of the account for which the status is reported.
243      },
244    ],
245  }</pre>
246</div>
247
248<div class="method">
249    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
250  <pre>Retrieves the next page of results.
251
252Args:
253  previous_request: The request for the previous page. (required)
254  previous_response: The response from the request for the previous page. (required)
255
256Returns:
257  A request object that you can call 'execute()' on to request the next
258  page. Returns None if there are no more items in the collection.
259    </pre>
260</div>
261
262</body></html>