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 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
|
<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_products_v1.html">Merchant API</a> . <a href="merchantapi_products_v1.accounts.html">accounts</a> . <a href="merchantapi_products_v1.accounts.products.html">products</a></h1>
<h2>Instance Methods</h2>
<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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.</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 processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.</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>
<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="get">get(name, x__xgafv=None)</code>
<pre>Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.
Args:
name: string, Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of: `content_language~feed_label~offer_id` example for product name is `accounts/123/products/en~US~sku123`. A legacy local product name would be `accounts/123/products/local~en~US~sku123`. Note: For calls to the v1beta version, the `product` section consists of: `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.
"automatedDiscounts": { # Information regarding Automated Discounts. # Output only. The automated discounts information for the product.
"gadPrice": { # The price represented as a number and currency. # The current sale price for products with a price optimized using Google Automated Discounts (GAD). Absent if the information about the GAD_price of the product is not available.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"priorPrice": { # The price represented as a number and currency. # The price prior to the application of the first price reduction. Absent if the information about the prior price of the product is not available.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"priorPriceProgressive": { # The price represented as a number and currency. # The price prior to the application of consecutive price reductions. Absent if the information about the prior price of the product is not available.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
},
"contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
"customAttributes": [ # Output only. A list of custom (merchant-provided) attributes. It can also be used to submit any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
{ # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
"groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute.
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
},
],
"dataSource": "A String", # Output only. The primary data source of the product.
"feedLabel": "A String", # Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters are`A-Z`, `0-9`, hyphen and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087)
"legacyLocal": True or False, # Output only. Determines whether the product is **only** targeting local destinations and whether the product name should be distinguished with a `local~` prefix. For example, `accounts/123/products/local~en~US~sku123`.
"name": "A String", # The name of the product. Format: `accounts/{account}/products/{product}` where the last section `product` consists of: `content_language~feed_label~offer_id` example for product name is `accounts/123/products/en~US~sku123`. A legacy local product name would be `accounts/123/products/local~en~US~sku123`. Note: For calls to the v1beta version, the `product` section consists of: `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
"offerId": "A String", # Output only. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [product data specification](https://support.google.com/merchants/answer/188494#id) for details.
"productAttributes": { # Product attributes. # Output only. A list of strongly-typed product attributes.
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads.
"adult": True or False, # Set to true if the item is targeted towards adults.
"ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item.
"autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"availability": "A String", # [Availability](https://support.google.com/merchants/answer/6324448) status of the item.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google".
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information.
{ # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.
"certificationAuthority": "A String", # The certification authority.
"certificationCode": "A String", # The certification code. Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification.
"certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"cloudExportAdditionalProperties": [ # Extra fields to export to the Cloud Retail program.
{ # Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
"boolValue": True or False, # Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
"floatValue": [ # Float values of the given property. For example for a TV product 1.2345. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order.
3.14,
],
"intValue": [ # Integer values of the given property. For example, 1080 for a TV product's Screen Resolution. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order.
"A String",
],
"maxValue": 3.14, # Maximum float value of the given property. For example for a TV product 100.00.
"minValue": 3.14, # Minimum float value of the given property. For example for a TV product 1.00.
"propertyName": "A String", # Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.
"textValue": [ # Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters.
"A String",
],
"unitCode": "A String", # Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256B.
},
],
"color": "A String", # [Color](https://support.google.com/merchants/answer/6324487) of the item. For example, "red".
"condition": "A String", # [Condition](https://support.google.com/merchants/answer/6324469) or state of the item.
"costOfGoodsSold": { # The price represented as a number and currency. # Cost of goods sold. Used for gross profit reporting.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"customLabel0": "A String", # [Custom label 0](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel1": "A String", # [Custom label 1](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # [Custom label 2](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel3": "A String", # [Custom label 3](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel4": "A String", # [Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"description": "A String", # Description of the item.
"disclosureDate": "A String", # The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations. For more information, see [Display ads attribute specification](https://support.google.com/merchants/answer/6069387).
"A String",
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
"energyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). For more information, see [Excluded destination](https://support.google.com/merchants/answer/6324486). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
"A String",
],
"expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future.
"externalSellerId": "A String", # Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
"freeShippingThreshold": [ # Conditions to be met for a product to have free shipping.
{ # Conditions to be met for a product to have free shipping.
"country": "A String", # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.
"priceThreshold": { # The price represented as a number and currency. # The minimum product price for the shipping cost to become free. Represented as a number.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
},
],
"gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item.
"googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
"gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.
"A String",
],
"identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
"imageLink": "A String", # URL of an image of the item.
"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. For more information, see [Included destination](https://support.google.com/merchants/answer/7501026). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
"A String",
],
"installment": { # A message that represents installment. # Number and amount of installments to pay for an item.
"amount": { # The price represented as a number and currency. # The amount the buyer has to pay per month.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"creditType": "A String", # Type of installment payments.
"downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"months": "A String", # The number of installments the buyer has to pay.
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
"link": "A String", # URL directly linking to your item's page on your online store.
"linkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13871172) for business hosted local storefront.
"loyaltyPoints": { # A message that represents loyalty points. # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
},
"loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
{ # A message that represents loyalty program.
"cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase.
"memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a business. The corresponding program must be linked to the Merchant Center account.
"shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.
"tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program.
},
],
"material": "A String", # The [material](https://support.google.com/merchants/answer/6324410) of which the item is made. For example, "Leather" or "Cotton".
"maxEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"maximumRetailPrice": { # The price represented as a number and currency. # Maximum retail price (MRP) of the item. Applicable to India only.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
"multipack": "A String", # The number of identical products in a business-defined multipack.
"pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots.
"pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930).
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"productDetails": [ # Technical specification or additional product details.
{ # The product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
"sectionName": "A String", # The section header used to group a set of product details.
},
],
"productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
"value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
},
"productHighlights": [ # Bullet points describing the most relevant [product highlights](https://support.google.com/merchants/answer/9216100).
"A String",
],
"productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
"value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
},
"productTypes": [ # Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/7052112#product_category)).
"A String",
],
"productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
"unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
"value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
"productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
"value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
},
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"salePriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Date range during which the item is on sale, see [product data specification](https://support.google.com/merchants/answer/7052112#price_and_availability).
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"shipping": [ # Shipping rules.
{ # The Shipping of the product.
"country": "A String", # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
"maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present.
"maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present.
"minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.
"minTransitTime": "A String", # Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it is not required if maxTransitTime is present.
"postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
"price": { # The price represented as a number and currency. # Fixed shipping price, represented as a number.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information.
"service": "A String", # A free-form description of the service class or delivery speed.
},
],
"shippingHeight": { # The ShippingDimension of the product. # Height of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"shippingLength": { # The ShippingDimension of the product. # Length of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingWeight": { # The ShippingWeight of the product. # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
"shippingWidth": { # The ShippingDimension of the product. # Width of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shoppingAdsExcludedCountries": [ # List of country codes [(ISO 3166-1 alpha-2)](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
"A String",
],
"size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value, see [Size](https://support.google.com/merchants/answer/6324492).
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502).
"sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see [Size type](https://support.google.com/merchants/answer/6324497).
"A String",
],
"structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. # Structured description, for algorithmically (AI)-generated descriptions.
"content": "A String", # The description text Maximum length is 5000 characters
"digitalSourceType": "A String", # The digital source type. Following [IPTC](https://cv.iptc.org/newscodes/digitalsourcetype).
},
"structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. # Structured title, for algorithmically (AI)-generated titles.
"content": "A String", # The title text Maximum length is 150 characters
"digitalSourceType": "A String", # The digital source type. Following [IPTC](https://cv.iptc.org/newscodes/digitalsourcetype).
},
"subscriptionCost": { # The SubscriptionCost of the product. # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"amount": { # The price represented as a number and currency. # The amount the buyer has to pay per subscription period.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"period": "A String", # The type of subscription period. Supported values are: * "`month`" * "`year`"
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
},
"sustainabilityIncentives": [ # The list of sustainability incentive programs.
{ # Information regarding sustainability-related incentive programs such as rebates or tax relief.
"amount": { # The price represented as a number and currency. # The fixed amount of the incentive.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"percentage": 3.14, # The percentage of the sale price that the incentive is applied to.
"type": "A String", # Sustainability incentive program.
},
],
"title": "A String", # Title of the item.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"unitPricingBaseMeasure": { # The UnitPricingBaseMeasure of the product. # The preference of the denominator of the unit price.
"unit": "A String", # The unit of the denominator.
"value": "A String", # The denominator of the unit price.
},
"unitPricingMeasure": { # The UnitPricingMeasure of the product. # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information.
},
"productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
"creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # The intended destinations for the product.
{ # The destination status of the product status.
"approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
"A String",
],
"disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.
"A String",
],
"pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
"A String",
],
"reportingContext": "A String", # The name of the reporting context.
},
],
"googleExpirationDate": "A String", # Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"itemLevelIssues": [ # A list of all issues associated with the product.
{ # The ItemLevelIssue of the product status.
"applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
"A String",
],
"attribute": "A String", # The attribute's name, if the issue is caused by a single attribute.
"code": "A String", # The error code of the issue.
"description": "A String", # A short issue description in English.
"detail": "A String", # A detailed issue description in English.
"documentation": "A String", # The URL of a web page to help with resolving this issue.
"reportingContext": "A String", # The reporting context the issue applies to.
"resolution": "A String", # Whether the issue can be resolved by the business.
"severity": "A String", # How this issue affects serving of the offer.
},
],
"lastUpdateDate": "A String", # Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
},
"versionNumber": "A String", # Output only. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. If the operation is prevented, the aborted exception will be thrown.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.
Args:
parent: string, Required. The account to list processed products for. Format: `accounts/{account}` (required)
pageSize: integer, The maximum number of products 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 default page size of 25 products will be returned.
pageToken: string, A page token, received from a previous `ListProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProducts` 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 ListProducts method.
"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.
"products": [ # The processed products from the specified account. These are your processed products after applying rules and supplemental data sources.
{ # The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.
"automatedDiscounts": { # Information regarding Automated Discounts. # Output only. The automated discounts information for the product.
"gadPrice": { # The price represented as a number and currency. # The current sale price for products with a price optimized using Google Automated Discounts (GAD). Absent if the information about the GAD_price of the product is not available.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"priorPrice": { # The price represented as a number and currency. # The price prior to the application of the first price reduction. Absent if the information about the prior price of the product is not available.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"priorPriceProgressive": { # The price represented as a number and currency. # The price prior to the application of consecutive price reductions. Absent if the information about the prior price of the product is not available.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
},
"contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
"customAttributes": [ # Output only. A list of custom (merchant-provided) attributes. It can also be used to submit any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
{ # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
"groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute.
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
},
],
"dataSource": "A String", # Output only. The primary data source of the product.
"feedLabel": "A String", # Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters are`A-Z`, `0-9`, hyphen and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087)
"legacyLocal": True or False, # Output only. Determines whether the product is **only** targeting local destinations and whether the product name should be distinguished with a `local~` prefix. For example, `accounts/123/products/local~en~US~sku123`.
"name": "A String", # The name of the product. Format: `accounts/{account}/products/{product}` where the last section `product` consists of: `content_language~feed_label~offer_id` example for product name is `accounts/123/products/en~US~sku123`. A legacy local product name would be `accounts/123/products/local~en~US~sku123`. Note: For calls to the v1beta version, the `product` section consists of: `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
"offerId": "A String", # Output only. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [product data specification](https://support.google.com/merchants/answer/188494#id) for details.
"productAttributes": { # Product attributes. # Output only. A list of strongly-typed product attributes.
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads.
"adult": True or False, # Set to true if the item is targeted towards adults.
"ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item.
"autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"availability": "A String", # [Availability](https://support.google.com/merchants/answer/6324448) status of the item.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google".
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information.
{ # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.
"certificationAuthority": "A String", # The certification authority.
"certificationCode": "A String", # The certification code. Maximum length is 2000 characters.
"certificationName": "A String", # The name of the certification.
"certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.
},
],
"cloudExportAdditionalProperties": [ # Extra fields to export to the Cloud Retail program.
{ # Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
"boolValue": True or False, # Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
"floatValue": [ # Float values of the given property. For example for a TV product 1.2345. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order.
3.14,
],
"intValue": [ # Integer values of the given property. For example, 1080 for a TV product's Screen Resolution. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order.
"A String",
],
"maxValue": 3.14, # Maximum float value of the given property. For example for a TV product 100.00.
"minValue": 3.14, # Minimum float value of the given property. For example for a TV product 1.00.
"propertyName": "A String", # Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.
"textValue": [ # Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters.
"A String",
],
"unitCode": "A String", # Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256B.
},
],
"color": "A String", # [Color](https://support.google.com/merchants/answer/6324487) of the item. For example, "red".
"condition": "A String", # [Condition](https://support.google.com/merchants/answer/6324469) or state of the item.
"costOfGoodsSold": { # The price represented as a number and currency. # Cost of goods sold. Used for gross profit reporting.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"customLabel0": "A String", # [Custom label 0](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel1": "A String", # [Custom label 1](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # [Custom label 2](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel3": "A String", # [Custom label 3](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"customLabel4": "A String", # [Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.
"description": "A String", # Description of the item.
"disclosureDate": "A String", # The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations. For more information, see [Display ads attribute specification](https://support.google.com/merchants/answer/6069387).
"A String",
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
"energyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). For more information, see [Excluded destination](https://support.google.com/merchants/answer/6324486). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
"A String",
],
"expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future.
"externalSellerId": "A String", # Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
"freeShippingThreshold": [ # Conditions to be met for a product to have free shipping.
{ # Conditions to be met for a product to have free shipping.
"country": "A String", # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.
"priceThreshold": { # The price represented as a number and currency. # The minimum product price for the shipping cost to become free. Represented as a number.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
},
],
"gender": "A String", # Target [gender](https://support.google.com/merchants/answer/6324479) of the item.
"googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
"gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.
"A String",
],
"identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
"imageLink": "A String", # URL of an image of the item.
"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. For more information, see [Included destination](https://support.google.com/merchants/answer/7501026). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
"A String",
],
"installment": { # A message that represents installment. # Number and amount of installments to pay for an item.
"amount": { # The price represented as a number and currency. # The amount the buyer has to pay per month.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"creditType": "A String", # Type of installment payments.
"downpayment": { # The price represented as a number and currency. # The up-front down payment amount the buyer has to pay.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"months": "A String", # The number of installments the buyer has to pay.
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
"link": "A String", # URL directly linking to your item's page on your online store.
"linkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13871172) for business hosted local storefront.
"loyaltyPoints": { # A message that represents loyalty points. # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
},
"loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
{ # A message that represents loyalty program.
"cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase.
"memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a business. The corresponding program must be linked to the Merchant Center account.
"shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.
"tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program.
},
],
"material": "A String", # The [material](https://support.google.com/merchants/answer/6324410) of which the item is made. For example, "Leather" or "Cotton".
"maxEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"maximumRetailPrice": { # The price represented as a number and currency. # Maximum retail price (MRP) of the item. Applicable to India only.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minEnergyEfficiencyClass": "A String", # The [energy efficiency class](https://support.google.com/merchants/answer/7562785) as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"mobileLinkTemplate": "A String", # [Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
"multipack": "A String", # The number of identical products in a business-defined multipack.
"pattern": "A String", # The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots.
"pause": "A String", # Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930).
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"productDetails": [ # Technical specification or additional product details.
{ # The product details.
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
"sectionName": "A String", # The section header used to group a set of product details.
},
],
"productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
"value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
},
"productHighlights": [ # Bullet points describing the most relevant [product highlights](https://support.google.com/merchants/answer/9216100).
"A String",
],
"productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
"value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
},
"productTypes": [ # Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/7052112#product_category)).
"A String",
],
"productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
"unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
"value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
"productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
"value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
},
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"salePriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Date range during which the item is on sale, see [product data specification](https://support.google.com/merchants/answer/7052112#price_and_availability).
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"shipping": [ # Shipping rules.
{ # The Shipping of the product.
"country": "A String", # The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
"maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present.
"maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present.
"minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.
"minTransitTime": "A String", # Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it is not required if maxTransitTime is present.
"postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
"price": { # The price represented as a number and currency. # Fixed shipping price, represented as a number.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information.
"service": "A String", # A free-form description of the service class or delivery speed.
},
],
"shippingHeight": { # The ShippingDimension of the product. # Height of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"shippingLength": { # The ShippingDimension of the product. # Length of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingWeight": { # The ShippingWeight of the product. # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
"shippingWidth": { # The ShippingDimension of the product. # Width of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shoppingAdsExcludedCountries": [ # List of country codes [(ISO 3166-1 alpha-2)](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
"A String",
],
"size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value, see [Size](https://support.google.com/merchants/answer/6324492).
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502).
"sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see [Size type](https://support.google.com/merchants/answer/6324497).
"A String",
],
"structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. # Structured description, for algorithmically (AI)-generated descriptions.
"content": "A String", # The description text Maximum length is 5000 characters
"digitalSourceType": "A String", # The digital source type. Following [IPTC](https://cv.iptc.org/newscodes/digitalsourcetype).
},
"structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. # Structured title, for algorithmically (AI)-generated titles.
"content": "A String", # The title text Maximum length is 150 characters
"digitalSourceType": "A String", # The digital source type. Following [IPTC](https://cv.iptc.org/newscodes/digitalsourcetype).
},
"subscriptionCost": { # The SubscriptionCost of the product. # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"amount": { # The price represented as a number and currency. # The amount the buyer has to pay per subscription period.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"period": "A String", # The type of subscription period. Supported values are: * "`month`" * "`year`"
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
},
"sustainabilityIncentives": [ # The list of sustainability incentive programs.
{ # Information regarding sustainability-related incentive programs such as rebates or tax relief.
"amount": { # The price represented as a number and currency. # The fixed amount of the incentive.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"percentage": 3.14, # The percentage of the sale price that the incentive is applied to.
"type": "A String", # Sustainability incentive program.
},
],
"title": "A String", # Title of the item.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"unitPricingBaseMeasure": { # The UnitPricingBaseMeasure of the product. # The preference of the denominator of the unit price.
"unit": "A String", # The unit of the denominator.
"value": "A String", # The denominator of the unit price.
},
"unitPricingMeasure": { # The UnitPricingMeasure of the product. # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
"virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information.
},
"productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
"creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # The intended destinations for the product.
{ # The destination status of the product status.
"approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
"A String",
],
"disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.
"A String",
],
"pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
"A String",
],
"reportingContext": "A String", # The name of the reporting context.
},
],
"googleExpirationDate": "A String", # Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"itemLevelIssues": [ # A list of all issues associated with the product.
{ # The ItemLevelIssue of the product status.
"applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
"A String",
],
"attribute": "A String", # The attribute's name, if the issue is caused by a single attribute.
"code": "A String", # The error code of the issue.
"description": "A String", # A short issue description in English.
"detail": "A String", # A detailed issue description in English.
"documentation": "A String", # The URL of a web page to help with resolving this issue.
"reportingContext": "A String", # The reporting context the issue applies to.
"resolution": "A String", # Whether the issue can be resolved by the business.
"severity": "A String", # How this issue affects serving of the offer.
},
],
"lastUpdateDate": "A String", # Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
},
"versionNumber": "A String", # Output only. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. If the operation is prevented, the aborted exception will be thrown.
},
],
}</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>
</body></html>
|