Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 065b5307fe180bfdd4a5d9af134b1c9a0a1d2aba / . / docs / dyn / content_v2.datafeeds.html
blob: be44c2c5e09501c2d5aadeb27742a50bc66c6237 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]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.datafeeds.html">datafeeds</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#batch">batch(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="#custombatch">custombatch(body)</a></code></p>
82<p class="firstline">A description of how to use this function</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(merchantId, datafeedId)</a></code></p>
85<p class="firstline">Deletes a datafeed from your Merchant Center account.</p>
86<p class="toc_element">
87 <code><a href="#get">get(merchantId, datafeedId)</a></code></p>
88<p class="firstline">Retrieves a datafeed from your Merchant Center account.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(merchantId, body)</a></code></p>
91<p class="firstline">Registers a datafeed with your Merchant Center account.</p>
92<p class="toc_element">
93 <code><a href="#list">list(merchantId)</a></code></p>
94<p class="firstline">Lists the datafeeds in your Merchant Center account.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(merchantId, datafeedId, body)</a></code></p>
97<p class="firstline">Updates a datafeed of your Merchant Center account. This method supports patch semantics.</p>
98<p class="toc_element">
99 <code><a href="#update">update(merchantId, datafeedId, body)</a></code></p>
100<p class="firstline">Updates a datafeed of your Merchant Center account.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="batch">batch(body)</code>
104 <pre>A description of how to use this function
105
106Args:
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{
111 "entrys": [
112 {
113 "batchId": 42,
114 "datafeedsupdaterequest": {
115 "resource": {
116 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
117 "contentType": "A String", # The type of data feed.
118 "name": "A String", # A descriptive name of the data feed.
119 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
120 "format": { # Format of the feed file.
121 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
122 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
123 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
124 },
125 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
126 "username": "A String", # An optional user name for fetch_url.
127 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
128 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
129 "weekday": "A String", # The day of the week the feed file should be fetched.
130 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
131 "password": "A String", # An optional password for fetch_url.
132 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
133 },
134 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
135 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
136 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
137 "A String",
138 ],
139 "id": "A String", # The ID of the data feed.
140 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
141 },
142 },
143 "methodName": "A String",
144 "datafeedsinsertrequest": {
145 "resource": {
146 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
147 "contentType": "A String", # The type of data feed.
148 "name": "A String", # A descriptive name of the data feed.
149 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
150 "format": { # Format of the feed file.
151 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
152 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
153 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
154 },
155 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
156 "username": "A String", # An optional user name for fetch_url.
157 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
158 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
159 "weekday": "A String", # The day of the week the feed file should be fetched.
160 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
161 "password": "A String", # An optional password for fetch_url.
162 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
163 },
164 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
165 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
166 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
167 "A String",
168 ],
169 "id": "A String", # The ID of the data feed.
170 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
171 },
172 },
173 },
174 ],
175 }
176
177
178Returns:
179 An object of the form:
180
181 {
182 "entrys": [
183 {
184 "batchId": 42,
185 "datafeedsgetresponse": {
186 "kind": "content#datafeedsGetResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsGetResponse".
187 "resource": {
188 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
189 "contentType": "A String", # The type of data feed.
190 "name": "A String", # A descriptive name of the data feed.
191 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
192 "format": { # Format of the feed file.
193 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
194 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
195 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
196 },
197 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
198 "username": "A String", # An optional user name for fetch_url.
199 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
200 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
201 "weekday": "A String", # The day of the week the feed file should be fetched.
202 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
203 "password": "A String", # An optional password for fetch_url.
204 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
205 },
206 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
207 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
208 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
209 "A String",
210 ],
211 "id": "A String", # The ID of the data feed.
212 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
213 },
214 },
215 "datafeedsinsertresponse": {
216 "kind": "content#datafeedsInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsInsertResponse".
217 "resource": {
218 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
219 "contentType": "A String", # The type of data feed.
220 "name": "A String", # A descriptive name of the data feed.
221 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
222 "format": { # Format of the feed file.
223 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
224 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
225 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
226 },
227 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
228 "username": "A String", # An optional user name for fetch_url.
229 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
230 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
231 "weekday": "A String", # The day of the week the feed file should be fetched.
232 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
233 "password": "A String", # An optional password for fetch_url.
234 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
235 },
236 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
237 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
238 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
239 "A String",
240 ],
241 "id": "A String", # The ID of the data feed.
242 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
243 },
244 },
245 "datafeedsupdateresponse": {
246 "kind": "content#datafeedsUpdateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsUpdateResponse".
247 "resource": {
248 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
249 "contentType": "A String", # The type of data feed.
250 "name": "A String", # A descriptive name of the data feed.
251 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
252 "format": { # Format of the feed file.
253 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
254 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
255 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
256 },
257 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
258 "username": "A String", # An optional user name for fetch_url.
259 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
260 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
261 "weekday": "A String", # The day of the week the feed file should be fetched.
262 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
263 "password": "A String", # An optional password for fetch_url.
264 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
265 },
266 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
267 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
268 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
269 "A String",
270 ],
271 "id": "A String", # The ID of the data feed.
272 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
273 },
274 },
275 },
276 ],
277 "kind": "content#datafeedsBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsBatchResponse".
278 }</pre>
279</div>
280
281<div class="method">
282 <code class="details" id="custombatch">custombatch(body)</code>
283 <pre>A description of how to use this function
284
285Args:
286 body: object, The request body. (required)
287 The object takes the form of:
288
289{
290 "entries": [
291 { # A batch entry encoding a single non-batch request to the datafeeds service of the Content API for Shopping.
292 "batchId": 42, # An entry ID, unique within the batch request.
293 "datafeedId": "A String", # The ID of the data feed to get or delete.
294 "datafeed": { # The data feed to insert.
295 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
296 "contentType": "A String", # The type of data feed.
297 "name": "A String", # A descriptive name of the data feed.
298 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
299 "format": { # Format of the feed file.
300 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
301 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
302 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
303 },
304 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
305 "username": "A String", # An optional user name for fetch_url.
306 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
307 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
308 "weekday": "A String", # The day of the week the feed file should be fetched.
309 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
310 "password": "A String", # An optional password for fetch_url.
311 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
312 },
313 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
314 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
315 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
316 "A String",
317 ],
318 "id": "A String", # The ID of the data feed.
319 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
320 },
321 "merchantId": "A String", # The ID of the managing account.
322 "method": "A String", # The method (get, insert, update, or delete).
323 },
324 ],
325 }
326
327
328Returns:
329 An object of the form:
330
331 {
332 "kind": "content#datafeedsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".
333 "entries": [
334 { # A batch entry encoding a single non-batch response from the datafeeds service of the Content API for Shopping.
335 "batchId": 42, # The ID of the request entry this entry responds to.
336 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
337 "message": "A String", # The message of the first error in errors.
338 "code": 42, # The HTTP status of the first error in errors.
339 "errors": [ # A list of errors.
340 { # An error returned by the API.
341 "reason": "A String", # The error code.
342 "domain": "A String", # The domain of the error.
343 "message": "A String", # A description of the error.
344 },
345 ],
346 },
347 "datafeed": { # The requested data feed. Defined if and only if the request was successful.
348 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
349 "contentType": "A String", # The type of data feed.
350 "name": "A String", # A descriptive name of the data feed.
351 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
352 "format": { # Format of the feed file.
353 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
354 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
355 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
356 },
357 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
358 "username": "A String", # An optional user name for fetch_url.
359 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
360 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
361 "weekday": "A String", # The day of the week the feed file should be fetched.
362 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
363 "password": "A String", # An optional password for fetch_url.
364 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
365 },
366 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
367 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
368 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
369 "A String",
370 ],
371 "id": "A String", # The ID of the data feed.
372 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
373 },
374 },
375 ],
376 }</pre>
377</div>
378
379<div class="method">
380 <code class="details" id="delete">delete(merchantId, datafeedId)</code>
381 <pre>Deletes a datafeed from your Merchant Center account.
382
383Args:
384 merchantId: string, A parameter (required)
385 datafeedId: string, A parameter (required)
386</pre>
387</div>
388
389<div class="method">
390 <code class="details" id="get">get(merchantId, datafeedId)</code>
391 <pre>Retrieves a datafeed from your Merchant Center account.
392
393Args:
394 merchantId: string, A parameter (required)
395 datafeedId: string, A parameter (required)
396
397Returns:
398 An object of the form:
399
400 {
401 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
402 "contentType": "A String", # The type of data feed.
403 "name": "A String", # A descriptive name of the data feed.
404 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
405 "format": { # Format of the feed file.
406 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
407 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
408 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
409 },
410 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
411 "username": "A String", # An optional user name for fetch_url.
412 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
413 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
414 "weekday": "A String", # The day of the week the feed file should be fetched.
415 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
416 "password": "A String", # An optional password for fetch_url.
417 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
418 },
419 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
420 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
421 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
422 "A String",
423 ],
424 "id": "A String", # The ID of the data feed.
425 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
426 }</pre>
427</div>
428
429<div class="method">
430 <code class="details" id="insert">insert(merchantId, body)</code>
431 <pre>Registers a datafeed with your Merchant Center account.
432
433Args:
434 merchantId: string, A parameter (required)
435 body: object, The request body. (required)
436 The object takes the form of:
437
438{
439 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
440 "contentType": "A String", # The type of data feed.
441 "name": "A String", # A descriptive name of the data feed.
442 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
443 "format": { # Format of the feed file.
444 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
445 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
446 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
447 },
448 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
449 "username": "A String", # An optional user name for fetch_url.
450 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
451 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
452 "weekday": "A String", # The day of the week the feed file should be fetched.
453 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
454 "password": "A String", # An optional password for fetch_url.
455 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
456 },
457 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
458 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
459 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
460 "A String",
461 ],
462 "id": "A String", # The ID of the data feed.
463 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
464 }
465
466
467Returns:
468 An object of the form:
469
470 {
471 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
472 "contentType": "A String", # The type of data feed.
473 "name": "A String", # A descriptive name of the data feed.
474 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
475 "format": { # Format of the feed file.
476 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
477 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
478 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
479 },
480 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
481 "username": "A String", # An optional user name for fetch_url.
482 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
483 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
484 "weekday": "A String", # The day of the week the feed file should be fetched.
485 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
486 "password": "A String", # An optional password for fetch_url.
487 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
488 },
489 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
490 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
491 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
492 "A String",
493 ],
494 "id": "A String", # The ID of the data feed.
495 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
496 }</pre>
497</div>
498
499<div class="method">
500 <code class="details" id="list">list(merchantId)</code>
501 <pre>Lists the datafeeds in your Merchant Center account.
502
503Args:
504 merchantId: string, A parameter (required)
505
506Returns:
507 An object of the form:
508
509 {
510 "kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
511 "resources": [
512 {
513 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
514 "contentType": "A String", # The type of data feed.
515 "name": "A String", # A descriptive name of the data feed.
516 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
517 "format": { # Format of the feed file.
518 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
519 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
520 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
521 },
522 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
523 "username": "A String", # An optional user name for fetch_url.
524 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
525 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
526 "weekday": "A String", # The day of the week the feed file should be fetched.
527 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
528 "password": "A String", # An optional password for fetch_url.
529 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
530 },
531 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
532 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
533 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
534 "A String",
535 ],
536 "id": "A String", # The ID of the data feed.
537 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
538 },
539 ],
540 }</pre>
541</div>
542
543<div class="method">
544 <code class="details" id="patch">patch(merchantId, datafeedId, body)</code>
545 <pre>Updates a datafeed of your Merchant Center account. This method supports patch semantics.
546
547Args:
548 merchantId: string, A parameter (required)
549 datafeedId: string, A parameter (required)
550 body: object, The request body. (required)
551 The object takes the form of:
552
553{
554 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
555 "contentType": "A String", # The type of data feed.
556 "name": "A String", # A descriptive name of the data feed.
557 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
558 "format": { # Format of the feed file.
559 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
560 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
561 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
562 },
563 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
564 "username": "A String", # An optional user name for fetch_url.
565 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
566 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
567 "weekday": "A String", # The day of the week the feed file should be fetched.
568 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
569 "password": "A String", # An optional password for fetch_url.
570 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
571 },
572 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
573 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
574 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
575 "A String",
576 ],
577 "id": "A String", # The ID of the data feed.
578 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
579 }
580
581
582Returns:
583 An object of the form:
584
585 {
586 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
587 "contentType": "A String", # The type of data feed.
588 "name": "A String", # A descriptive name of the data feed.
589 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
590 "format": { # Format of the feed file.
591 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
592 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
593 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
594 },
595 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
596 "username": "A String", # An optional user name for fetch_url.
597 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
598 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
599 "weekday": "A String", # The day of the week the feed file should be fetched.
600 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
601 "password": "A String", # An optional password for fetch_url.
602 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
603 },
604 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
605 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
606 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
607 "A String",
608 ],
609 "id": "A String", # The ID of the data feed.
610 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
611 }</pre>
612</div>
613
614<div class="method">
615 <code class="details" id="update">update(merchantId, datafeedId, body)</code>
616 <pre>Updates a datafeed of your Merchant Center account.
617
618Args:
619 merchantId: string, A parameter (required)
620 datafeedId: string, A parameter (required)
621 body: object, The request body. (required)
622 The object takes the form of:
623
624{
625 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
626 "contentType": "A String", # The type of data feed.
627 "name": "A String", # A descriptive name of the data feed.
628 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
629 "format": { # Format of the feed file.
630 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
631 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
632 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
633 },
634 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
635 "username": "A String", # An optional user name for fetch_url.
636 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
637 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
638 "weekday": "A String", # The day of the week the feed file should be fetched.
639 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
640 "password": "A String", # An optional password for fetch_url.
641 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
642 },
643 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
644 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
645 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
646 "A String",
647 ],
648 "id": "A String", # The ID of the data feed.
649 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
650 }
651
652
653Returns:
654 An object of the form:
655
656 {
657 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
658 "contentType": "A String", # The type of data feed.
659 "name": "A String", # A descriptive name of the data feed.
660 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
661 "format": { # Format of the feed file.
662 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
663 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
664 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
665 },
666 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
667 "username": "A String", # An optional user name for fetch_url.
668 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
669 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
670 "weekday": "A String", # The day of the week the feed file should be fetched.
671 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
672 "password": "A String", # An optional password for fetch_url.
673 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
674 },
675 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
676 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
677 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
678 "A String",
679 ],
680 "id": "A String", # The ID of the data feed.
681 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
682 }</pre>
683</div>
684
685</body></html>