Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / content_v2.datafeeds.html
blob: cb8fefe301849d772d68d63be8cc6d088c13c4e6 [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">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]90 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]91<p class="firstline">Lists the datafeeds in your Merchant Center account.</p>
92<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]96 <code><a href="#patch">patch(merchantId, datafeedId, body)</a></code></p>
97<p class="firstline">Updates a datafeed of your Merchant Center account. This method supports patch semantics.</p>
98<p class="toc_element">
99 <code><a href="#update">update(merchantId, datafeedId, body)</a></code></p>
100<p class="firstline">Updates a datafeed of your Merchant Center account.</p>
101<h3>Method Details</h3>
102<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]103 <code class="details" id="custombatch">custombatch(body)</code>
104 <pre>A description of how to use this function
105
106Args:
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]111 "entries": [ # The request entries to be processed in the batch.
112 { # A batch entry encoding a single non-batch datafeeds request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]113 "batchId": 42, # An entry ID, unique within the batch request.
114 "datafeedId": "A String", # The ID of the data feed to get or delete.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]115 "datafeed": { # Datafeed data. # The data feed to insert.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]116 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
117 "contentType": "A String", # The type of data feed.
118 "name": "A String", # A descriptive name of the data feed.
119 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
120 "format": { # Format of the feed file.
121 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
122 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
123 "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.
124 },
125 "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file.
126 "username": "A String", # An optional user name for fetch_url.
127 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
128 "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.
129 "weekday": "A String", # The day of the week the feed file should be fetched.
130 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
131 "password": "A String", # An optional password for fetch_url.
132 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
133 },
134 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
135 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
136 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
137 "A String",
138 ],
139 "id": "A String", # The ID of the data feed.
140 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
141 },
142 "merchantId": "A String", # The ID of the managing account.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]143 "method": "A String",
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]144 },
145 ],
146 }
147
148
149Returns:
150 An object of the form:
151
152 {
153 "kind": "content#datafeedsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]154 "entries": [ # The result of the execution of the batch requests.
155 { # A batch entry encoding a single non-batch datafeeds response.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]156 "batchId": 42, # The ID of the request entry this entry responds to.
157 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
158 "message": "A String", # The message of the first error in errors.
159 "code": 42, # The HTTP status of the first error in errors.
160 "errors": [ # A list of errors.
161 { # An error returned by the API.
162 "reason": "A String", # The error code.
163 "domain": "A String", # The domain of the error.
164 "message": "A String", # A description of the error.
165 },
166 ],
167 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]168 "datafeed": { # Datafeed data. # The requested data feed. Defined if and only if the request was successful.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]169 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
170 "contentType": "A String", # The type of data feed.
171 "name": "A String", # A descriptive name of the data feed.
172 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
173 "format": { # Format of the feed file.
174 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
175 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
176 "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.
177 },
178 "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.
179 "username": "A String", # An optional user name for fetch_url.
180 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
181 "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.
182 "weekday": "A String", # The day of the week the feed file should be fetched.
183 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
184 "password": "A String", # An optional password for fetch_url.
185 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
186 },
187 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
188 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
189 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
190 "A String",
191 ],
192 "id": "A String", # The ID of the data feed.
193 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
194 },
195 },
196 ],
197 }</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="delete">delete(merchantId, datafeedId)</code>
202 <pre>Deletes a datafeed from your Merchant Center account.
203
204Args:
205 merchantId: string, A parameter (required)
206 datafeedId: string, A parameter (required)
207</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="get">get(merchantId, datafeedId)</code>
212 <pre>Retrieves a datafeed from your Merchant Center account.
213
214Args:
215 merchantId: string, A parameter (required)
216 datafeedId: string, A parameter (required)
217
218Returns:
219 An object of the form:
220
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]221 { # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]222 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
223 "contentType": "A String", # The type of data feed.
224 "name": "A String", # A descriptive name of the data feed.
225 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
226 "format": { # Format of the feed file.
227 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
228 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
229 "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.
230 },
231 "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.
232 "username": "A String", # An optional user name for fetch_url.
233 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
234 "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.
235 "weekday": "A String", # The day of the week the feed file should be fetched.
236 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
237 "password": "A String", # An optional password for fetch_url.
238 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
239 },
240 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
241 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
242 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
243 "A String",
244 ],
245 "id": "A String", # The ID of the data feed.
246 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
247 }</pre>
248</div>
249
250<div class="method">
251 <code class="details" id="insert">insert(merchantId, body)</code>
252 <pre>Registers a datafeed with your Merchant Center account.
253
254Args:
255 merchantId: string, A parameter (required)
256 body: object, The request body. (required)
257 The object takes the form of:
258
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]259{ # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
261 "contentType": "A String", # The type of data feed.
262 "name": "A String", # A descriptive name of the data feed.
263 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
264 "format": { # Format of the feed file.
265 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
266 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
267 "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.
268 },
269 "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.
270 "username": "A String", # An optional user name for fetch_url.
271 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
272 "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.
273 "weekday": "A String", # The day of the week the feed file should be fetched.
274 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
275 "password": "A String", # An optional password for fetch_url.
276 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
277 },
278 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
279 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
280 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
281 "A String",
282 ],
283 "id": "A String", # The ID of the data feed.
284 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
285 }
286
287
288Returns:
289 An object of the form:
290
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]291 { # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]292 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
293 "contentType": "A String", # The type of data feed.
294 "name": "A String", # A descriptive name of the data feed.
295 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
296 "format": { # Format of the feed file.
297 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
298 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
299 "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.
300 },
301 "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.
302 "username": "A String", # An optional user name for fetch_url.
303 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
304 "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.
305 "weekday": "A String", # The day of the week the feed file should be fetched.
306 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
307 "password": "A String", # An optional password for fetch_url.
308 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
309 },
310 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
311 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
312 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
313 "A String",
314 ],
315 "id": "A String", # The ID of the data feed.
316 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
317 }</pre>
318</div>
319
320<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]321 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]322 <pre>Lists the datafeeds in your Merchant Center account.
323
324Args:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]325 merchantId: string, The ID of the managing account. (required)
326 pageToken: string, The token returned by the previous request.
327 maxResults: integer, The maximum number of products to return in the response, used for paging.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]328
329Returns:
330 An object of the form:
331
332 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]333 "nextPageToken": "A String", # The token for the retrieval of the next page of datafeeds.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]334 "kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
335 "resources": [
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]336 { # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]337 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
338 "contentType": "A String", # The type of data feed.
339 "name": "A String", # A descriptive name of the data feed.
340 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
341 "format": { # Format of the feed file.
342 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
343 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
344 "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.
345 },
346 "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.
347 "username": "A String", # An optional user name for fetch_url.
348 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
349 "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.
350 "weekday": "A String", # The day of the week the feed file should be fetched.
351 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
352 "password": "A String", # An optional password for fetch_url.
353 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
354 },
355 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
356 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
357 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
358 "A String",
359 ],
360 "id": "A String", # The ID of the data feed.
361 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
362 },
363 ],
364 }</pre>
365</div>
366
367<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]368 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
369 <pre>Retrieves the next page of results.
370
371Args:
372 previous_request: The request for the previous page. (required)
373 previous_response: The response from the request for the previous page. (required)
374
375Returns:
376 A request object that you can call 'execute()' on to request the next
377 page. Returns None if there are no more items in the collection.
378 </pre>
379</div>
380
381<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]382 <code class="details" id="patch">patch(merchantId, datafeedId, body)</code>
383 <pre>Updates a datafeed of your Merchant Center account. This method supports patch semantics.
384
385Args:
386 merchantId: string, A parameter (required)
387 datafeedId: string, A parameter (required)
388 body: object, The request body. (required)
389 The object takes the form of:
390
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]391{ # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]392 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
393 "contentType": "A String", # The type of data feed.
394 "name": "A String", # A descriptive name of the data feed.
395 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
396 "format": { # Format of the feed file.
397 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
398 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
399 "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.
400 },
401 "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.
402 "username": "A String", # An optional user name for fetch_url.
403 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
404 "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.
405 "weekday": "A String", # The day of the week the feed file should be fetched.
406 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
407 "password": "A String", # An optional password for fetch_url.
408 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
409 },
410 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
411 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
412 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
413 "A String",
414 ],
415 "id": "A String", # The ID of the data feed.
416 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
417 }
418
419
420Returns:
421 An object of the form:
422
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]423 { # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]424 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
425 "contentType": "A String", # The type of data feed.
426 "name": "A String", # A descriptive name of the data feed.
427 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
428 "format": { # Format of the feed file.
429 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
430 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
431 "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.
432 },
433 "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.
434 "username": "A String", # An optional user name for fetch_url.
435 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
436 "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.
437 "weekday": "A String", # The day of the week the feed file should be fetched.
438 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
439 "password": "A String", # An optional password for fetch_url.
440 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
441 },
442 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
443 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
444 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
445 "A String",
446 ],
447 "id": "A String", # The ID of the data feed.
448 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
449 }</pre>
450</div>
451
452<div class="method">
453 <code class="details" id="update">update(merchantId, datafeedId, body)</code>
454 <pre>Updates a datafeed of your Merchant Center account.
455
456Args:
457 merchantId: string, A parameter (required)
458 datafeedId: string, A parameter (required)
459 body: object, The request body. (required)
460 The object takes the form of:
461
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]462{ # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]463 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
464 "contentType": "A String", # The type of data feed.
465 "name": "A String", # A descriptive name of the data feed.
466 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
467 "format": { # Format of the feed file.
468 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
469 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
470 "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.
471 },
472 "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.
473 "username": "A String", # An optional user name for fetch_url.
474 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
475 "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.
476 "weekday": "A String", # The day of the week the feed file should be fetched.
477 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
478 "password": "A String", # An optional password for fetch_url.
479 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
480 },
481 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
482 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
483 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
484 "A String",
485 ],
486 "id": "A String", # The ID of the data feed.
487 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
488 }
489
490
491Returns:
492 An object of the form:
493
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]494 { # Datafeed data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]495 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed".
496 "contentType": "A String", # The type of data feed.
497 "name": "A String", # A descriptive name of the data feed.
498 "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed.
499 "format": { # Format of the feed file.
500 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
501 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
502 "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.
503 },
504 "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.
505 "username": "A String", # An optional user name for fetch_url.
506 "hour": 42, # The hour of the day the feed file should be fetched (0-24).
507 "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.
508 "weekday": "A String", # The day of the week the feed file should be fetched.
509 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
510 "password": "A String", # An optional password for fetch_url.
511 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
512 },
513 "targetCountry": "A String", # The two-letter ISO 3166 country where the items in the feed will be included in the search index.
514 "fileName": "A String", # The filename of the feed. All feeds must have a unique file name.
515 "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center).
516 "A String",
517 ],
518 "id": "A String", # The ID of the data feed.
519 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
520 }</pre>
521</div>
522
523</body></html>