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