-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
content_v2_1.datafeeds.html
608 lines (557 loc) 路 50.5 KB
/
content_v2_1.datafeeds.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.datafeeds.html">datafeeds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, datafeedId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a datafeed configuration from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#fetchnow">fetchnow(merchantId, datafeedId, x__xgafv=None)</a></code></p>
<p class="firstline">Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the [Products service](https://developers.google.com/shopping-content/reference/rest/v2.1/products) to update your product data.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, datafeedId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a datafeed configuration from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#insert">insert(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Registers a datafeed configuration with your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the configurations for datafeeds in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(merchantId, datafeedId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code>
<pre>Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{ # A batch entry encoding a single non-batch datafeeds request.
"batchId": 42, # An entry ID, unique within the batch request.
"datafeed": { # Datafeed configuration data. # The data feed to insert.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
},
"datafeedId": "A String", # The ID of the data feed to get, delete or fetch.
"merchantId": "A String", # The ID of the managing account.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`delete`" - "`fetchNow`" - "`get`" - "`insert`" - "`update`"
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch datafeeds response.
"batchId": 42, # The ID of the request entry this entry responds to.
"datafeed": { # Datafeed configuration data. # The requested data feed. Defined if and only if the request was successful.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
},
"errors": { # A list of errors returned by a failed batch entry. # A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
"reason": "A String", # The error code.
},
],
"message": "A String", # The message of the first error in `errors`.
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedsCustomBatchResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, datafeedId, x__xgafv=None)</code>
<pre>Deletes a datafeed configuration from your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
datafeedId: string, The ID of the datafeed. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="fetchnow">fetchnow(merchantId, datafeedId, x__xgafv=None)</code>
<pre>Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the [Products service](https://developers.google.com/shopping-content/reference/rest/v2.1/products) to update your product data.
Args:
merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
datafeedId: string, The ID of the datafeed to be fetched. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedsFetchNowResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, datafeedId, x__xgafv=None)</code>
<pre>Retrieves a datafeed configuration from your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
datafeedId: string, The ID of the datafeed. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Datafeed configuration data.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, body=None, x__xgafv=None)</code>
<pre>Registers a datafeed configuration with your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
body: object, The request body.
The object takes the form of:
{ # Datafeed configuration data.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Datafeed configuration data.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the configurations for datafeeds in your Merchant Center account.
Args:
merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)
maxResults: integer, The maximum number of products to return in the response, used for paging.
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeedsListResponse`".
"nextPageToken": "A String", # The token for the retrieval of the next page of datafeeds.
"resources": [
{ # Datafeed configuration data.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(merchantId, datafeedId, body=None, x__xgafv=None)</code>
<pre>Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.
Args:
merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
datafeedId: string, The ID of the datafeed. (required)
body: object, The request body.
The object takes the form of:
{ # Datafeed configuration data.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Datafeed configuration data.
"attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
"contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`"
"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.
"dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
"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.
"hour": 42, # The hour of the day the feed file should be fetched (0-23).
"minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
"password": "A String", # An optional password for fetch_url.
"paused": True or False, # Whether the scheduled fetch is paused or not.
"timeZone": "A String", # Time zone used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # An optional user name for fetch_url.
"weekday": "A String", # The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`"
},
"fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
"format": { # Format of the feed file.
"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. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`"
"fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`"
"quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`"
},
"id": "A String", # Required for update. The ID of the data feed.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
"name": "A String", # Required for insert. A descriptive name of the data feed.
"targets": [ # The targets this feed should apply to (country, language, destinations).
{
"country": "A String", # Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
"excludedDestinations": [ # The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"feedLabel": "A String", # Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"includedDestinations": [ # The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
"targetCountries": [ # The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for "product inventory" feeds.
"A String",
],
},
],
}</pre>
</div>
</body></html>