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.datafeedstatuses.html">datafeedstatuses</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">Gets multiple Merchant Center datafeed statuses in a single request.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 84 | <code><a href="#get">get(merchantId, datafeedId, country=None, language=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 datafeed from your Merchant Center account.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 87 | <code><a href="#list">list(merchantId, maxResults=None, pageToken=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 datafeeds in your Merchant Center account.</p> |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [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> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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>Gets multiple Merchant Center datafeed 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 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 107 | "entries": [ # The request entries to be processed in the batch. |
| 108 | { # A batch entry encoding a single non-batch datafeedstatuses request. |
| 109 | "batchId": 42, # An entry ID, unique within the batch request. |
| 110 | "country": "A String", # The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required. |
| 111 | "datafeedId": "A String", # The ID of the data feed to get. |
| 112 | "language": "A String", # The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required. |
| 113 | "merchantId": "A String", # The ID of the managing account. |
| 114 | "method": "A String", # The method of the batch entry. Acceptable values are: - "`get`" |
| 115 | }, |
| 116 | ], |
| 117 | } |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 118 | |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 119 | x__xgafv: string, V1 error format. |
| 120 | Allowed values |
| 121 | 1 - v1 error format |
| 122 | 2 - v2 error format |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 123 | |
| 124 | Returns: |
| 125 | An object of the form: |
| 126 | |
| 127 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 128 | "entries": [ # The result of the execution of the batch requests. |
| 129 | { # A batch entry encoding a single non-batch datafeedstatuses response. |
| 130 | "batchId": 42, # The ID of the request entry this entry responds to. |
| 131 | "datafeedStatus": { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. # The requested data feed status. Defined if and only if the request was successful. |
| 132 | "country": "A String", # The country for which the status is reported, represented as a CLDR territory code. |
| 133 | "datafeedId": "A String", # The ID of the feed for which the status is reported. |
| 134 | "errors": [ # The list of errors occurring in the feed. |
| 135 | { # An error occurring in the feed, like "invalid price". |
| 136 | "code": "A String", # The code of the error, e.g., "validation/invalid_value". |
| 137 | "count": "A String", # The number of occurrences of the error in the feed. |
| 138 | "examples": [ # A list of example occurrences of the error, grouped by product. |
| 139 | { # An example occurrence for a particular error. |
| 140 | "itemId": "A String", # The ID of the example item. |
| 141 | "lineNumber": "A String", # Line number in the data feed where the example is found. |
| 142 | "value": "A String", # The problematic value. |
| 143 | }, |
| 144 | ], |
| 145 | "message": "A String", # The error message, e.g., "Invalid price". |
| 146 | }, |
| 147 | ], |
| 148 | "itemsTotal": "A String", # The number of items in the feed that were processed. |
| 149 | "itemsValid": "A String", # The number of items in the feed that were valid. |
| 150 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`" |
| 151 | "language": "A String", # The two-letter ISO 639-1 language for which the status is reported. |
| 152 | "lastUploadDate": "A String", # The last date at which the feed was uploaded. |
| 153 | "processingStatus": "A String", # The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors. |
| 154 | "warnings": [ # The list of errors occurring in the feed. |
| 155 | { # An error occurring in the feed, like "invalid price". |
| 156 | "code": "A String", # The code of the error, e.g., "validation/invalid_value". |
| 157 | "count": "A String", # The number of occurrences of the error in the feed. |
| 158 | "examples": [ # A list of example occurrences of the error, grouped by product. |
| 159 | { # An example occurrence for a particular error. |
| 160 | "itemId": "A String", # The ID of the example item. |
| 161 | "lineNumber": "A String", # Line number in the data feed where the example is found. |
| 162 | "value": "A String", # The problematic value. |
| 163 | }, |
| 164 | ], |
| 165 | "message": "A String", # The error message, e.g., "Invalid price". |
| 166 | }, |
| 167 | ], |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 168 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 169 | "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. |
| 170 | "code": 42, # The HTTP status of the first error in `errors`. |
| 171 | "errors": [ # A list of errors. |
| 172 | { # An error returned by the API. |
| 173 | "domain": "A String", # The domain of the error. |
| 174 | "message": "A String", # A description of the error. |
| 175 | "reason": "A String", # The error code. |
| 176 | }, |
| 177 | ], |
| 178 | "message": "A String", # The message of the first error in `errors`. |
| 179 | }, |
| 180 | }, |
| 181 | ], |
| 182 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse". |
| 183 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 184 | </div> |
| 185 | |
| 186 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 187 | <code class="details" id="get">get(merchantId, datafeedId, country=None, language=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 188 | <pre>Retrieves the status of a datafeed from your Merchant Center account. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 189 | |
| 190 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 191 | merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required) |
| 192 | datafeedId: string, The ID of the datafeed. (required) |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 193 | country: string, The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 194 | language: string, The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 195 | x__xgafv: string, V1 error format. |
| 196 | Allowed values |
| 197 | 1 - v1 error format |
| 198 | 2 - v2 error format |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 199 | |
| 200 | Returns: |
| 201 | An object of the form: |
| 202 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 203 | { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 204 | "country": "A String", # The country for which the status is reported, represented as a CLDR territory code. |
| 205 | "datafeedId": "A String", # The ID of the feed for which the status is reported. |
| 206 | "errors": [ # The list of errors occurring in the feed. |
| 207 | { # An error occurring in the feed, like "invalid price". |
| 208 | "code": "A String", # The code of the error, e.g., "validation/invalid_value". |
| 209 | "count": "A String", # The number of occurrences of the error in the feed. |
| 210 | "examples": [ # A list of example occurrences of the error, grouped by product. |
| 211 | { # An example occurrence for a particular error. |
| 212 | "itemId": "A String", # The ID of the example item. |
| 213 | "lineNumber": "A String", # Line number in the data feed where the example is found. |
| 214 | "value": "A String", # The problematic value. |
| 215 | }, |
| 216 | ], |
| 217 | "message": "A String", # The error message, e.g., "Invalid price". |
| 218 | }, |
| 219 | ], |
| 220 | "itemsTotal": "A String", # The number of items in the feed that were processed. |
| 221 | "itemsValid": "A String", # The number of items in the feed that were valid. |
| 222 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`" |
| 223 | "language": "A String", # The two-letter ISO 639-1 language for which the status is reported. |
| 224 | "lastUploadDate": "A String", # The last date at which the feed was uploaded. |
| 225 | "processingStatus": "A String", # The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors. |
| 226 | "warnings": [ # The list of errors occurring in the feed. |
| 227 | { # An error occurring in the feed, like "invalid price". |
| 228 | "code": "A String", # The code of the error, e.g., "validation/invalid_value". |
| 229 | "count": "A String", # The number of occurrences of the error in the feed. |
| 230 | "examples": [ # A list of example occurrences of the error, grouped by product. |
| 231 | { # An example occurrence for a particular error. |
| 232 | "itemId": "A String", # The ID of the example item. |
| 233 | "lineNumber": "A String", # Line number in the data feed where the example is found. |
| 234 | "value": "A String", # The problematic value. |
| 235 | }, |
| 236 | ], |
| 237 | "message": "A String", # The error message, e.g., "Invalid price". |
| 238 | }, |
| 239 | ], |
| 240 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 241 | </div> |
| 242 | |
| 243 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 244 | <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 245 | <pre>Lists the statuses of the datafeeds in your Merchant Center account. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 246 | |
| 247 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 248 | merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required) |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 249 | maxResults: integer, The maximum number of products to return in the response, used for paging. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 250 | pageToken: string, The token returned by the previous request. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 251 | x__xgafv: string, V1 error format. |
| 252 | Allowed values |
| 253 | 1 - v1 error format |
| 254 | 2 - v2 error format |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 255 | |
| 256 | Returns: |
| 257 | An object of the form: |
| 258 | |
| 259 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 260 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse". |
| 261 | "nextPageToken": "A String", # The token for the retrieval of the next page of datafeed statuses. |
| 262 | "resources": [ |
| 263 | { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. |
| 264 | "country": "A String", # The country for which the status is reported, represented as a CLDR territory code. |
| 265 | "datafeedId": "A String", # The ID of the feed for which the status is reported. |
| 266 | "errors": [ # The list of errors occurring in the feed. |
| 267 | { # An error occurring in the feed, like "invalid price". |
| 268 | "code": "A String", # The code of the error, e.g., "validation/invalid_value". |
| 269 | "count": "A String", # The number of occurrences of the error in the feed. |
| 270 | "examples": [ # A list of example occurrences of the error, grouped by product. |
| 271 | { # An example occurrence for a particular error. |
| 272 | "itemId": "A String", # The ID of the example item. |
| 273 | "lineNumber": "A String", # Line number in the data feed where the example is found. |
| 274 | "value": "A String", # The problematic value. |
| 275 | }, |
| 276 | ], |
| 277 | "message": "A String", # The error message, e.g., "Invalid price". |
| 278 | }, |
| 279 | ], |
| 280 | "itemsTotal": "A String", # The number of items in the feed that were processed. |
| 281 | "itemsValid": "A String", # The number of items in the feed that were valid. |
| 282 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`" |
| 283 | "language": "A String", # The two-letter ISO 639-1 language for which the status is reported. |
| 284 | "lastUploadDate": "A String", # The last date at which the feed was uploaded. |
| 285 | "processingStatus": "A String", # The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors. |
| 286 | "warnings": [ # The list of errors occurring in the feed. |
| 287 | { # An error occurring in the feed, like "invalid price". |
| 288 | "code": "A String", # The code of the error, e.g., "validation/invalid_value". |
| 289 | "count": "A String", # The number of occurrences of the error in the feed. |
| 290 | "examples": [ # A list of example occurrences of the error, grouped by product. |
| 291 | { # An example occurrence for a particular error. |
| 292 | "itemId": "A String", # The ID of the example item. |
| 293 | "lineNumber": "A String", # Line number in the data feed where the example is found. |
| 294 | "value": "A String", # The problematic value. |
| 295 | }, |
| 296 | ], |
| 297 | "message": "A String", # The error message, e.g., "Invalid price". |
| 298 | }, |
| 299 | ], |
| 300 | }, |
| 301 | ], |
| 302 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 303 | </div> |
| 304 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 305 | <div class="method"> |
| 306 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 307 | <pre>Retrieves the next page of results. |
| 308 | |
| 309 | Args: |
| 310 | previous_request: The request for the previous page. (required) |
| 311 | previous_response: The response from the request for the previous page. (required) |
| 312 | |
| 313 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 314 | A request object that you can call 'execute()' on to request the next |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 315 | page. Returns None if there are no more items in the collection. |
| 316 | </pre> |
| 317 | </div> |
| 318 | |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 319 | </body></html> |