| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, 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 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, 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="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Retrieves multiple Merchant Center account statuses in a single request.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#get">get(merchantId, accountId, destinations=None, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list">list(merchantId, destinations=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Lists the statuses of the sub-accounts in your Merchant Center account.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#list_next">list_next()</a></code></p> |
| 91 |
<p class="firstline">Retrieves the next page of results.</p> |
| 92 |
<h3>Method Details</h3> |
| 93 |
<div class="method"> |
| 94 |
<code class="details" id="close">close()</code> |
| 95 |
<pre>Close httplib2 connections.</pre> |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method"> |
| 99 |
<code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code> |
| 100 |
<pre>Retrieves multiple Merchant Center account statuses in a single request. |
| 101 |
|
| 102 |
Args: |
| 103 |
body: object, The request body. |
| 104 |
The object takes the form of: |
| 105 |
|
| 106 |
{ |
| 107 |
"entries": [ # The request entries to be processed in the batch. |
| 108 |
{ # A batch entry encoding a single non-batch accountstatuses request. |
| 109 |
"accountId": "A String", # The ID of the (sub-)account whose status to get. |
| 110 |
"batchId": 42, # An entry ID, unique within the batch request. |
| 111 |
"destinations": [ # If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. |
| 112 |
"A String", |
| 113 |
], |
| 114 |
"merchantId": "A String", # The ID of the managing account. |
| 115 |
"method": "A String", # The method of the batch entry. Acceptable values are: - "`get`" |
| 116 |
}, |
| 117 |
], |
| 118 |
} |
| 119 |
|
| 120 |
x__xgafv: string, V1 error format. |
| 121 |
Allowed values |
| 122 |
1 - v1 error format |
| 123 |
2 - v2 error format |
| 124 |
|
| 125 |
Returns: |
| 126 |
An object of the form: |
| 127 |
|
| 128 |
{ |
| 129 |
"entries": [ # The result of the execution of the batch requests. |
| 130 |
{ # A batch entry encoding a single non-batch accountstatuses response. |
| 131 |
"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. |
| 132 |
"accountId": "A String", # The ID of the account for which the status is reported. |
| 133 |
"accountLevelIssues": [ # A list of account level issues. |
| 134 |
{ |
| 135 |
"country": "A String", # Country for which this issue is reported. |
| 136 |
"destination": "A String", # The destination the issue applies to. If this field is empty then the issue applies to all available destinations. |
| 137 |
"detail": "A String", # Additional details about the issue. |
| 138 |
"documentation": "A String", # The URL of a web page to help resolving this issue. |
| 139 |
"id": "A String", # Issue identifier. |
| 140 |
"severity": "A String", # Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" |
| 141 |
"title": "A String", # Short description of the issue. |
| 142 |
}, |
| 143 |
], |
| 144 |
"dataQualityIssues": [ # DEPRECATED - never populated. |
| 145 |
{ |
| 146 |
"country": "A String", |
| 147 |
"destination": "A String", |
| 148 |
"detail": "A String", |
| 149 |
"displayedValue": "A String", |
| 150 |
"exampleItems": [ |
| 151 |
{ |
| 152 |
"itemId": "A String", |
| 153 |
"link": "A String", |
| 154 |
"submittedValue": "A String", |
| 155 |
"title": "A String", |
| 156 |
"valueOnLandingPage": "A String", |
| 157 |
}, |
| 158 |
], |
| 159 |
"id": "A String", |
| 160 |
"lastChecked": "A String", |
| 161 |
"location": "A String", |
| 162 |
"numItems": 42, |
| 163 |
"severity": "A String", # Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" |
| 164 |
"submittedValue": "A String", |
| 165 |
}, |
| 166 |
], |
| 167 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" |
| 168 |
"products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. |
| 169 |
{ |
| 170 |
"channel": "A String", # The channel the data applies to. Acceptable values are: - "`local`" - "`online`" |
| 171 |
"country": "A String", # The country the data applies to. |
| 172 |
"destination": "A String", # The destination the data applies to. |
| 173 |
"itemLevelIssues": [ # List of item-level issues. |
| 174 |
{ |
| 175 |
"attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. |
| 176 |
"code": "A String", # The error code of the issue. |
| 177 |
"description": "A String", # A short issue description in English. |
| 178 |
"detail": "A String", # A detailed issue description in English. |
| 179 |
"documentation": "A String", # The URL of a web page to help with resolving this issue. |
| 180 |
"numItems": "A String", # Number of items with this issue. |
| 181 |
"resolution": "A String", # Whether the issue can be resolved by the merchant. |
| 182 |
"servability": "A String", # How this issue affects serving of the offer. |
| 183 |
}, |
| 184 |
], |
| 185 |
"statistics": { # Aggregated product statistics. |
| 186 |
"active": "A String", # Number of active offers. |
| 187 |
"disapproved": "A String", # Number of disapproved offers. |
| 188 |
"expiring": "A String", # Number of expiring offers. |
| 189 |
"pending": "A String", # Number of pending offers. |
| 190 |
}, |
| 191 |
}, |
| 192 |
], |
| 193 |
"websiteClaimed": True or False, # Whether the account's website is claimed or not. |
| 194 |
}, |
| 195 |
"batchId": 42, # The ID of the request entry this entry responds to. |
| 196 |
"errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. |
| 197 |
"code": 42, # The HTTP status of the first error in `errors`. |
| 198 |
"errors": [ # A list of errors. |
| 199 |
{ # An error returned by the API. |
| 200 |
"domain": "A String", # The domain of the error. |
| 201 |
"message": "A String", # A description of the error. |
| 202 |
"reason": "A String", # The error code. |
| 203 |
}, |
| 204 |
], |
| 205 |
"message": "A String", # The message of the first error in `errors`. |
| 206 |
}, |
| 207 |
}, |
| 208 |
], |
| 209 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse". |
| 210 |
}</pre> |
| 211 |
</div> |
| 212 |
|
| 213 |
<div class="method"> |
| 214 |
<code class="details" id="get">get(merchantId, accountId, destinations=None, x__xgafv=None)</code> |
| 215 |
<pre>Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. |
| 216 |
|
| 217 |
Args: |
| 218 |
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required) |
| 219 |
accountId: string, The ID of the account. (required) |
| 220 |
destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated) |
| 221 |
x__xgafv: string, V1 error format. |
| 222 |
Allowed values |
| 223 |
1 - v1 error format |
| 224 |
2 - v2 error format |
| 225 |
|
| 226 |
Returns: |
| 227 |
An object of the form: |
| 228 |
|
| 229 |
{ # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. |
| 230 |
"accountId": "A String", # The ID of the account for which the status is reported. |
| 231 |
"accountLevelIssues": [ # A list of account level issues. |
| 232 |
{ |
| 233 |
"country": "A String", # Country for which this issue is reported. |
| 234 |
"destination": "A String", # The destination the issue applies to. If this field is empty then the issue applies to all available destinations. |
| 235 |
"detail": "A String", # Additional details about the issue. |
| 236 |
"documentation": "A String", # The URL of a web page to help resolving this issue. |
| 237 |
"id": "A String", # Issue identifier. |
| 238 |
"severity": "A String", # Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" |
| 239 |
"title": "A String", # Short description of the issue. |
| 240 |
}, |
| 241 |
], |
| 242 |
"dataQualityIssues": [ # DEPRECATED - never populated. |
| 243 |
{ |
| 244 |
"country": "A String", |
| 245 |
"destination": "A String", |
| 246 |
"detail": "A String", |
| 247 |
"displayedValue": "A String", |
| 248 |
"exampleItems": [ |
| 249 |
{ |
| 250 |
"itemId": "A String", |
| 251 |
"link": "A String", |
| 252 |
"submittedValue": "A String", |
| 253 |
"title": "A String", |
| 254 |
"valueOnLandingPage": "A String", |
| 255 |
}, |
| 256 |
], |
| 257 |
"id": "A String", |
| 258 |
"lastChecked": "A String", |
| 259 |
"location": "A String", |
| 260 |
"numItems": 42, |
| 261 |
"severity": "A String", # Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" |
| 262 |
"submittedValue": "A String", |
| 263 |
}, |
| 264 |
], |
| 265 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" |
| 266 |
"products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. |
| 267 |
{ |
| 268 |
"channel": "A String", # The channel the data applies to. Acceptable values are: - "`local`" - "`online`" |
| 269 |
"country": "A String", # The country the data applies to. |
| 270 |
"destination": "A String", # The destination the data applies to. |
| 271 |
"itemLevelIssues": [ # List of item-level issues. |
| 272 |
{ |
| 273 |
"attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. |
| 274 |
"code": "A String", # The error code of the issue. |
| 275 |
"description": "A String", # A short issue description in English. |
| 276 |
"detail": "A String", # A detailed issue description in English. |
| 277 |
"documentation": "A String", # The URL of a web page to help with resolving this issue. |
| 278 |
"numItems": "A String", # Number of items with this issue. |
| 279 |
"resolution": "A String", # Whether the issue can be resolved by the merchant. |
| 280 |
"servability": "A String", # How this issue affects serving of the offer. |
| 281 |
}, |
| 282 |
], |
| 283 |
"statistics": { # Aggregated product statistics. |
| 284 |
"active": "A String", # Number of active offers. |
| 285 |
"disapproved": "A String", # Number of disapproved offers. |
| 286 |
"expiring": "A String", # Number of expiring offers. |
| 287 |
"pending": "A String", # Number of pending offers. |
| 288 |
}, |
| 289 |
}, |
| 290 |
], |
| 291 |
"websiteClaimed": True or False, # Whether the account's website is claimed or not. |
| 292 |
}</pre> |
| 293 |
</div> |
| 294 |
|
| 295 |
<div class="method"> |
| 296 |
<code class="details" id="list">list(merchantId, destinations=None, maxResults=None, pageToken=None, x__xgafv=None)</code> |
| 297 |
<pre>Lists the statuses of the sub-accounts in your Merchant Center account. |
| 298 |
|
| 299 |
Args: |
| 300 |
merchantId: string, The ID of the managing account. This must be a multi-client account. (required) |
| 301 |
destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated) |
| 302 |
maxResults: integer, The maximum number of account statuses to return in the response, used for paging. |
| 303 |
pageToken: string, The token returned by the previous request. |
| 304 |
x__xgafv: string, V1 error format. |
| 305 |
Allowed values |
| 306 |
1 - v1 error format |
| 307 |
2 - v2 error format |
| 308 |
|
| 309 |
Returns: |
| 310 |
An object of the form: |
| 311 |
|
| 312 |
{ |
| 313 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse". |
| 314 |
"nextPageToken": "A String", # The token for the retrieval of the next page of account statuses. |
| 315 |
"resources": [ |
| 316 |
{ # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. |
| 317 |
"accountId": "A String", # The ID of the account for which the status is reported. |
| 318 |
"accountLevelIssues": [ # A list of account level issues. |
| 319 |
{ |
| 320 |
"country": "A String", # Country for which this issue is reported. |
| 321 |
"destination": "A String", # The destination the issue applies to. If this field is empty then the issue applies to all available destinations. |
| 322 |
"detail": "A String", # Additional details about the issue. |
| 323 |
"documentation": "A String", # The URL of a web page to help resolving this issue. |
| 324 |
"id": "A String", # Issue identifier. |
| 325 |
"severity": "A String", # Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" |
| 326 |
"title": "A String", # Short description of the issue. |
| 327 |
}, |
| 328 |
], |
| 329 |
"dataQualityIssues": [ # DEPRECATED - never populated. |
| 330 |
{ |
| 331 |
"country": "A String", |
| 332 |
"destination": "A String", |
| 333 |
"detail": "A String", |
| 334 |
"displayedValue": "A String", |
| 335 |
"exampleItems": [ |
| 336 |
{ |
| 337 |
"itemId": "A String", |
| 338 |
"link": "A String", |
| 339 |
"submittedValue": "A String", |
| 340 |
"title": "A String", |
| 341 |
"valueOnLandingPage": "A String", |
| 342 |
}, |
| 343 |
], |
| 344 |
"id": "A String", |
| 345 |
"lastChecked": "A String", |
| 346 |
"location": "A String", |
| 347 |
"numItems": 42, |
| 348 |
"severity": "A String", # Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" |
| 349 |
"submittedValue": "A String", |
| 350 |
}, |
| 351 |
], |
| 352 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" |
| 353 |
"products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. |
| 354 |
{ |
| 355 |
"channel": "A String", # The channel the data applies to. Acceptable values are: - "`local`" - "`online`" |
| 356 |
"country": "A String", # The country the data applies to. |
| 357 |
"destination": "A String", # The destination the data applies to. |
| 358 |
"itemLevelIssues": [ # List of item-level issues. |
| 359 |
{ |
| 360 |
"attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. |
| 361 |
"code": "A String", # The error code of the issue. |
| 362 |
"description": "A String", # A short issue description in English. |
| 363 |
"detail": "A String", # A detailed issue description in English. |
| 364 |
"documentation": "A String", # The URL of a web page to help with resolving this issue. |
| 365 |
"numItems": "A String", # Number of items with this issue. |
| 366 |
"resolution": "A String", # Whether the issue can be resolved by the merchant. |
| 367 |
"servability": "A String", # How this issue affects serving of the offer. |
| 368 |
}, |
| 369 |
], |
| 370 |
"statistics": { # Aggregated product statistics. |
| 371 |
"active": "A String", # Number of active offers. |
| 372 |
"disapproved": "A String", # Number of disapproved offers. |
| 373 |
"expiring": "A String", # Number of expiring offers. |
| 374 |
"pending": "A String", # Number of pending offers. |
| 375 |
}, |
| 376 |
}, |
| 377 |
], |
| 378 |
"websiteClaimed": True or False, # Whether the account's website is claimed or not. |
| 379 |
}, |
| 380 |
], |
| 381 |
}</pre> |
| 382 |
</div> |
| 383 |
|
| 384 |
<div class="method"> |
| 385 |
<code class="details" id="list_next">list_next()</code> |
| 386 |
<pre>Retrieves the next page of results. |
| 387 |
|
| 388 |
Args: |
| 389 |
previous_request: The request for the previous page. (required) |
| 390 |
previous_response: The response from the request for the previous page. (required) |
| 391 |
|
| 392 |
Returns: |
| 393 |
A request object that you can call 'execute()' on to request the next |
| 394 |
page. Returns None if there are no more items in the collection. |
| 395 |
</pre> |
| 396 |
</div> |
| 397 |
|
| 398 |
</body></html> |