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