• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="#custombatch">custombatch(body, dryRun=None)</a></code></p>
79<p class="firstline">Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(merchantId, datafeedId, dryRun=None)</a></code></p>
82<p class="firstline">Deletes a datafeed configuration from your Merchant Center account.</p>
83<p class="toc_element">
84  <code><a href="#fetchnow">fetchnow(merchantId, datafeedId, dryRun=None)</a></code></p>
85<p class="firstline">Invokes a fetch for the datafeed in 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 configuration from your Merchant Center account.</p>
89<p class="toc_element">
90  <code><a href="#insert">insert(merchantId, body, dryRun=None)</a></code></p>
91<p class="firstline">Registers a datafeed configuration with your Merchant Center account.</p>
92<p class="toc_element">
93  <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
94<p class="firstline">Lists the configurations for datafeeds in your Merchant Center account.</p>
95<p class="toc_element">
96  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99  <code><a href="#patch">patch(merchantId, datafeedId, body, dryRun=None)</a></code></p>
100<p class="firstline">Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics.</p>
101<p class="toc_element">
102  <code><a href="#update">update(merchantId, datafeedId, body, dryRun=None)</a></code></p>
103<p class="firstline">Updates a datafeed configuration of your Merchant Center account.</p>
104<h3>Method Details</h3>
105<div class="method">
106    <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
107  <pre>Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
108
109Args:
110  body: object, The request body. (required)
111    The object takes the form of:
112
113{
114    "entries": [ # The request entries to be processed in the batch.
115      { # A batch entry encoding a single non-batch datafeeds request.
116        "batchId": 42, # An entry ID, unique within the batch request.
117        "datafeedId": "A String", # The ID of the data feed to get, delete or fetch.
118        "datafeed": { # Datafeed configuration data. # The data feed to insert.
119            "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
120            "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
121            "name": "A String", # A descriptive name of the data feed.
122            "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
123            "format": { # Format of the feed file.
124              "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
125              "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
126              "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.
127            },
128            "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.
129              "username": "A String", # An optional user name for fetch_url.
130              "hour": 42, # The hour of the day the feed file should be fetched (0-23).
131              "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.
132              "paused": True or False, # Whether the scheduled fetch is paused or not.
133              "weekday": "A String", # The day of the week the feed file should be fetched.
134              "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
135              "password": "A String", # An optional password for fetch_url.
136              "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
137              "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
138            },
139            "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
140            "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
141            "targets": [ # The targets this feed should apply to (country, language, destinations).
142              {
143                "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
144                "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
145                  "A String",
146                ],
147                "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
148                "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
149                  "A String",
150                ],
151              },
152            ],
153            "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
154              "A String",
155            ],
156            "id": "A String", # The ID of the data feed.
157            "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
158          },
159        "merchantId": "A String", # The ID of the managing account.
160        "method": "A String",
161      },
162    ],
163  }
164
165  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
166
167Returns:
168  An object of the form:
169
170    {
171    "kind": "content#datafeedsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".
172    "entries": [ # The result of the execution of the batch requests.
173      { # A batch entry encoding a single non-batch datafeeds response.
174        "batchId": 42, # The ID of the request entry this entry responds to.
175        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
176          "message": "A String", # The message of the first error in errors.
177          "code": 42, # The HTTP status of the first error in errors.
178          "errors": [ # A list of errors.
179            { # An error returned by the API.
180              "reason": "A String", # The error code.
181              "domain": "A String", # The domain of the error.
182              "message": "A String", # A description of the error.
183            },
184          ],
185        },
186        "datafeed": { # Datafeed configuration data. # The requested data feed. Defined if and only if the request was successful.
187            "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
188            "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
189            "name": "A String", # A descriptive name of the data feed.
190            "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
191            "format": { # Format of the feed file.
192              "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
193              "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
194              "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.
195            },
196            "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.
197              "username": "A String", # An optional user name for fetch_url.
198              "hour": 42, # The hour of the day the feed file should be fetched (0-23).
199              "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.
200              "paused": True or False, # Whether the scheduled fetch is paused or not.
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              "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
205              "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
206            },
207            "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
208            "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
209            "targets": [ # The targets this feed should apply to (country, language, destinations).
210              {
211                "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
212                "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
213                  "A String",
214                ],
215                "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
216                "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
217                  "A String",
218                ],
219              },
220            ],
221            "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
222              "A String",
223            ],
224            "id": "A String", # The ID of the data feed.
225            "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
226          },
227      },
228    ],
229  }</pre>
230</div>
231
232<div class="method">
233    <code class="details" id="delete">delete(merchantId, datafeedId, dryRun=None)</code>
234  <pre>Deletes a datafeed configuration from your Merchant Center account.
235
236Args:
237  merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
238  datafeedId: string, The ID of the datafeed. (required)
239  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
240</pre>
241</div>
242
243<div class="method">
244    <code class="details" id="fetchnow">fetchnow(merchantId, datafeedId, dryRun=None)</code>
245  <pre>Invokes a fetch for the datafeed in your Merchant Center account.
246
247Args:
248  merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
249  datafeedId: string, The ID of the datafeed to be fetched. (required)
250  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
251
252Returns:
253  An object of the form:
254
255    {
256    "kind": "content#datafeedsFetchNowResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".
257  }</pre>
258</div>
259
260<div class="method">
261    <code class="details" id="get">get(merchantId, datafeedId)</code>
262  <pre>Retrieves a datafeed configuration from your Merchant Center account.
263
264Args:
265  merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
266  datafeedId: string, The ID of the datafeed. (required)
267
268Returns:
269  An object of the form:
270
271    { # Datafeed configuration data.
272      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
273      "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
274      "name": "A String", # A descriptive name of the data feed.
275      "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
276      "format": { # Format of the feed file.
277        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
278        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
279        "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.
280      },
281      "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.
282        "username": "A String", # An optional user name for fetch_url.
283        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
284        "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.
285        "paused": True or False, # Whether the scheduled fetch is paused or not.
286        "weekday": "A String", # The day of the week the feed file should be fetched.
287        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
288        "password": "A String", # An optional password for fetch_url.
289        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
290        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
291      },
292      "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
293      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
294      "targets": [ # The targets this feed should apply to (country, language, destinations).
295        {
296          "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
297          "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
298            "A String",
299          ],
300          "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
301          "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
302            "A String",
303          ],
304        },
305      ],
306      "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
307        "A String",
308      ],
309      "id": "A String", # The ID of the data feed.
310      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
311    }</pre>
312</div>
313
314<div class="method">
315    <code class="details" id="insert">insert(merchantId, body, dryRun=None)</code>
316  <pre>Registers a datafeed configuration with your Merchant Center account.
317
318Args:
319  merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
320  body: object, The request body. (required)
321    The object takes the form of:
322
323{ # Datafeed configuration data.
324    "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
325    "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
326    "name": "A String", # A descriptive name of the data feed.
327    "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
328    "format": { # Format of the feed file.
329      "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
330      "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
331      "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.
332    },
333    "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.
334      "username": "A String", # An optional user name for fetch_url.
335      "hour": 42, # The hour of the day the feed file should be fetched (0-23).
336      "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.
337      "paused": True or False, # Whether the scheduled fetch is paused or not.
338      "weekday": "A String", # The day of the week the feed file should be fetched.
339      "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
340      "password": "A String", # An optional password for fetch_url.
341      "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
342      "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
343    },
344    "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
345    "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
346    "targets": [ # The targets this feed should apply to (country, language, destinations).
347      {
348        "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
349        "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
350          "A String",
351        ],
352        "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
353        "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
354          "A String",
355        ],
356      },
357    ],
358    "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
359      "A String",
360    ],
361    "id": "A String", # The ID of the data feed.
362    "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
363  }
364
365  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
366
367Returns:
368  An object of the form:
369
370    { # Datafeed configuration data.
371      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
372      "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
373      "name": "A String", # A descriptive name of the data feed.
374      "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
375      "format": { # Format of the feed file.
376        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
377        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
378        "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.
379      },
380      "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.
381        "username": "A String", # An optional user name for fetch_url.
382        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
383        "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.
384        "paused": True or False, # Whether the scheduled fetch is paused or not.
385        "weekday": "A String", # The day of the week the feed file should be fetched.
386        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
387        "password": "A String", # An optional password for fetch_url.
388        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
389        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
390      },
391      "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
392      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
393      "targets": [ # The targets this feed should apply to (country, language, destinations).
394        {
395          "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
396          "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
397            "A String",
398          ],
399          "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
400          "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
401            "A String",
402          ],
403        },
404      ],
405      "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
406        "A String",
407      ],
408      "id": "A String", # The ID of the data feed.
409      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
410    }</pre>
411</div>
412
413<div class="method">
414    <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
415  <pre>Lists the configurations for datafeeds in your Merchant Center account.
416
417Args:
418  merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)
419  pageToken: string, The token returned by the previous request.
420  maxResults: integer, The maximum number of products to return in the response, used for paging.
421
422Returns:
423  An object of the form:
424
425    {
426    "nextPageToken": "A String", # The token for the retrieval of the next page of datafeeds.
427    "kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
428    "resources": [
429      { # Datafeed configuration data.
430          "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
431          "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
432          "name": "A String", # A descriptive name of the data feed.
433          "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
434          "format": { # Format of the feed file.
435            "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
436            "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
437            "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.
438          },
439          "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.
440            "username": "A String", # An optional user name for fetch_url.
441            "hour": 42, # The hour of the day the feed file should be fetched (0-23).
442            "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.
443            "paused": True or False, # Whether the scheduled fetch is paused or not.
444            "weekday": "A String", # The day of the week the feed file should be fetched.
445            "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
446            "password": "A String", # An optional password for fetch_url.
447            "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
448            "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
449          },
450          "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
451          "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
452          "targets": [ # The targets this feed should apply to (country, language, destinations).
453            {
454              "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
455              "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
456                "A String",
457              ],
458              "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
459              "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
460                "A String",
461              ],
462            },
463          ],
464          "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
465            "A String",
466          ],
467          "id": "A String", # The ID of the data feed.
468          "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
469        },
470    ],
471  }</pre>
472</div>
473
474<div class="method">
475    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
476  <pre>Retrieves the next page of results.
477
478Args:
479  previous_request: The request for the previous page. (required)
480  previous_response: The response from the request for the previous page. (required)
481
482Returns:
483  A request object that you can call 'execute()' on to request the next
484  page. Returns None if there are no more items in the collection.
485    </pre>
486</div>
487
488<div class="method">
489    <code class="details" id="patch">patch(merchantId, datafeedId, body, dryRun=None)</code>
490  <pre>Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics.
491
492Args:
493  merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
494  datafeedId: string, The ID of the datafeed. (required)
495  body: object, The request body. (required)
496    The object takes the form of:
497
498{ # Datafeed configuration data.
499    "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
500    "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
501    "name": "A String", # A descriptive name of the data feed.
502    "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
503    "format": { # Format of the feed file.
504      "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
505      "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
506      "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.
507    },
508    "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.
509      "username": "A String", # An optional user name for fetch_url.
510      "hour": 42, # The hour of the day the feed file should be fetched (0-23).
511      "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.
512      "paused": True or False, # Whether the scheduled fetch is paused or not.
513      "weekday": "A String", # The day of the week the feed file should be fetched.
514      "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
515      "password": "A String", # An optional password for fetch_url.
516      "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
517      "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
518    },
519    "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
520    "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
521    "targets": [ # The targets this feed should apply to (country, language, destinations).
522      {
523        "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
524        "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
525          "A String",
526        ],
527        "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
528        "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
529          "A String",
530        ],
531      },
532    ],
533    "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. 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  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
541
542Returns:
543  An object of the form:
544
545    { # Datafeed configuration data.
546      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
547      "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
548      "name": "A String", # A descriptive name of the data feed.
549      "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
550      "format": { # Format of the feed file.
551        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
552        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
553        "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.
554      },
555      "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.
556        "username": "A String", # An optional user name for fetch_url.
557        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
558        "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.
559        "paused": True or False, # Whether the scheduled fetch is paused or not.
560        "weekday": "A String", # The day of the week the feed file should be fetched.
561        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
562        "password": "A String", # An optional password for fetch_url.
563        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
564        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
565      },
566      "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
567      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
568      "targets": [ # The targets this feed should apply to (country, language, destinations).
569        {
570          "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
571          "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
572            "A String",
573          ],
574          "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
575          "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
576            "A String",
577          ],
578        },
579      ],
580      "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
581        "A String",
582      ],
583      "id": "A String", # The ID of the data feed.
584      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
585    }</pre>
586</div>
587
588<div class="method">
589    <code class="details" id="update">update(merchantId, datafeedId, body, dryRun=None)</code>
590  <pre>Updates a datafeed configuration of your Merchant Center account.
591
592Args:
593  merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
594  datafeedId: string, The ID of the datafeed. (required)
595  body: object, The request body. (required)
596    The object takes the form of:
597
598{ # Datafeed configuration data.
599    "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
600    "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
601    "name": "A String", # A descriptive name of the data feed.
602    "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
603    "format": { # Format of the feed file.
604      "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
605      "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
606      "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.
607    },
608    "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.
609      "username": "A String", # An optional user name for fetch_url.
610      "hour": 42, # The hour of the day the feed file should be fetched (0-23).
611      "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.
612      "paused": True or False, # Whether the scheduled fetch is paused or not.
613      "weekday": "A String", # The day of the week the feed file should be fetched.
614      "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
615      "password": "A String", # An optional password for fetch_url.
616      "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
617      "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
618    },
619    "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
620    "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
621    "targets": [ # The targets this feed should apply to (country, language, destinations).
622      {
623        "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
624        "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
625          "A String",
626        ],
627        "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
628        "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
629          "A String",
630        ],
631      },
632    ],
633    "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
634      "A String",
635    ],
636    "id": "A String", # The ID of the data feed.
637    "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
638  }
639
640  dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
641
642Returns:
643  An object of the form:
644
645    { # Datafeed configuration data.
646      "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
647      "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
648      "name": "A String", # A descriptive name of the data feed.
649      "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry.
650      "format": { # Format of the feed file.
651        "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
652        "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
653        "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.
654      },
655      "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.
656        "username": "A String", # An optional user name for fetch_url.
657        "hour": 42, # The hour of the day the feed file should be fetched (0-23).
658        "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.
659        "paused": True or False, # Whether the scheduled fetch is paused or not.
660        "weekday": "A String", # The day of the week the feed file should be fetched.
661        "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
662        "password": "A String", # An optional password for fetch_url.
663        "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
664        "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
665      },
666      "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
667      "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
668      "targets": [ # The targets this feed should apply to (country, language, destinations).
669        {
670          "country": "A String", # The country where the items in the feed will be included in the search index, represented as a  CLDR territory code.
671          "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in the excluded_destination field.
672            "A String",
673          ],
674          "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.
675          "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
676            "A String",
677          ],
678        },
679      ],
680      "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
681        "A String",
682      ],
683      "id": "A String", # The ID of the data feed.
684      "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
685    }</pre>
686</div>
687
688</body></html>