Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 78 | <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p> |
Craig Citro | 065b530 | 2014-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 Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(merchantId, datafeedId, dryRun=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 82 | <p class="firstline">Deletes a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(merchantId, datafeedId)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 85 | <p class="firstline">Retrieves a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 87 | <code><a href="#insert">insert(merchantId, body, dryRun=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 88 | <p class="firstline">Registers a datafeed with your Merchant Center account. This method can only be called for non-multi-client accounts.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 91 | <p class="firstline">Lists the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
Craig Citro | e633be1 | 2015-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 Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(merchantId, datafeedId, body, dryRun=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 97 | <p class="firstline">Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts. This method supports patch semantics.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 98 | <p class="toc_element"> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 99 | <code><a href="#update">update(merchantId, datafeedId, body, dryRun=None)</a></code></p> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 100 | <p class="firstline">Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 103 | <code class="details" id="custombatch">custombatch(body, dryRun=None)</code> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 104 | <pre>A description of how to use this function |
| 105 | |
| 106 | Args: |
| 107 | body: object, The request body. (required) |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { |
Craig Citro | e633be1 | 2015-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 Citro | 065b530 | 2014-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 Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 115 | "datafeed": { # Datafeed data. # The data feed to insert. |
Craig Citro | 065b530 | 2014-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". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 117 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 118 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 119 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 127 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 132 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 133 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 134 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 135 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 136 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 137 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 138 | "A String", |
| 139 | ], |
| 140 | "id": "A String", # The ID of the data feed. |
| 141 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 142 | }, |
| 143 | "merchantId": "A String", # The ID of the managing account. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 144 | "method": "A String", |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 145 | }, |
| 146 | ], |
| 147 | } |
| 148 | |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 149 | dryRun: boolean, Flag to run the request in dry-run mode. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 150 | |
| 151 | Returns: |
| 152 | An object of the form: |
| 153 | |
| 154 | { |
| 155 | "kind": "content#datafeedsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse". |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 156 | "entries": [ # The result of the execution of the batch requests. |
| 157 | { # A batch entry encoding a single non-batch datafeeds response. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 158 | "batchId": 42, # The ID of the request entry this entry responds to. |
| 159 | "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. |
| 160 | "message": "A String", # The message of the first error in errors. |
| 161 | "code": 42, # The HTTP status of the first error in errors. |
| 162 | "errors": [ # A list of errors. |
| 163 | { # An error returned by the API. |
| 164 | "reason": "A String", # The error code. |
| 165 | "domain": "A String", # The domain of the error. |
| 166 | "message": "A String", # A description of the error. |
| 167 | }, |
| 168 | ], |
| 169 | }, |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 170 | "datafeed": { # Datafeed data. # The requested data feed. Defined if and only if the request was successful. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 171 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 172 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 173 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 174 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 175 | "format": { # Format of the feed file. |
| 176 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 177 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 178 | "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. |
| 179 | }, |
| 180 | "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. |
| 181 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 182 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 183 | "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. |
| 184 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 185 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 186 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 187 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 188 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 189 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 190 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 191 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 192 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 193 | "A String", |
| 194 | ], |
| 195 | "id": "A String", # The ID of the data feed. |
| 196 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 197 | }, |
| 198 | }, |
| 199 | ], |
| 200 | }</pre> |
| 201 | </div> |
| 202 | |
| 203 | <div class="method"> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 204 | <code class="details" id="delete">delete(merchantId, datafeedId, dryRun=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 205 | <pre>Deletes a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 206 | |
| 207 | Args: |
| 208 | merchantId: string, A parameter (required) |
| 209 | datafeedId: string, A parameter (required) |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 210 | dryRun: boolean, Flag to run the request in dry-run mode. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 211 | </pre> |
| 212 | </div> |
| 213 | |
| 214 | <div class="method"> |
| 215 | <code class="details" id="get">get(merchantId, datafeedId)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 216 | <pre>Retrieves a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 217 | |
| 218 | Args: |
| 219 | merchantId: string, A parameter (required) |
| 220 | datafeedId: string, A parameter (required) |
| 221 | |
| 222 | Returns: |
| 223 | An object of the form: |
| 224 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 225 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 226 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 227 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 228 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 229 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 230 | "format": { # Format of the feed file. |
| 231 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 232 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 233 | "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. |
| 234 | }, |
| 235 | "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. |
| 236 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 237 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 238 | "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. |
| 239 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 240 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 241 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 242 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 243 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 244 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 245 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 246 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 247 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 248 | "A String", |
| 249 | ], |
| 250 | "id": "A String", # The ID of the data feed. |
| 251 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 252 | }</pre> |
| 253 | </div> |
| 254 | |
| 255 | <div class="method"> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 256 | <code class="details" id="insert">insert(merchantId, body, dryRun=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 257 | <pre>Registers a datafeed with your Merchant Center account. This method can only be called for non-multi-client accounts. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 258 | |
| 259 | Args: |
| 260 | merchantId: string, A parameter (required) |
| 261 | body: object, The request body. (required) |
| 262 | The object takes the form of: |
| 263 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 264 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 265 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 266 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 267 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 268 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 269 | "format": { # Format of the feed file. |
| 270 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 271 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 272 | "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. |
| 273 | }, |
| 274 | "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. |
| 275 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 276 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 277 | "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. |
| 278 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 279 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 280 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 281 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 282 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 283 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 284 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 285 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 286 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 287 | "A String", |
| 288 | ], |
| 289 | "id": "A String", # The ID of the data feed. |
| 290 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 291 | } |
| 292 | |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 293 | dryRun: boolean, Flag to run the request in dry-run mode. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 294 | |
| 295 | Returns: |
| 296 | An object of the form: |
| 297 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 298 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 299 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 300 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 301 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 302 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 303 | "format": { # Format of the feed file. |
| 304 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 305 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 306 | "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. |
| 307 | }, |
| 308 | "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. |
| 309 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 310 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 311 | "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. |
| 312 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 313 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 314 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 315 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 316 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 317 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 318 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 319 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 320 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 321 | "A String", |
| 322 | ], |
| 323 | "id": "A String", # The ID of the data feed. |
| 324 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 325 | }</pre> |
| 326 | </div> |
| 327 | |
| 328 | <div class="method"> |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 329 | <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 330 | <pre>Lists the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 331 | |
| 332 | Args: |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 333 | merchantId: string, The ID of the managing account. (required) |
| 334 | pageToken: string, The token returned by the previous request. |
| 335 | maxResults: integer, The maximum number of products to return in the response, used for paging. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 336 | |
| 337 | Returns: |
| 338 | An object of the form: |
| 339 | |
| 340 | { |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 341 | "nextPageToken": "A String", # The token for the retrieval of the next page of datafeeds. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 342 | "kind": "content#datafeedsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse". |
| 343 | "resources": [ |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 344 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 345 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 346 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 347 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 348 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 349 | "format": { # Format of the feed file. |
| 350 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 351 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 352 | "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. |
| 353 | }, |
| 354 | "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. |
| 355 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 356 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 357 | "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. |
| 358 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 359 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 360 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 361 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 362 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 363 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 364 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 365 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 366 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 367 | "A String", |
| 368 | ], |
| 369 | "id": "A String", # The ID of the data feed. |
| 370 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 371 | }, |
| 372 | ], |
| 373 | }</pre> |
| 374 | </div> |
| 375 | |
| 376 | <div class="method"> |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 377 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 378 | <pre>Retrieves the next page of results. |
| 379 | |
| 380 | Args: |
| 381 | previous_request: The request for the previous page. (required) |
| 382 | previous_response: The response from the request for the previous page. (required) |
| 383 | |
| 384 | Returns: |
| 385 | A request object that you can call 'execute()' on to request the next |
| 386 | page. Returns None if there are no more items in the collection. |
| 387 | </pre> |
| 388 | </div> |
| 389 | |
| 390 | <div class="method"> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 391 | <code class="details" id="patch">patch(merchantId, datafeedId, body, dryRun=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 392 | <pre>Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts. This method supports patch semantics. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 393 | |
| 394 | Args: |
| 395 | merchantId: string, A parameter (required) |
| 396 | datafeedId: string, A parameter (required) |
| 397 | body: object, The request body. (required) |
| 398 | The object takes the form of: |
| 399 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 400 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 401 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 402 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 403 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 404 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 405 | "format": { # Format of the feed file. |
| 406 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 407 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 408 | "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. |
| 409 | }, |
| 410 | "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. |
| 411 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 412 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 413 | "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. |
| 414 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 415 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 416 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 417 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 418 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 419 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 420 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 421 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 422 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 423 | "A String", |
| 424 | ], |
| 425 | "id": "A String", # The ID of the data feed. |
| 426 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 427 | } |
| 428 | |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 429 | dryRun: boolean, Flag to run the request in dry-run mode. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 430 | |
| 431 | Returns: |
| 432 | An object of the form: |
| 433 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 434 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 435 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 436 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 437 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 438 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 439 | "format": { # Format of the feed file. |
| 440 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 441 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 442 | "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. |
| 443 | }, |
| 444 | "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. |
| 445 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 446 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 447 | "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. |
| 448 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 449 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 450 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 451 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 452 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 453 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 454 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 455 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 456 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 457 | "A String", |
| 458 | ], |
| 459 | "id": "A String", # The ID of the data feed. |
| 460 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 461 | }</pre> |
| 462 | </div> |
| 463 | |
| 464 | <div class="method"> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 465 | <code class="details" id="update">update(merchantId, datafeedId, body, dryRun=None)</code> |
Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 466 | <pre>Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 467 | |
| 468 | Args: |
| 469 | merchantId: string, A parameter (required) |
| 470 | datafeedId: string, A parameter (required) |
| 471 | body: object, The request body. (required) |
| 472 | The object takes the form of: |
| 473 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 474 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 475 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 476 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 477 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 478 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 479 | "format": { # Format of the feed file. |
| 480 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 481 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 482 | "columnDelimiter": "A String", # Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. |
| 483 | }, |
| 484 | "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. |
| 485 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 486 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 487 | "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. |
| 488 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 489 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 490 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 491 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 492 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 493 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 494 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 495 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 496 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 497 | "A String", |
| 498 | ], |
| 499 | "id": "A String", # The ID of the data feed. |
| 500 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 501 | } |
| 502 | |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 503 | dryRun: boolean, Flag to run the request in dry-run mode. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 504 | |
| 505 | Returns: |
| 506 | An object of the form: |
| 507 | |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 508 | { # Datafeed data. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 509 | "kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 510 | "contentType": "A String", # The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 511 | "name": "A String", # A descriptive name of the data feed. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 512 | "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 513 | "format": { # Format of the feed file. |
| 514 | "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. |
| 515 | "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. |
| 516 | "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. |
| 517 | }, |
| 518 | "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. |
| 519 | "username": "A String", # An optional user name for fetch_url. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 520 | "hour": 42, # The hour of the day the feed file should be fetched (0-23). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 521 | "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. |
| 522 | "weekday": "A String", # The day of the week the feed file should be fetched. |
| 523 | "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". |
| 524 | "password": "A String", # An optional password for fetch_url. |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 525 | "minuteOfHour": 42, # The minute of the hour the feed file should be fetched (0-59). Read-only. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 526 | "dayOfMonth": 42, # The day of the month the feed file should be fetched (1-31). |
| 527 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 528 | "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 Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 529 | "fileName": "A String", # The filename of the feed. All feeds must have a unique file name. |
| 530 | "intendedDestinations": [ # The list of intended destinations (corresponds to checked check boxes in Merchant Center). |
| 531 | "A String", |
| 532 | ], |
| 533 | "id": "A String", # The ID of the data feed. |
| 534 | "attributeLanguage": "A String", # The two-letter ISO 639-1 language in which the attributes are defined in the data feed. |
| 535 | }</pre> |
| 536 | </div> |
| 537 | |
| 538 | </body></html> |