| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.collectionstatuses.html">collectionstatuses</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(merchantId, collectionId, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets the status of a collection from your Merchant Center account.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists the statuses of the collections in your Merchant Center account.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(merchantId, collectionId, x__xgafv=None)</code> | |
| <pre>Gets the status of a collection from your Merchant Center account. | |
| Args: | |
| merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) | |
| collectionId: string, Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # The collectionstatus message. | |
| "collectionLevelIssuses": [ # A list of all issues associated with the collection. | |
| { # Issue associated with the collection. | |
| "applicableCountries": [ # Country codes (ISO 3166-1 alpha-2) where issue applies to the offer. | |
| "A String", | |
| ], | |
| "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. | |
| "code": "A String", # The error code of the issue. | |
| "description": "A String", # A short issue description in English. | |
| "destination": "A String", # The destination the issue applies to. | |
| "detail": "A String", # A detailed issue description in English. | |
| "documentation": "A String", # The URL of a web page to help with resolving this issue. | |
| "resolution": "A String", # Whether the issue can be resolved by the merchant. | |
| "servability": "A String", # How this issue affects the serving of the collection. | |
| }, | |
| ], | |
| "creationDate": "A String", # Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" | |
| "destinationStatuses": [ # The intended destinations for the collection. | |
| { # Destination status message. | |
| "approvedCountries": [ # Country codes (ISO 3166-1 alpha-2) where the collection is approved. | |
| "A String", | |
| ], | |
| "destination": "A String", # The name of the destination | |
| "disapprovedCountries": [ # Country codes (ISO 3166-1 alpha-2) where the collection is disapproved. | |
| "A String", | |
| ], | |
| "pendingCountries": [ # Country codes (ISO 3166-1 alpha-2) where the collection is pending approval. | |
| "A String", | |
| ], | |
| "status": "A String", # The status for the specified destination in the collections target country. | |
| }, | |
| ], | |
| "id": "A String", # Required. The ID of the collection for which status is reported. | |
| "lastUpdateDate": "A String", # Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Lists the statuses of the collections in your Merchant Center account. | |
| Args: | |
| merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) | |
| pageSize: integer, The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000. | |
| pageToken: string, Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response message for the ListCollectionStatuses method. | |
| "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | |
| "resources": [ # The collectionstatuses listed. | |
| { # The collectionstatus message. | |
| "collectionLevelIssuses": [ # A list of all issues associated with the collection. | |
| { # Issue associated with the collection. | |
| "applicableCountries": [ # Country codes (ISO 3166-1 alpha-2) where issue applies to the offer. | |
| "A String", | |
| ], | |
| "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. | |
| "code": "A String", # The error code of the issue. | |
| "description": "A String", # A short issue description in English. | |
| "destination": "A String", # The destination the issue applies to. | |
| "detail": "A String", # A detailed issue description in English. | |
| "documentation": "A String", # The URL of a web page to help with resolving this issue. | |
| "resolution": "A String", # Whether the issue can be resolved by the merchant. | |
| "servability": "A String", # How this issue affects the serving of the collection. | |
| }, | |
| ], | |
| "creationDate": "A String", # Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" | |
| "destinationStatuses": [ # The intended destinations for the collection. | |
| { # Destination status message. | |
| "approvedCountries": [ # Country codes (ISO 3166-1 alpha-2) where the collection is approved. | |
| "A String", | |
| ], | |
| "destination": "A String", # The name of the destination | |
| "disapprovedCountries": [ # Country codes (ISO 3166-1 alpha-2) where the collection is disapproved. | |
| "A String", | |
| ], | |
| "pendingCountries": [ # Country codes (ISO 3166-1 alpha-2) where the collection is pending approval. | |
| "A String", | |
| ], | |
| "status": "A String", # The status for the specified destination in the collections target country. | |
| }, | |
| ], | |
| "id": "A String", # Required. The ID of the collection for which status is reported. | |
| "lastUpdateDate": "A String", # Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next()</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| </body></html> |