Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 15744b1488c8e3a52899531aa0d04b93d572f683 / . / docs / dyn / content_v2.datafeeds.html
blob: 6b6eb69342ad408a9d4cb65ad45d4ea9e617fe6e [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.datafeeds.html">datafeeds</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]78 <code><a href="#custombatch">custombatch(body)</a></code></p>
79<p class="firstline">A description of how to use this function</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(merchantId, datafeedId)</a></code></p>
82<p class="firstline">Deletes a datafeed from your Merchant Center account.</p>
83<p class="toc_element">
84 <code><a href="#get">get(merchantId, datafeedId)</a></code></p>
85<p class="firstline">Retrieves a datafeed from your Merchant Center account.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(merchantId, body)</a></code></p>
88<p class="firstline">Registers a datafeed with your Merchant Center account.</p>
89<p class="toc_element">
90 <code><a href="#list">list(merchantId)</a></code></p>
91<p class="firstline">Lists the datafeeds in your Merchant Center account.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(merchantId, datafeedId, body)</a></code></p>
94<p class="firstline">Updates a datafeed of your Merchant Center account. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(merchantId, datafeedId, body)</a></code></p>
97<p class="firstline">Updates a datafeed of your Merchant Center account.</p>
98<h3>Method Details</h3>
99<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]100 <code class="details" id="custombatch">custombatch(body)</code>
101 <pre>A description of how to use this function
102
103Args:
104 body: object, The request body. (required)
105 The object takes the form of:
106
107{
108 "entries": [
109 { # A batch entry encoding a single non-batch request to the datafeeds service of the Content API for Shopping.
110 "batchId": 42, # An entry ID, unique within the batch request.
111 "datafeedId": "A String", # The ID of the data feed to get or delete.
112 "datafeed": { # The data feed to insert.
113 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
114 "contentType": "A String", # The type of data feed.
115 "name": "A String", # A descriptive name of the data feed.
116 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
117 "format": { # Format of the feed file.
118 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
119 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
120 "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.
121 },
122 "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.
123 "username": "A String", # An optional user name for fetch_url.
124 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
125 "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.
126 "weekday": "A String", # The day of the week the feed file should be fetched.
127 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
128 "password": "A String", # An optional password for fetch_url.
129 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
130 },
131 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
132 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
133 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
134 "A String",
135 ],
136 "id": "A String", # The ID of the data feed.
137 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
138 },
139 "merchantId": "A String", # The ID of the managing account.
140 "method": "A String", # The method (get, insert, update, or delete).
141 },
142 ],
143 }
144
145
146Returns:
147 An object of the form:
148
149 {
150 "kind": "content#datafeedsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".
151 "entries": [
152 { # A batch entry encoding a single non-batch response from the datafeeds service of the Content API for Shopping.
153 "batchId": 42, # The ID of the request entry this entry responds to.
154 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
155 "message": "A String", # The message of the first error in errors.
156 "code": 42, # The HTTP status of the first error in errors.
157 "errors": [ # A list of errors.
158 { # An error returned by the API.
159 "reason": "A String", # The error code.
160 "domain": "A String", # The domain of the error.
161 "message": "A String", # A description of the error.
162 },
163 ],
164 },
165 "datafeed": { # The requested data feed. Defined if and only if the request was successful.
166 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
167 "contentType": "A String", # The type of data feed.
168 "name": "A String", # A descriptive name of the data feed.
169 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
170 "format": { # Format of the feed file.
171 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
172 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
173 "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.
174 },
175 "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.
176 "username": "A String", # An optional user name for fetch_url.
177 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
178 "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.
179 "weekday": "A String", # The day of the week the feed file should be fetched.
180 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
181 "password": "A String", # An optional password for fetch_url.
182 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
183 },
184 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
185 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
186 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
187 "A String",
188 ],
189 "id": "A String", # The ID of the data feed.
190 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
191 },
192 },
193 ],
194 }</pre>
195</div>
196
197<div class="method">
198 <code class="details" id="delete">delete(merchantId, datafeedId)</code>
199 <pre>Deletes a datafeed from your Merchant Center account.
200
201Args:
202 merchantId: string, A parameter (required)
203 datafeedId: string, A parameter (required)
204</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="get">get(merchantId, datafeedId)</code>
209 <pre>Retrieves a datafeed from your Merchant Center account.
210
211Args:
212 merchantId: string, A parameter (required)
213 datafeedId: string, A parameter (required)
214
215Returns:
216 An object of the form:
217
218 {
219 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
220 "contentType": "A String", # The type of data feed.
221 "name": "A String", # A descriptive name of the data feed.
222 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
223 "format": { # Format of the feed file.
224 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
225 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
226 "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.
227 },
228 "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.
229 "username": "A String", # An optional user name for fetch_url.
230 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
231 "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.
232 "weekday": "A String", # The day of the week the feed file should be fetched.
233 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
234 "password": "A String", # An optional password for fetch_url.
235 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
236 },
237 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
238 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
239 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
240 "A String",
241 ],
242 "id": "A String", # The ID of the data feed.
243 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
244 }</pre>
245</div>
246
247<div class="method">
248 <code class="details" id="insert">insert(merchantId, body)</code>
249 <pre>Registers a datafeed with your Merchant Center account.
250
251Args:
252 merchantId: string, A parameter (required)
253 body: object, The request body. (required)
254 The object takes the form of:
255
256{
257 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
258 "contentType": "A String", # The type of data feed.
259 "name": "A String", # A descriptive name of the data feed.
260 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
261 "format": { # Format of the feed file.
262 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
263 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
264 "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.
265 },
266 "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.
267 "username": "A String", # An optional user name for fetch_url.
268 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
269 "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.
270 "weekday": "A String", # The day of the week the feed file should be fetched.
271 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
272 "password": "A String", # An optional password for fetch_url.
273 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
274 },
275 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
276 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
277 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
278 "A String",
279 ],
280 "id": "A String", # The ID of the data feed.
281 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
282 }
283
284
285Returns:
286 An object of the form:
287
288 {
289 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
290 "contentType": "A String", # The type of data feed.
291 "name": "A String", # A descriptive name of the data feed.
292 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
293 "format": { # Format of the feed file.
294 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
295 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
296 "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.
297 },
298 "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.
299 "username": "A String", # An optional user name for fetch_url.
300 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
301 "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.
302 "weekday": "A String", # The day of the week the feed file should be fetched.
303 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
304 "password": "A String", # An optional password for fetch_url.
305 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
306 },
307 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
308 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
309 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
310 "A String",
311 ],
312 "id": "A String", # The ID of the data feed.
313 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
314 }</pre>
315</div>
316
317<div class="method">
318 <code class="details" id="list">list(merchantId)</code>
319 <pre>Lists the datafeeds in your Merchant Center account.
320
321Args:
322 merchantId: string, A parameter (required)
323
324Returns:
325 An object of the form:
326
327 {
328 "kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
329 "resources": [
330 {
331 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
332 "contentType": "A String", # The type of data feed.
333 "name": "A String", # A descriptive name of the data feed.
334 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
335 "format": { # Format of the feed file.
336 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
337 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
338 "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.
339 },
340 "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.
341 "username": "A String", # An optional user name for fetch_url.
342 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
343 "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.
344 "weekday": "A String", # The day of the week the feed file should be fetched.
345 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
346 "password": "A String", # An optional password for fetch_url.
347 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
348 },
349 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
350 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
351 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
352 "A String",
353 ],
354 "id": "A String", # The ID of the data feed.
355 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
356 },
357 ],
358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="patch">patch(merchantId, datafeedId, body)</code>
363 <pre>Updates a datafeed of your Merchant Center account. This method supports patch semantics.
364
365Args:
366 merchantId: string, A parameter (required)
367 datafeedId: string, A parameter (required)
368 body: object, The request body. (required)
369 The object takes the form of:
370
371{
372 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
373 "contentType": "A String", # The type of data feed.
374 "name": "A String", # A descriptive name of the data feed.
375 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
376 "format": { # Format of the feed file.
377 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
378 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
379 "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.
380 },
381 "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.
382 "username": "A String", # An optional user name for fetch_url.
383 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
384 "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.
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 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
389 },
390 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
391 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
392 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
393 "A String",
394 ],
395 "id": "A String", # The ID of the data feed.
396 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
397 }
398
399
400Returns:
401 An object of the form:
402
403 {
404 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
405 "contentType": "A String", # The type of data feed.
406 "name": "A String", # A descriptive name of the data feed.
407 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
408 "format": { # Format of the feed file.
409 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
410 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
411 "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.
412 },
413 "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.
414 "username": "A String", # An optional user name for fetch_url.
415 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
416 "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.
417 "weekday": "A String", # The day of the week the feed file should be fetched.
418 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
419 "password": "A String", # An optional password for fetch_url.
420 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
421 },
422 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
423 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
424 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
425 "A String",
426 ],
427 "id": "A String", # The ID of the data feed.
428 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
429 }</pre>
430</div>
431
432<div class="method">
433 <code class="details" id="update">update(merchantId, datafeedId, body)</code>
434 <pre>Updates a datafeed of your Merchant Center account.
435
436Args:
437 merchantId: string, A parameter (required)
438 datafeedId: string, A parameter (required)
439 body: object, The request body. (required)
440 The object takes the form of:
441
442{
443 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
444 "contentType": "A String", # The type of data feed.
445 "name": "A String", # A descriptive name of the data feed.
446 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
447 "format": { # Format of the feed file.
448 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
449 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
450 "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.
451 },
452 "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.
453 "username": "A String", # An optional user name for fetch_url.
454 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
455 "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.
456 "weekday": "A String", # The day of the week the feed file should be fetched.
457 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
458 "password": "A String", # An optional password for fetch_url.
459 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
460 },
461 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
462 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
463 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
464 "A String",
465 ],
466 "id": "A String", # The ID of the data feed.
467 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
468 }
469
470
471Returns:
472 An object of the form:
473
474 {
475 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
476 "contentType": "A String", # The type of data feed.
477 "name": "A String", # A descriptive name of the data feed.
478 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
479 "format": { # Format of the feed file.
480 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
481 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
482 "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.
483 },
484 "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.
485 "username": "A String", # An optional user name for fetch_url.
486 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
487 "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.
488 "weekday": "A String", # The day of the week the feed file should be fetched.
489 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
490 "password": "A String", # An optional password for fetch_url.
491 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
492 },
493 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
494 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
495 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
496 "A String",
497 ],
498 "id": "A String", # The ID of the data feed.
499 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
500 }</pre>
501</div>
502
503</body></html>