Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / content_v2.datafeeds.html
blob: b91cea7f091300cc495281fdaa1ca58aeb32f353 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#custombatch">custombatch(body=None, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Deletes a datafeed configuration from your Merchant Center account.</p>
83<p class="toc_element">
84 <code><a href="#fetchnow">fetchnow(merchantId, datafeedId, dryRun=None)</a></code></p>
85<p class="firstline">Invokes a fetch for the datafeed in your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(merchantId, datafeedId)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Retrieves a datafeed configuration from your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#insert">insert(merchantId, body=None, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Registers a datafeed configuration with your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]92<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]93 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Lists the configurations for datafeeds in your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#update">update(merchantId, datafeedId, body=None, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Updates a datafeed configuration of your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 <pre>Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]105
106Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 "datafeedId": "A String", # The ID of the data feed to get, delete or fetch.
115 "datafeed": { # Datafeed configuration data. # The data feed to insert.
Dan O'Mearadd494642020-05-01 07:42: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", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
118 #
119 # Acceptable values are:
120 # - "`local products`"
121 # - "`product inventory`"
122 # - "`products`"
123 "name": "A String", # Required for insert. A descriptive name of the data feed.
124 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]125 "format": { # Format of the feed file.
126 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 #
128 # Acceptable values are:
129 # - "`latin-1`"
130 # - "`utf-16be`"
131 # - "`utf-16le`"
132 # - "`utf-8`"
133 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]134 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 #
136 # Acceptable values are:
137 # - "`normal character`"
138 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]139 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]140 #
141 # Acceptable values are:
142 # - "`pipe`"
143 # - "`tab`"
144 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]145 },
146 "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.
147 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]148 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]149 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]151 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]152 #
153 # Acceptable values are:
154 # - "`monday`"
155 # - "`tuesday`"
156 # - "`wednesday`"
157 # - "`thursday`"
158 # - "`friday`"
159 # - "`saturday`"
160 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]161 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
162 "password": "A String", # An optional password for fetch_url.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]163 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]164 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
165 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 "targets": [ # The targets this feed should apply to (country, language, destinations).
169 {
170 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]171 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
172 #
173 # List of supported destinations (if available to the account):
174 # - DisplayAds
175 # - Shopping
176 # - ShoppingActions
177 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 "A String",
179 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
182 "A String",
183 ],
184 },
185 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]186 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]187 "A String",
188 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]189 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]190 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
191 },
192 "merchantId": "A String", # The ID of the managing account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]193 "method": "A String", # The method of the batch entry.
194 #
195 # Acceptable values are:
196 # - "`delete`"
197 # - "`fetchNow`"
198 # - "`get`"
199 # - "`insert`"
200 # - "`update`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]201 },
202 ],
203 }
204
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]206
207Returns:
208 An object of the form:
209
210 {
211 "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]212 "entries": [ # The result of the execution of the batch requests.
213 { # A batch entry encoding a single non-batch datafeeds response.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]214 "batchId": 42, # The ID of the request entry this entry responds to.
215 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 "message": "A String", # The message of the first error in `errors`.
217 "code": 42, # The HTTP status of the first error in `errors`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]218 "errors": [ # A list of errors.
219 { # An error returned by the API.
220 "reason": "A String", # The error code.
221 "domain": "A String", # The domain of the error.
222 "message": "A String", # A description of the error.
223 },
224 ],
225 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 "datafeed": { # Datafeed configuration data. # The requested data feed. Defined if and only if the request was successful.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
228 "contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
229 #
230 # Acceptable values are:
231 # - "`local products`"
232 # - "`product inventory`"
233 # - "`products`"
234 "name": "A String", # Required for insert. A descriptive name of the data feed.
235 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]236 "format": { # Format of the feed file.
237 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]238 #
239 # Acceptable values are:
240 # - "`latin-1`"
241 # - "`utf-16be`"
242 # - "`utf-16le`"
243 # - "`utf-8`"
244 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]245 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]246 #
247 # Acceptable values are:
248 # - "`normal character`"
249 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]250 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 #
252 # Acceptable values are:
253 # - "`pipe`"
254 # - "`tab`"
255 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]256 },
257 "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.
258 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]259 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]262 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 #
264 # Acceptable values are:
265 # - "`monday`"
266 # - "`tuesday`"
267 # - "`wednesday`"
268 # - "`thursday`"
269 # - "`friday`"
270 # - "`saturday`"
271 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]272 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
273 "password": "A String", # An optional password for fetch_url.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]274 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]275 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
276 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]278 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 "targets": [ # The targets this feed should apply to (country, language, destinations).
280 {
281 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]282 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
283 #
284 # List of supported destinations (if available to the account):
285 # - DisplayAds
286 # - Shopping
287 # - ShoppingActions
288 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 "A String",
290 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
293 "A String",
294 ],
295 },
296 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]297 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]298 "A String",
299 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]300 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]301 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
302 },
303 },
304 ],
305 }</pre>
306</div>
307
308<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]309 <code class="details" id="delete">delete(merchantId, datafeedId, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 <pre>Deletes a datafeed configuration from your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]311
312Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
314 datafeedId: string, The ID of the datafeed. (required)
315 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]316</pre>
317</div>
318
319<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 <code class="details" id="fetchnow">fetchnow(merchantId, datafeedId, dryRun=None)</code>
321 <pre>Invokes a fetch for the datafeed in your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]322
323Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
325 datafeedId: string, The ID of the datafeed to be fetched. (required)
326 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]327
328Returns:
329 An object of the form:
330
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 {
332 "kind": "content#datafeedsFetchNowResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".
333 }</pre>
334</div>
335
336<div class="method">
337 <code class="details" id="get">get(merchantId, datafeedId)</code>
338 <pre>Retrieves a datafeed configuration from your Merchant Center account.
339
340Args:
341 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
342 datafeedId: string, The ID of the datafeed. (required)
343
344Returns:
345 An object of the form:
346
347 { # Datafeed configuration data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]348 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
349 "contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
350 #
351 # Acceptable values are:
352 # - "`local products`"
353 # - "`product inventory`"
354 # - "`products`"
355 "name": "A String", # Required for insert. A descriptive name of the data feed.
356 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]357 "format": { # Format of the feed file.
358 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 #
360 # Acceptable values are:
361 # - "`latin-1`"
362 # - "`utf-16be`"
363 # - "`utf-16le`"
364 # - "`utf-8`"
365 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]366 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]367 #
368 # Acceptable values are:
369 # - "`normal character`"
370 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]371 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]372 #
373 # Acceptable values are:
374 # - "`pipe`"
375 # - "`tab`"
376 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]377 },
378 "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.
379 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]380 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]381 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]383 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 #
385 # Acceptable values are:
386 # - "`monday`"
387 # - "`tuesday`"
388 # - "`wednesday`"
389 # - "`thursday`"
390 # - "`friday`"
391 # - "`saturday`"
392 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]393 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
394 "password": "A String", # An optional password for fetch_url.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]395 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]396 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
397 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]399 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 "targets": [ # The targets this feed should apply to (country, language, destinations).
401 {
402 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]403 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
404 #
405 # List of supported destinations (if available to the account):
406 # - DisplayAds
407 # - Shopping
408 # - ShoppingActions
409 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]410 "A String",
411 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]413 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
414 "A String",
415 ],
416 },
417 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]419 "A String",
420 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]421 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]422 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
423 }</pre>
424</div>
425
426<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 <code class="details" id="insert">insert(merchantId, body=None, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]428 <pre>Registers a datafeed configuration with your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]429
430Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]432 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]433 The object takes the form of:
434
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]435{ # Datafeed configuration data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]436 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
437 "contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
438 #
439 # Acceptable values are:
440 # - "`local products`"
441 # - "`product inventory`"
442 # - "`products`"
443 "name": "A String", # Required for insert. A descriptive name of the data feed.
444 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]445 "format": { # Format of the feed file.
446 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]447 #
448 # Acceptable values are:
449 # - "`latin-1`"
450 # - "`utf-16be`"
451 # - "`utf-16le`"
452 # - "`utf-8`"
453 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]454 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]455 #
456 # Acceptable values are:
457 # - "`normal character`"
458 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]459 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]460 #
461 # Acceptable values are:
462 # - "`pipe`"
463 # - "`tab`"
464 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]465 },
466 "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.
467 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]468 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]469 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]470 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]471 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]472 #
473 # Acceptable values are:
474 # - "`monday`"
475 # - "`tuesday`"
476 # - "`wednesday`"
477 # - "`thursday`"
478 # - "`friday`"
479 # - "`saturday`"
480 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]483 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]484 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
485 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]486 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]487 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]488 "targets": [ # The targets this feed should apply to (country, language, destinations).
489 {
490 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]491 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
492 #
493 # List of supported destinations (if available to the account):
494 # - DisplayAds
495 # - Shopping
496 # - ShoppingActions
497 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 "A String",
499 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]500 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]501 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
502 "A String",
503 ],
504 },
505 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]506 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]507 "A String",
508 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]509 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]510 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
511 }
512
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]513 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]514
515Returns:
516 An object of the form:
517
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]518 { # Datafeed configuration data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]519 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
520 "contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
521 #
522 # Acceptable values are:
523 # - "`local products`"
524 # - "`product inventory`"
525 # - "`products`"
526 "name": "A String", # Required for insert. A descriptive name of the data feed.
527 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]528 "format": { # Format of the feed file.
529 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]530 #
531 # Acceptable values are:
532 # - "`latin-1`"
533 # - "`utf-16be`"
534 # - "`utf-16le`"
535 # - "`utf-8`"
536 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]537 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]538 #
539 # Acceptable values are:
540 # - "`normal character`"
541 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]542 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]543 #
544 # Acceptable values are:
545 # - "`pipe`"
546 # - "`tab`"
547 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]548 },
549 "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.
550 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]551 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]552 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]554 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]555 #
556 # Acceptable values are:
557 # - "`monday`"
558 # - "`tuesday`"
559 # - "`wednesday`"
560 # - "`thursday`"
561 # - "`friday`"
562 # - "`saturday`"
563 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]564 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
565 "password": "A String", # An optional password for fetch_url.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]566 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]567 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
568 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]570 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]571 "targets": [ # The targets this feed should apply to (country, language, destinations).
572 {
573 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]574 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
575 #
576 # List of supported destinations (if available to the account):
577 # - DisplayAds
578 # - Shopping
579 # - ShoppingActions
580 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 "A String",
582 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]583 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
585 "A String",
586 ],
587 },
588 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]589 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]590 "A String",
591 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]592 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]593 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
594 }</pre>
595</div>
596
597<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]598 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]599 <pre>Lists the configurations for datafeeds in your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]600
601Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]602 merchantId: string, The ID of the account that manages the datafeeds. This account cannot be a multi-client account. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]603 pageToken: string, The token returned by the previous request.
604 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]605
606Returns:
607 An object of the form:
608
609 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]610 "nextPageToken": "A String", # The token for the retrieval of the next page of datafeeds.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]611 "kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
612 "resources": [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]613 { # Datafeed configuration data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]614 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
615 "contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
616 #
617 # Acceptable values are:
618 # - "`local products`"
619 # - "`product inventory`"
620 # - "`products`"
621 "name": "A String", # Required for insert. A descriptive name of the data feed.
622 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]623 "format": { # Format of the feed file.
624 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]625 #
626 # Acceptable values are:
627 # - "`latin-1`"
628 # - "`utf-16be`"
629 # - "`utf-16le`"
630 # - "`utf-8`"
631 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]632 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]633 #
634 # Acceptable values are:
635 # - "`normal character`"
636 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]637 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]638 #
639 # Acceptable values are:
640 # - "`pipe`"
641 # - "`tab`"
642 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]643 },
644 "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.
645 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]646 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]647 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]648 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]649 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]650 #
651 # Acceptable values are:
652 # - "`monday`"
653 # - "`tuesday`"
654 # - "`wednesday`"
655 # - "`thursday`"
656 # - "`friday`"
657 # - "`saturday`"
658 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]659 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
660 "password": "A String", # An optional password for fetch_url.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]661 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]662 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
663 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]664 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]665 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]666 "targets": [ # The targets this feed should apply to (country, language, destinations).
667 {
668 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]669 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
670 #
671 # List of supported destinations (if available to the account):
672 # - DisplayAds
673 # - Shopping
674 # - ShoppingActions
675 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]676 "A String",
677 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]678 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]679 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
680 "A String",
681 ],
682 },
683 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]684 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]685 "A String",
686 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]687 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]688 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
689 },
690 ],
691 }</pre>
692</div>
693
694<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]695 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
696 <pre>Retrieves the next page of results.
697
698Args:
699 previous_request: The request for the previous page. (required)
700 previous_response: The response from the request for the previous page. (required)
701
702Returns:
703 A request object that you can call 'execute()' on to request the next
704 page. Returns None if there are no more items in the collection.
705 </pre>
706</div>
707
708<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]709 <code class="details" id="update">update(merchantId, datafeedId, body=None, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]710 <pre>Updates a datafeed configuration of your Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]711
712Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]713 merchantId: string, The ID of the account that manages the datafeed. This account cannot be a multi-client account. (required)
714 datafeedId: string, The ID of the datafeed. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]715 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]716 The object takes the form of:
717
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]718{ # Datafeed configuration data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]719 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
720 "contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
721 #
722 # Acceptable values are:
723 # - "`local products`"
724 # - "`product inventory`"
725 # - "`products`"
726 "name": "A String", # Required for insert. A descriptive name of the data feed.
727 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]728 "format": { # Format of the feed file.
729 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]730 #
731 # Acceptable values are:
732 # - "`latin-1`"
733 # - "`utf-16be`"
734 # - "`utf-16le`"
735 # - "`utf-8`"
736 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]737 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]738 #
739 # Acceptable values are:
740 # - "`normal character`"
741 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]742 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]743 #
744 # Acceptable values are:
745 # - "`pipe`"
746 # - "`tab`"
747 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]748 },
749 "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.
750 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]751 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]752 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]753 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]754 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]755 #
756 # Acceptable values are:
757 # - "`monday`"
758 # - "`tuesday`"
759 # - "`wednesday`"
760 # - "`thursday`"
761 # - "`friday`"
762 # - "`saturday`"
763 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]764 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
765 "password": "A String", # An optional password for fetch_url.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]766 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]767 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
768 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]769 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]770 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]771 "targets": [ # The targets this feed should apply to (country, language, destinations).
772 {
773 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]774 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
775 #
776 # List of supported destinations (if available to the account):
777 # - DisplayAds
778 # - Shopping
779 # - ShoppingActions
780 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]781 "A String",
782 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]783 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]784 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
785 "A String",
786 ],
787 },
788 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]789 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]790 "A String",
791 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]792 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]793 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
794 }
795
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]796 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]797
798Returns:
799 An object of the form:
800
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]801 { # Datafeed configuration data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]802 "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`"
803 "contentType": "A String", # Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.
804 #
805 # Acceptable values are:
806 # - "`local products`"
807 # - "`product inventory`"
808 # - "`products`"
809 "name": "A String", # Required for insert. A descriptive name of the data feed.
810 "contentLanguage": "A String", # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]811 "format": { # Format of the feed file.
812 "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]813 #
814 # Acceptable values are:
815 # - "`latin-1`"
816 # - "`utf-16be`"
817 # - "`utf-16le`"
818 # - "`utf-8`"
819 # - "`windows-1252`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]820 "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]821 #
822 # Acceptable values are:
823 # - "`normal character`"
824 # - "`value quoting`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]825 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]826 #
827 # Acceptable values are:
828 # - "`pipe`"
829 # - "`tab`"
830 # - "`tilde`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]831 },
832 "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.
833 "username": "A String", # An optional user name for fetch_url.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]834 "hour": 42, # The hour of the day the feed file should be fetched (0-23).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]835 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]836 "paused": True or False, # Whether the scheduled fetch is paused or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]837 "weekday": "A String", # The day of the week the feed file should be fetched.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]838 #
839 # Acceptable values are:
840 # - "`monday`"
841 # - "`tuesday`"
842 # - "`wednesday`"
843 # - "`thursday`"
844 # - "`friday`"
845 # - "`saturday`"
846 # - "`sunday`"
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]847 "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".
848 "password": "A String", # An optional password for fetch_url.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]849 "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]850 "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31).
851 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]852 "targetCountry": "A String", # [DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]853 "fileName": "A String", # Required. The filename of the feed. All feeds must have a unique file name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]854 "targets": [ # The targets this feed should apply to (country, language, destinations).
855 {
856 "country": "A String", # The country where the items in the feed will be included in the search index, represented as a CLDR territory code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]857 "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
858 #
859 # List of supported destinations (if available to the account):
860 # - DisplayAds
861 # - Shopping
862 # - ShoppingActions
863 # - SurfacesAcrossGoogle
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]864 "A String",
865 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]866 "language": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]867 "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
868 "A String",
869 ],
870 },
871 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]872 "intendedDestinations": [ # [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]873 "A String",
874 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]875 "id": "A String", # Required for update. The ID of the data feed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]876 "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed.
877 }</pre>
878</div>
879
880</body></html>