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.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, name=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(previous_request, previous_response)</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 102Args: 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 125Returns: 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 "accountManagement": "A String", # How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 145 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" 146 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. 147 { 148 "channel": "A String", # The channel the data applies to. Acceptable values are: - "`local`" - "`online`" 149 "country": "A String", # The country the data applies to. 150 "destination": "A String", # The destination the data applies to. 151 "itemLevelIssues": [ # List of item-level issues. 152 { 153 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 154 "code": "A String", # The error code of the issue. 155 "description": "A String", # A short issue description in English. 156 "detail": "A String", # A detailed issue description in English. 157 "documentation": "A String", # The URL of a web page to help with resolving this issue. 158 "numItems": "A String", # Number of items with this issue. 159 "resolution": "A String", # Whether the issue can be resolved by the merchant. 160 "servability": "A String", # How this issue affects serving of the offer. 161 }, 162 ], 163 "statistics": { # Aggregated product statistics. 164 "active": "A String", # Number of active offers. 165 "disapproved": "A String", # Number of disapproved offers. 166 "expiring": "A String", # Number of expiring offers. 167 "pending": "A String", # Number of pending offers. 168 }, 169 }, 170 ], 171 "websiteClaimed": True or False, # Whether the account's website is claimed or not. 172 }, 173 "batchId": 42, # The ID of the request entry this entry responds to. 174 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. 175 "code": 42, # The HTTP status of the first error in `errors`. 176 "errors": [ # A list of errors. 177 { # An error returned by the API. 178 "domain": "A String", # The domain of the error. 179 "message": "A String", # A description of the error. 180 "reason": "A String", # The error code. 181 }, 182 ], 183 "message": "A String", # The message of the first error in `errors`. 184 }, 185 }, 186 ], 187 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountstatusesCustomBatchResponse`". 188}</pre> 189</div> 190 191<div class="method"> 192 <code class="details" id="get">get(merchantId, accountId, destinations=None, x__xgafv=None)</code> 193 <pre>Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. 194 195Args: 196 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) 197 accountId: string, The ID of the account. (required) 198 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated) 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. 208 "accountId": "A String", # The ID of the account for which the status is reported. 209 "accountLevelIssues": [ # A list of account level issues. 210 { 211 "country": "A String", # Country for which this issue is reported. 212 "destination": "A String", # The destination the issue applies to. If this field is empty then the issue applies to all available destinations. 213 "detail": "A String", # Additional details about the issue. 214 "documentation": "A String", # The URL of a web page to help resolving this issue. 215 "id": "A String", # Issue identifier. 216 "severity": "A String", # Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" 217 "title": "A String", # Short description of the issue. 218 }, 219 ], 220 "accountManagement": "A String", # How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 221 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" 222 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. 223 { 224 "channel": "A String", # The channel the data applies to. Acceptable values are: - "`local`" - "`online`" 225 "country": "A String", # The country the data applies to. 226 "destination": "A String", # The destination the data applies to. 227 "itemLevelIssues": [ # List of item-level issues. 228 { 229 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 230 "code": "A String", # The error code of the issue. 231 "description": "A String", # A short issue description in English. 232 "detail": "A String", # A detailed issue description in English. 233 "documentation": "A String", # The URL of a web page to help with resolving this issue. 234 "numItems": "A String", # Number of items with this issue. 235 "resolution": "A String", # Whether the issue can be resolved by the merchant. 236 "servability": "A String", # How this issue affects serving of the offer. 237 }, 238 ], 239 "statistics": { # Aggregated product statistics. 240 "active": "A String", # Number of active offers. 241 "disapproved": "A String", # Number of disapproved offers. 242 "expiring": "A String", # Number of expiring offers. 243 "pending": "A String", # Number of pending offers. 244 }, 245 }, 246 ], 247 "websiteClaimed": True or False, # Whether the account's website is claimed or not. 248}</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="list">list(merchantId, destinations=None, maxResults=None, name=None, pageToken=None, x__xgafv=None)</code> 253 <pre>Lists the statuses of the sub-accounts in your Merchant Center account. 254 255Args: 256 merchantId: string, The ID of the managing account. This must be a multi-client account. (required) 257 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated) 258 maxResults: integer, The maximum number of account statuses to return in the response, used for paging. 259 name: string, If set, only the accounts with the given name (case sensitive) will be returned. 260 pageToken: string, The token returned by the previous request. 261 x__xgafv: string, V1 error format. 262 Allowed values 263 1 - v1 error format 264 2 - v2 error format 265 266Returns: 267 An object of the form: 268 269 { 270 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountstatusesListResponse`". 271 "nextPageToken": "A String", # The token for the retrieval of the next page of account statuses. 272 "resources": [ 273 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. 274 "accountId": "A String", # The ID of the account for which the status is reported. 275 "accountLevelIssues": [ # A list of account level issues. 276 { 277 "country": "A String", # Country for which this issue is reported. 278 "destination": "A String", # The destination the issue applies to. If this field is empty then the issue applies to all available destinations. 279 "detail": "A String", # Additional details about the issue. 280 "documentation": "A String", # The URL of a web page to help resolving this issue. 281 "id": "A String", # Issue identifier. 282 "severity": "A String", # Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" 283 "title": "A String", # Short description of the issue. 284 }, 285 ], 286 "accountManagement": "A String", # How the account is managed. Acceptable values are: - "`manual`" - "`automatic`" 287 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" 288 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. 289 { 290 "channel": "A String", # The channel the data applies to. Acceptable values are: - "`local`" - "`online`" 291 "country": "A String", # The country the data applies to. 292 "destination": "A String", # The destination the data applies to. 293 "itemLevelIssues": [ # List of item-level issues. 294 { 295 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 296 "code": "A String", # The error code of the issue. 297 "description": "A String", # A short issue description in English. 298 "detail": "A String", # A detailed issue description in English. 299 "documentation": "A String", # The URL of a web page to help with resolving this issue. 300 "numItems": "A String", # Number of items with this issue. 301 "resolution": "A String", # Whether the issue can be resolved by the merchant. 302 "servability": "A String", # How this issue affects serving of the offer. 303 }, 304 ], 305 "statistics": { # Aggregated product statistics. 306 "active": "A String", # Number of active offers. 307 "disapproved": "A String", # Number of disapproved offers. 308 "expiring": "A String", # Number of expiring offers. 309 "pending": "A String", # Number of pending offers. 310 }, 311 }, 312 ], 313 "websiteClaimed": True or False, # Whether the account's website is claimed or not. 314 }, 315 ], 316}</pre> 317</div> 318 319<div class="method"> 320 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 321 <pre>Retrieves the next page of results. 322 323Args: 324 previous_request: The request for the previous page. (required) 325 previous_response: The response from the request for the previous page. (required) 326 327Returns: 328 A request object that you can call 'execute()' on to request the next 329 page. Returns None if there are no more items in the collection. 330 </pre> 331</div> 332 333</body></html>