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">Retrieves multiple Merchant Center account statuses in a single request.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(merchantId, accountId, destinations=None)</a></code></p> 82<p class="firstline">Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None, destinations=None)</a></code></p> 85<p class="firstline">Lists the statuses of the sub-accounts 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="custombatch">custombatch(body)</code> 92 <pre>Retrieves multiple Merchant Center account statuses in a single request. 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 "destinations": [ # If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. 104 "A String", 105 ], 106 "merchantId": "A String", # The ID of the managing account. 107 "accountId": "A String", # The ID of the (sub-)account whose status to get. 108 }, 109 ], 110 } 111 112 113Returns: 114 An object of the form: 115 116 { 117 "kind": "content#accountstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse". 118 "entries": [ # The result of the execution of the batch requests. 119 { # A batch entry encoding a single non-batch accountstatuses response. 120 "batchId": 42, # The ID of the request entry this entry responds to. 121 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. 122 "message": "A String", # The message of the first error in errors. 123 "code": 42, # The HTTP status of the first error in errors. 124 "errors": [ # A list of errors. 125 { # An error returned by the API. 126 "reason": "A String", # The error code. 127 "domain": "A String", # The domain of the error. 128 "message": "A String", # A description of the error. 129 }, 130 ], 131 }, 132 "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. 133 "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". 134 "websiteClaimed": True or False, # Whether the account's website is claimed or not. 135 "accountLevelIssues": [ # A list of account level issues. 136 { 137 "documentation": "A String", # The URL of a web page to help resolving this issue. 138 "severity": "A String", # Severity of the issue. 139 "title": "A String", # Short description of the issue. 140 "country": "A String", # Country for which this issue is reported. 141 "destination": "A String", # The destination the issue applies to. 142 "detail": "A String", # Additional details about the issue. 143 "id": "A String", # Issue identifier. 144 }, 145 ], 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 "country": "A String", # The country the data applies to. 149 "itemLevelIssues": [ # List of item-level issues. 150 { 151 "code": "A String", # The error code of the issue. 152 "description": "A String", # A short issue description in English. 153 "documentation": "A String", # The URL of a web page to help with resolving this issue. 154 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 155 "detail": "A String", # A detailed issue description in English. 156 "numItems": "A String", # Number of items with this issue. 157 "servability": "A String", # How this issue affects serving of the offer. 158 "resolution": "A String", # Whether the issue can be resolved by the merchant. 159 }, 160 ], 161 "destination": "A String", # The destination the data applies to. 162 "channel": "A String", # The channel the data applies to. 163 "statistics": { # Aggregated product statistics. 164 "active": "A String", # Number of active offers. 165 "expiring": "A String", # Number of expiring offers. 166 "disapproved": "A String", # Number of disapproved offers. 167 "pending": "A String", # Number of pending offers. 168 }, 169 }, 170 ], 171 "dataQualityIssues": [ # DEPRECATED - never populated. 172 { 173 "displayedValue": "A String", 174 "severity": "A String", 175 "lastChecked": "A String", 176 "country": "A String", 177 "destination": "A String", 178 "detail": "A String", 179 "submittedValue": "A String", 180 "numItems": 42, 181 "location": "A String", 182 "id": "A String", 183 "exampleItems": [ 184 { 185 "itemId": "A String", 186 "submittedValue": "A String", 187 "link": "A String", 188 "valueOnLandingPage": "A String", 189 "title": "A String", 190 }, 191 ], 192 }, 193 ], 194 "accountId": "A String", # The ID of the account for which the status is reported. 195 }, 196 }, 197 ], 198 }</pre> 199</div> 200 201<div class="method"> 202 <code class="details" id="get">get(merchantId, accountId, destinations=None)</code> 203 <pre>Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. 204 205Args: 206 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) 207 accountId: string, The ID of the account. (required) 208 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated) 209 210Returns: 211 An object of the form: 212 213 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. 214 "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". 215 "websiteClaimed": True or False, # Whether the account's website is claimed or not. 216 "accountLevelIssues": [ # A list of account level issues. 217 { 218 "documentation": "A String", # The URL of a web page to help resolving this issue. 219 "severity": "A String", # Severity of the issue. 220 "title": "A String", # Short description of the issue. 221 "country": "A String", # Country for which this issue is reported. 222 "destination": "A String", # The destination the issue applies to. 223 "detail": "A String", # Additional details about the issue. 224 "id": "A String", # Issue identifier. 225 }, 226 ], 227 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. 228 { 229 "country": "A String", # The country the data applies to. 230 "itemLevelIssues": [ # List of item-level issues. 231 { 232 "code": "A String", # The error code of the issue. 233 "description": "A String", # A short issue description in English. 234 "documentation": "A String", # The URL of a web page to help with resolving this issue. 235 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 236 "detail": "A String", # A detailed issue description in English. 237 "numItems": "A String", # Number of items with this issue. 238 "servability": "A String", # How this issue affects serving of the offer. 239 "resolution": "A String", # Whether the issue can be resolved by the merchant. 240 }, 241 ], 242 "destination": "A String", # The destination the data applies to. 243 "channel": "A String", # The channel the data applies to. 244 "statistics": { # Aggregated product statistics. 245 "active": "A String", # Number of active offers. 246 "expiring": "A String", # Number of expiring offers. 247 "disapproved": "A String", # Number of disapproved offers. 248 "pending": "A String", # Number of pending offers. 249 }, 250 }, 251 ], 252 "dataQualityIssues": [ # DEPRECATED - never populated. 253 { 254 "displayedValue": "A String", 255 "severity": "A String", 256 "lastChecked": "A String", 257 "country": "A String", 258 "destination": "A String", 259 "detail": "A String", 260 "submittedValue": "A String", 261 "numItems": 42, 262 "location": "A String", 263 "id": "A String", 264 "exampleItems": [ 265 { 266 "itemId": "A String", 267 "submittedValue": "A String", 268 "link": "A String", 269 "valueOnLandingPage": "A String", 270 "title": "A String", 271 }, 272 ], 273 }, 274 ], 275 "accountId": "A String", # The ID of the account for which the status is reported. 276 }</pre> 277</div> 278 279<div class="method"> 280 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None, destinations=None)</code> 281 <pre>Lists the statuses of the sub-accounts in your Merchant Center account. 282 283Args: 284 merchantId: string, The ID of the managing account. This must be a multi-client account. (required) 285 pageToken: string, The token returned by the previous request. 286 maxResults: integer, The maximum number of account statuses to return in the response, used for paging. 287 destinations: string, If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. (repeated) 288 289Returns: 290 An object of the form: 291 292 { 293 "nextPageToken": "A String", # The token for the retrieval of the next page of account statuses. 294 "kind": "content#accountstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse". 295 "resources": [ 296 { # The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time. 297 "kind": "content#accountStatus", # Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". 298 "websiteClaimed": True or False, # Whether the account's website is claimed or not. 299 "accountLevelIssues": [ # A list of account level issues. 300 { 301 "documentation": "A String", # The URL of a web page to help resolving this issue. 302 "severity": "A String", # Severity of the issue. 303 "title": "A String", # Short description of the issue. 304 "country": "A String", # Country for which this issue is reported. 305 "destination": "A String", # The destination the issue applies to. 306 "detail": "A String", # Additional details about the issue. 307 "id": "A String", # Issue identifier. 308 }, 309 ], 310 "products": [ # List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes. 311 { 312 "country": "A String", # The country the data applies to. 313 "itemLevelIssues": [ # List of item-level issues. 314 { 315 "code": "A String", # The error code of the issue. 316 "description": "A String", # A short issue description in English. 317 "documentation": "A String", # The URL of a web page to help with resolving this issue. 318 "attributeName": "A String", # The attribute's name, if the issue is caused by a single attribute. 319 "detail": "A String", # A detailed issue description in English. 320 "numItems": "A String", # Number of items with this issue. 321 "servability": "A String", # How this issue affects serving of the offer. 322 "resolution": "A String", # Whether the issue can be resolved by the merchant. 323 }, 324 ], 325 "destination": "A String", # The destination the data applies to. 326 "channel": "A String", # The channel the data applies to. 327 "statistics": { # Aggregated product statistics. 328 "active": "A String", # Number of active offers. 329 "expiring": "A String", # Number of expiring offers. 330 "disapproved": "A String", # Number of disapproved offers. 331 "pending": "A String", # Number of pending offers. 332 }, 333 }, 334 ], 335 "dataQualityIssues": [ # DEPRECATED - never populated. 336 { 337 "displayedValue": "A String", 338 "severity": "A String", 339 "lastChecked": "A String", 340 "country": "A String", 341 "destination": "A String", 342 "detail": "A String", 343 "submittedValue": "A String", 344 "numItems": 42, 345 "location": "A String", 346 "id": "A String", 347 "exampleItems": [ 348 { 349 "itemId": "A String", 350 "submittedValue": "A String", 351 "link": "A String", 352 "valueOnLandingPage": "A String", 353 "title": "A String", 354 }, 355 ], 356 }, 357 ], 358 "accountId": "A String", # The ID of the account for which the status is reported. 359 }, 360 ], 361 }</pre> 362</div> 363 364<div class="method"> 365 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 366 <pre>Retrieves the next page of results. 367 368Args: 369 previous_request: The request for the previous page. (required) 370 previous_response: The response from the request for the previous page. (required) 371 372Returns: 373 A request object that you can call 'execute()' on to request the next 374 page. Returns None if there are no more items in the collection. 375 </pre> 376</div> 377 378</body></html>