1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="merchantapi_datasources_v1.html">Merchant API</a> . <a href="merchantapi_datasources_v1.accounts.html">accounts</a> . <a href="merchantapi_datasources_v1.accounts.dataSources.html">dataSources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="merchantapi_datasources_v1.accounts.dataSources.fileUploads.html">fileUploads()</a></code>
</p>
<p class="firstline">Returns the fileUploads Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates the new data source configuration for the given account. This method always creates a new data source.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a data source from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#fetch">fetch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the data source configuration for the given account.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the configurations for data sources for the given account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates the new data source configuration for the given account. This method always creates a new data source.
Args:
parent: string, Required. The account where this data source will be created. Format: `accounts/{account}` (required)
body: object, The request body.
The object takes the form of:
{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.
"dataSourceId": "A String", # Output only. The data source id.
"displayName": "A String", # Required. The displayed data source name in the Merchant Center UI.
"fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file.
"fetchSettings": { # Fetch details to deliver the data source. # Optional. Fetch details to deliver the data source. It contains settings for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary based on the frequency of fetching.
"dayOfMonth": 42, # Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.
"dayOfWeek": "A String", # Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.
"enabled": True or False, # Optional. Enables or pauses the fetch schedule.
"fetchUri": "A String", # Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.
"frequency": "A String", # Required. The frequency describing fetch schedule.
"password": "A String", # Optional. An optional password for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
"timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"timeZone": "A String", # Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # Optional. An optional user name for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
},
"fileInputType": "A String", # Output only. The type of file input.
"fileName": "A String", # Optional. The file name of the data source. Required for `UPLOAD` file input type.
},
"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API.
"localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source.
},
"name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`
"primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
"A String",
],
"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced.
"takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
"destinations": [ # Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination.
{ # Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections.
"destination": "A String", # [Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections.
"state": "A String", # The state of the destination.
},
],
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`.
},
"productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source.
},
"promotionDataSource": { # The promotion data source. # The [promotion](https://support.google.com/merchants/answer/2906014) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source.
"targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460).
},
"regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.
"dataSourceId": "A String", # Output only. The data source id.
"displayName": "A String", # Required. The displayed data source name in the Merchant Center UI.
"fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file.
"fetchSettings": { # Fetch details to deliver the data source. # Optional. Fetch details to deliver the data source. It contains settings for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary based on the frequency of fetching.
"dayOfMonth": 42, # Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.
"dayOfWeek": "A String", # Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.
"enabled": True or False, # Optional. Enables or pauses the fetch schedule.
"fetchUri": "A String", # Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.
"frequency": "A String", # Required. The frequency describing fetch schedule.
"password": "A String", # Optional. An optional password for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
"timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"timeZone": "A String", # Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # Optional. An optional user name for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
},
"fileInputType": "A String", # Output only. The type of file input.
"fileName": "A String", # Optional. The file name of the data source. Required for `UPLOAD` file input type.
},
"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API.
"localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source.
},
"name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`
"primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
"A String",
],
"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced.
"takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
"destinations": [ # Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination.
{ # Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections.
"destination": "A String", # [Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections.
"state": "A String", # The state of the destination.
},
],
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`.
},
"productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source.
},
"promotionDataSource": { # The promotion data source. # The [promotion](https://support.google.com/merchants/answer/2906014) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source.
"targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460).
},
"regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a data source from your Merchant Center account.
Args:
name: string, Required. The name of the data source to delete. Format: `accounts/{account}/dataSources/{datasource}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="fetch">fetch(name, body=None, x__xgafv=None)</code>
<pre>Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.
Args:
name: string, Required. The name of the data source resource to fetch. Format: `accounts/{account}/dataSources/{datasource}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the FetchDataSource method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves the data source configuration for the given account.
Args:
name: string, Required. The name of the data source to retrieve. Format: `accounts/{account}/dataSources/{datasource}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.
"dataSourceId": "A String", # Output only. The data source id.
"displayName": "A String", # Required. The displayed data source name in the Merchant Center UI.
"fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file.
"fetchSettings": { # Fetch details to deliver the data source. # Optional. Fetch details to deliver the data source. It contains settings for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary based on the frequency of fetching.
"dayOfMonth": 42, # Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.
"dayOfWeek": "A String", # Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.
"enabled": True or False, # Optional. Enables or pauses the fetch schedule.
"fetchUri": "A String", # Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.
"frequency": "A String", # Required. The frequency describing fetch schedule.
"password": "A String", # Optional. An optional password for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
"timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"timeZone": "A String", # Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # Optional. An optional user name for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
},
"fileInputType": "A String", # Output only. The type of file input.
"fileName": "A String", # Optional. The file name of the data source. Required for `UPLOAD` file input type.
},
"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API.
"localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source.
},
"name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`
"primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
"A String",
],
"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced.
"takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
"destinations": [ # Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination.
{ # Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections.
"destination": "A String", # [Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections.
"state": "A String", # The state of the destination.
},
],
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`.
},
"productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source.
},
"promotionDataSource": { # The promotion data source. # The [promotion](https://support.google.com/merchants/answer/2906014) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source.
"targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460).
},
"regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the configurations for data sources for the given account.
Args:
parent: string, Required. The account to list data sources for. Format: `accounts/{account}` (required)
pageSize: integer, Optional. The maximum number of data sources to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of data sources will be returned.
pageToken: string, Optional. A page token, received from a previous `ListDataSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSources` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the ListDataSources method.
"dataSources": [ # The data sources from the specified account.
{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.
"dataSourceId": "A String", # Output only. The data source id.
"displayName": "A String", # Required. The displayed data source name in the Merchant Center UI.
"fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file.
"fetchSettings": { # Fetch details to deliver the data source. # Optional. Fetch details to deliver the data source. It contains settings for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary based on the frequency of fetching.
"dayOfMonth": 42, # Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.
"dayOfWeek": "A String", # Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.
"enabled": True or False, # Optional. Enables or pauses the fetch schedule.
"fetchUri": "A String", # Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.
"frequency": "A String", # Required. The frequency describing fetch schedule.
"password": "A String", # Optional. An optional password for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
"timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"timeZone": "A String", # Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # Optional. An optional user name for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
},
"fileInputType": "A String", # Output only. The type of file input.
"fileName": "A String", # Optional. The file name of the data source. Required for `UPLOAD` file input type.
},
"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API.
"localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source.
},
"name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`
"primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
"A String",
],
"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced.
"takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
"destinations": [ # Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination.
{ # Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections.
"destination": "A String", # [Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections.
"state": "A String", # The state of the destination.
},
],
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`.
},
"productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source.
},
"promotionDataSource": { # The promotion data source. # The [promotion](https://support.google.com/merchants/answer/2906014) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source.
"targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460).
},
"regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.
Args:
name: string, Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` (required)
body: object, The request body.
The object takes the form of:
{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.
"dataSourceId": "A String", # Output only. The data source id.
"displayName": "A String", # Required. The displayed data source name in the Merchant Center UI.
"fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file.
"fetchSettings": { # Fetch details to deliver the data source. # Optional. Fetch details to deliver the data source. It contains settings for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary based on the frequency of fetching.
"dayOfMonth": 42, # Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.
"dayOfWeek": "A String", # Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.
"enabled": True or False, # Optional. Enables or pauses the fetch schedule.
"fetchUri": "A String", # Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.
"frequency": "A String", # Required. The frequency describing fetch schedule.
"password": "A String", # Optional. An optional password for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
"timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"timeZone": "A String", # Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # Optional. An optional user name for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
},
"fileInputType": "A String", # Output only. The type of file input.
"fileName": "A String", # Optional. The file name of the data source. Required for `UPLOAD` file input type.
},
"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API.
"localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source.
},
"name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`
"primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
"A String",
],
"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced.
"takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
"destinations": [ # Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination.
{ # Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections.
"destination": "A String", # [Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections.
"state": "A String", # The state of the destination.
},
],
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`.
},
"productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source.
},
"promotionDataSource": { # The promotion data source. # The [promotion](https://support.google.com/merchants/answer/2906014) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source.
"targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460).
},
"regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
}
updateMask: string, Required. The list of data source fields to be updated. Fields specified in the update mask without a value specified in the body will be deleted from the data source. Providing special "*" value for full data source replacement is not supported. For example, If you insert `updateMask=displayName` in the request, it will only update the `displayName` leaving all other fields untouched.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.
"dataSourceId": "A String", # Output only. The data source id.
"displayName": "A String", # Required. The displayed data source name in the Merchant Center UI.
"fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file.
"fetchSettings": { # Fetch details to deliver the data source. # Optional. Fetch details to deliver the data source. It contains settings for `FETCH` and `GOOGLE_SHEETS` file input types. The required fields vary based on the frequency of fetching.
"dayOfMonth": 42, # Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency.
"dayOfWeek": "A String", # Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency.
"enabled": True or False, # Optional. Enables or pauses the fetch schedule.
"fetchUri": "A String", # Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files.
"frequency": "A String", # Required. The frequency describing fetch schedule.
"password": "A String", # Optional. An optional password for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
"timeOfDay": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"timeZone": "A String", # Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by default. For example, "America/Los_Angeles".
"username": "A String", # Optional. An optional user name for fetch_uri. Used for [submitting data sources through SFTP](https://support.google.com/merchants/answer/13813117).
},
"fileInputType": "A String", # Output only. The type of file input.
"fileName": "A String", # Optional. The file name of the data source. Required for `UPLOAD` file input type.
},
"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API.
"localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source.
},
"name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`
"primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
"A String",
],
"defaultRule": { # Default rule management of the data source. # Optional. Default rule management of the data source. If set, the linked data sources will be replaced.
"takeFromDataSources": [ # Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
"destinations": [ # Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination.
{ # Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections.
"destination": "A String", # [Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections.
"state": "A String", # The state of the destination.
},
],
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
"legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`.
},
"productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source.
},
"promotionDataSource": { # The promotion data source. # The [promotion](https://support.google.com/merchants/answer/2906014) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items in the data source.
"targetCountry": "A String", # Required. Immutable. The target country used as part of the unique identifier. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). Promotions are only available in selected [countries](https://support.google.com/merchants/answer/4588460).
},
"regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source.
"contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided.
"feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).
},
"supplementalProductDataSource": { # The supplemental data source for local and online products. After creation, you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products.
"contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
"referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed.
{ # Data source reference can be used to manage related data sources within the data source service.
"primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`
"self": True or False, # Self should be used to reference the primary data source itself.
"supplementalDataSourceName": "A String", # Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`
},
],
},
}</pre>
</div>
</body></html>
|