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_1.html">Content API for Shopping</a> . <a href="content_v2_1.collectionstatuses.html">collectionstatuses</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="#get">get(merchantId, collectionId, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the status of a collection from your Merchant Center account.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists the statuses of the collections in your Merchant Center account.</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="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="get">get(merchantId, collectionId, x__xgafv=None)</code> 97 <pre>Gets the status of a collection from your Merchant Center account. 98 99Args: 100 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) 101 collectionId: string, Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection. (required) 102 x__xgafv: string, V1 error format. 103 Allowed values 104 1 - v1 error format 105 2 - v2 error format 106 107Returns: 108 An object of the form: 109 110 { # The collectionstatus message. 111 "collectionLevelIssuses": [ # A list of all issues associated with the collection. 112 { # Issue associated with the collection. 113 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 114 "code": "A String", # The error code of the issue. 115 "description": "A String", # A short issue description in English. 116 "destination": "A String", # The destination the issue applies to. 117 "detail": "A String", # A detailed issue description in English. 118 "documentation": "A String", # The URL of a web page to help with resolving this issue. 119 "resolution": "A String", # Whether the issue can be resolved by the merchant. 120 "servability": "A String", # How this issue affects the serving of the collection. 121 }, 122 ], 123 "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, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" 124 "destinationStatuses": [ # The intended destinations for the collection. 125 { # Destination status message. 126 "destination": "A String", # The name of the destination 127 "status": "A String", # The status for the specified destination. 128 }, 129 ], 130 "id": "A String", # Required. The ID of the collection for which status is reported. 131 "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, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" 132}</pre> 133</div> 134 135<div class="method"> 136 <code class="details" id="list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</code> 137 <pre>Lists the statuses of the collections in your Merchant Center account. 138 139Args: 140 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) 141 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. 142 pageToken: string, Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. 143 x__xgafv: string, V1 error format. 144 Allowed values 145 1 - v1 error format 146 2 - v2 error format 147 148Returns: 149 An object of the form: 150 151 { # Response message for the ListCollectionStatuses method. 152 "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. 153 "resources": [ # The collectionstatuses listed. 154 { # The collectionstatus message. 155 "collectionLevelIssuses": [ # A list of all issues associated with the collection. 156 { # Issue associated with the collection. 157 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 158 "code": "A String", # The error code of the issue. 159 "description": "A String", # A short issue description in English. 160 "destination": "A String", # The destination the issue applies to. 161 "detail": "A String", # A detailed issue description in English. 162 "documentation": "A String", # The URL of a web page to help with resolving this issue. 163 "resolution": "A String", # Whether the issue can be resolved by the merchant. 164 "servability": "A String", # How this issue affects the serving of the collection. 165 }, 166 ], 167 "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, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" 168 "destinationStatuses": [ # The intended destinations for the collection. 169 { # Destination status message. 170 "destination": "A String", # The name of the destination 171 "status": "A String", # The status for the specified destination. 172 }, 173 ], 174 "id": "A String", # Required. The ID of the collection for which status is reported. 175 "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, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" 176 }, 177 ], 178}</pre> 179</div> 180 181<div class="method"> 182 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 183 <pre>Retrieves the next page of results. 184 185Args: 186 previous_request: The request for the previous page. (required) 187 previous_response: The response from the request for the previous page. (required) 188 189Returns: 190 A request object that you can call 'execute()' on to request the next 191 page. Returns None if there are no more items in the collection. 192 </pre> 193</div> 194 195</body></html>