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"> 78 <code><a href="#custombatch">custombatch(body)</a></code></p> 79 <p class="firstline">A description of how to use this function</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(merchantId, datafeedId)</a></code></p> 82 <p class="firstline">Retrieves the status of a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.</p> 83 <p class="toc_element"> 84 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p> 85 <p class="firstline">Lists the statuses of the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.</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>A description of how to use this function 93 94 Args: 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 datafeedstatuses request. 101 "batchId": 42, # An entry ID, unique within the batch request. 102 "datafeedId": "A String", # The ID of the data feed to get or delete. 103 "merchantId": "A String", # The ID of the managing account. 104 "method": "A String", 105 }, 106 ], 107 } 108 109 110 Returns: 111 An object of the form: 112 113 { 114 "kind": "content#datafeedstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse". 115 "entries": [ # The result of the execution of the batch requests. 116 { # A batch entry encoding a single non-batch datafeedstatuses response. 117 "batchId": 42, # The ID of the request entry this entry responds to. 118 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. 119 "message": "A String", # The message of the first error in errors. 120 "code": 42, # The HTTP status of the first error in errors. 121 "errors": [ # A list of errors. 122 { # An error returned by the API. 123 "reason": "A String", # The error code. 124 "domain": "A String", # The domain of the error. 125 "message": "A String", # A description of the error. 126 }, 127 ], 128 }, 129 "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. 130 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". 131 "errors": [ # The list of errors occurring in the feed. 132 { # An error occurring in the feed, like "invalid price". 133 "count": "A String", # The number of occurrences of the error in the feed. 134 "message": "A String", # The error message, e.g., "Invalid price". 135 "code": "A String", # The code of the error, e.g., "validation/invalid_value". 136 "examples": [ # A list of example occurrences of the error, grouped by product. 137 { # An example occurrence for a particular error. 138 "itemId": "A String", # The ID of the example item. 139 "value": "A String", # The problematic value. 140 "lineNumber": "A String", # Line number in the data feed where the example is found. 141 }, 142 ], 143 }, 144 ], 145 "processingStatus": "A String", # The processing status of the feed. 146 "itemsTotal": "A String", # The number of items in the feed that were processed. 147 "warnings": [ # The list of errors occurring in the feed. 148 { # An error occurring in the feed, like "invalid price". 149 "count": "A String", # The number of occurrences of the error in the feed. 150 "message": "A String", # The error message, e.g., "Invalid price". 151 "code": "A String", # The code of the error, e.g., "validation/invalid_value". 152 "examples": [ # A list of example occurrences of the error, grouped by product. 153 { # An example occurrence for a particular error. 154 "itemId": "A String", # The ID of the example item. 155 "value": "A String", # The problematic value. 156 "lineNumber": "A String", # Line number in the data feed where the example is found. 157 }, 158 ], 159 }, 160 ], 161 "lastUploadDate": "A String", # The last date at which the feed was uploaded. 162 "itemsValid": "A String", # The number of items in the feed that were valid. 163 "datafeedId": "A String", # The ID of the feed for which the status is reported. 164 }, 165 }, 166 ], 167 }</pre> 168 </div> 169 170 <div class="method"> 171 <code class="details" id="get">get(merchantId, datafeedId)</code> 172 <pre>Retrieves the status of a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts. 173 174 Args: 175 merchantId: string, A parameter (required) 176 datafeedId: string, A parameter (required) 177 178 Returns: 179 An object of the form: 180 181 { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. 182 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". 183 "errors": [ # The list of errors occurring in the feed. 184 { # An error occurring in the feed, like "invalid price". 185 "count": "A String", # The number of occurrences of the error in the feed. 186 "message": "A String", # The error message, e.g., "Invalid price". 187 "code": "A String", # The code of the error, e.g., "validation/invalid_value". 188 "examples": [ # A list of example occurrences of the error, grouped by product. 189 { # An example occurrence for a particular error. 190 "itemId": "A String", # The ID of the example item. 191 "value": "A String", # The problematic value. 192 "lineNumber": "A String", # Line number in the data feed where the example is found. 193 }, 194 ], 195 }, 196 ], 197 "processingStatus": "A String", # The processing status of the feed. 198 "itemsTotal": "A String", # The number of items in the feed that were processed. 199 "warnings": [ # The list of errors occurring in the feed. 200 { # An error occurring in the feed, like "invalid price". 201 "count": "A String", # The number of occurrences of the error in the feed. 202 "message": "A String", # The error message, e.g., "Invalid price". 203 "code": "A String", # The code of the error, e.g., "validation/invalid_value". 204 "examples": [ # A list of example occurrences of the error, grouped by product. 205 { # An example occurrence for a particular error. 206 "itemId": "A String", # The ID of the example item. 207 "value": "A String", # The problematic value. 208 "lineNumber": "A String", # Line number in the data feed where the example is found. 209 }, 210 ], 211 }, 212 ], 213 "lastUploadDate": "A String", # The last date at which the feed was uploaded. 214 "itemsValid": "A String", # The number of items in the feed that were valid. 215 "datafeedId": "A String", # The ID of the feed for which the status is reported. 216 }</pre> 217 </div> 218 219 <div class="method"> 220 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code> 221 <pre>Lists the statuses of the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts. 222 223 Args: 224 merchantId: string, The ID of the managing account. (required) 225 pageToken: string, The token returned by the previous request. 226 maxResults: integer, The maximum number of products to return in the response, used for paging. 227 228 Returns: 229 An object of the form: 230 231 { 232 "nextPageToken": "A String", # The token for the retrieval of the next page of datafeed statuses. 233 "kind": "content#datafeedstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse". 234 "resources": [ 235 { # The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished. 236 "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". 237 "errors": [ # The list of errors occurring in the feed. 238 { # An error occurring in the feed, like "invalid price". 239 "count": "A String", # The number of occurrences of the error in the feed. 240 "message": "A String", # The error message, e.g., "Invalid price". 241 "code": "A String", # The code of the error, e.g., "validation/invalid_value". 242 "examples": [ # A list of example occurrences of the error, grouped by product. 243 { # An example occurrence for a particular error. 244 "itemId": "A String", # The ID of the example item. 245 "value": "A String", # The problematic value. 246 "lineNumber": "A String", # Line number in the data feed where the example is found. 247 }, 248 ], 249 }, 250 ], 251 "processingStatus": "A String", # The processing status of the feed. 252 "itemsTotal": "A String", # The number of items in the feed that were processed. 253 "warnings": [ # The list of errors occurring in the feed. 254 { # An error occurring in the feed, like "invalid price". 255 "count": "A String", # The number of occurrences of the error in the feed. 256 "message": "A String", # The error message, e.g., "Invalid price". 257 "code": "A String", # The code of the error, e.g., "validation/invalid_value". 258 "examples": [ # A list of example occurrences of the error, grouped by product. 259 { # An example occurrence for a particular error. 260 "itemId": "A String", # The ID of the example item. 261 "value": "A String", # The problematic value. 262 "lineNumber": "A String", # Line number in the data feed where the example is found. 263 }, 264 ], 265 }, 266 ], 267 "lastUploadDate": "A String", # The last date at which the feed was uploaded. 268 "itemsValid": "A String", # The number of items in the feed that were valid. 269 "datafeedId": "A String", # The ID of the feed for which the status is reported. 270 }, 271 ], 272 }</pre> 273 </div> 274 275 <div class="method"> 276 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 277 <pre>Retrieves the next page of results. 278 279 Args: 280 previous_request: The request for the previous page. (required) 281 previous_response: The response from the request for the previous page. (required) 282 283 Returns: 284 A request object that you can call 'execute()' on to request the next 285 page. Returns None if there are no more items in the collection. 286 </pre> 287 </div> 288 289 </body></html>
