google-apis-retail_v2 0.22.0 → 0.26.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0de88c36c0573420ced084acf029452d123c7e8fc20805d40fca726b24c51bfa
4
- data.tar.gz: 461c060306fe8051f904064aea1e6124c8942473d28b63d9c3e3ce8bc9991e5d
3
+ metadata.gz: 318900177ed96ac687e26131c704910f998c25b977983cd1c586e98a646ec47c
4
+ data.tar.gz: f0d7cca5a575fb9d73b164f066f4e53a0a81b55e1e2c0725bdac27608a01e0bb
5
5
  SHA512:
6
- metadata.gz: e131a7e93d5065447e886f388f1e8d4c6651aef4f3d668d0117a377b5f1474873de1ff0bcae2809a40dfd7e16325a77b79eb3f39ee1eafc1794d76c3489279db
7
- data.tar.gz: 8f5f5f63747bb06f970818d1eddfa127147d8bbb0c9d49d1dd667c44c249bb09db2889476e385b5066fe645d42367ae4ccd8599f47cc6c9532148405abaf74d7
6
+ metadata.gz: 8ed1e6b8e259b9b070322e3e7e30a2e94cdd461edbaceac343d4f60f84f71873adf804e294ab3ba9d7f278137c7c03ff90eb8352690a54a5988f2b4375734a83
7
+ data.tar.gz: 84e06e9151aef169cc5354ecee48ac90d335e53abae9f4f7961148949cdf6535da237eb1afb4ccc80ab5312ee866307c20986eefec96ec358ee01224b8fb0f93
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.26.0 (2022-01-27)
4
+
5
+ * Regenerated from discovery document revision 20220121
6
+
7
+ ### v0.25.0 (2022-01-13)
8
+
9
+ * Regenerated from discovery document revision 20220106
10
+ * Regenerated using generator version 0.4.1
11
+
12
+ ### v0.24.0 (2021-12-16)
13
+
14
+ * Regenerated from discovery document revision 20211210
15
+
16
+ ### v0.23.0 (2021-12-09)
17
+
18
+ * Regenerated from discovery document revision 20211203
19
+
3
20
  ### v0.22.0 (2021-11-17)
4
21
 
5
22
  * Regenerated from discovery document revision 20211116
data/OVERVIEW.md CHANGED
@@ -51,7 +51,7 @@ require "google/apis/retail_v2"
51
51
  client = Google::Apis::RetailV2::CloudRetailService.new
52
52
 
53
53
  # Authenticate calls
54
- client.authentication = # ... use the googleauth gem to create credentials
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
55
  ```
56
56
 
57
57
  See the class reference docs for information on the methods you can call from a client.
@@ -696,9 +696,8 @@ module Google
696
696
  alias_method :indexable?, :indexable
697
697
 
698
698
  # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
699
- # the key is "lengths_cm". At most 400 values are allowed.Otherwise, an
700
- # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
701
- # set. Otherwise, an INVALID_ARGUMENT error is returned.
699
+ # the key is "lengths_cm". Exactly one of text or numbers should be set.
700
+ # Otherwise, an INVALID_ARGUMENT error is returned.
702
701
  # Corresponds to the JSON property `numbers`
703
702
  # @return [Array<Float>]
704
703
  attr_accessor :numbers
@@ -712,11 +711,8 @@ module Google
712
711
  alias_method :searchable?, :searchable
713
712
 
714
713
  # The textual values of this custom attribute. For example, `["yellow", "green"]`
715
- # when the key is "color". At most 400 values are allowed. Empty values are not
716
- # allowed. Each value must be a UTF-8 encoded string with a length limit of 256
717
- # characters. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of
718
- # text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is
719
- # returned.
714
+ # when the key is "color". Exactly one of text or numbers should be set.
715
+ # Otherwise, an INVALID_ARGUMENT error is returned.
720
716
  # Corresponds to the JSON property `text`
721
717
  # @return [Array<String>]
722
718
  attr_accessor :text
@@ -781,6 +777,9 @@ module Google
781
777
  # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
782
778
  # imports: * `user_event` (default): One JSON UserEvent per line. * `
783
779
  # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719.
780
+ # Supported values for control imports: * 'control' (default): One JSON Control
781
+ # per line. Supported values for catalog attribute imports: * 'catalog_attribute'
782
+ # (default): One CSV CatalogAttribute per line.
784
783
  # Corresponds to the JSON property `dataSchema`
785
784
  # @return [String]
786
785
  attr_accessor :data_schema
@@ -1434,8 +1433,8 @@ module Google
1434
1433
  attr_accessor :original_price
1435
1434
 
1436
1435
  # Price of the product. Google Merchant Center property [price](https://support.
1437
- # google.com/merchants/answer/6324371). Schema.org property [Offer.
1438
- # priceSpecification](https://schema.org/priceSpecification).
1436
+ # google.com/merchants/answer/6324371). Schema.org property [Offer.price](https:/
1437
+ # /schema.org/price).
1439
1438
  # Corresponds to the JSON property `price`
1440
1439
  # @return [Float]
1441
1440
  attr_accessor :price
@@ -1523,7 +1522,10 @@ module Google
1523
1522
  # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
1524
1523
  # be a UTF-8 encoded string with a length limit of 128 characters. * For
1525
1524
  # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
1526
- # key0LikeThis or KEY_1_LIKE_THIS.
1525
+ # `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
1526
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
1527
+ # encoded string with a length limit of 256 characters. * For number attributes,
1528
+ # at most 400 values are allowed.
1527
1529
  # Corresponds to the JSON property `attributes`
1528
1530
  # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
1529
1531
  attr_accessor :attributes
@@ -1534,9 +1536,9 @@ module Google
1534
1536
  attr_accessor :audience
1535
1537
 
1536
1538
  # The online availability of the Product. Default to Availability.IN_STOCK.
1537
- # Google Merchant Center Property [availability](https://support.google.com/
1538
- # merchants/answer/6324448). Schema.org Property [Offer.availability](https://
1539
- # schema.org/availability).
1539
+ # Corresponding properties: Google Merchant Center property [availability](https:
1540
+ # //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
1541
+ # availability](https://schema.org/availability).
1540
1542
  # Corresponds to the JSON property `availability`
1541
1543
  # @return [String]
1542
1544
  attr_accessor :availability
@@ -1553,9 +1555,9 @@ module Google
1553
1555
 
1554
1556
  # The brands of the product. A maximum of 30 brands are allowed. Each brand must
1555
1557
  # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
1556
- # an INVALID_ARGUMENT error is returned. Google Merchant Center property [brand](
1557
- # https://support.google.com/merchants/answer/6324351). Schema.org property [
1558
- # Product.brand](https://schema.org/brand).
1558
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
1559
+ # Merchant Center property [brand](https://support.google.com/merchants/answer/
1560
+ # 6324351). Schema.org property [Product.brand](https://schema.org/brand).
1559
1561
  # Corresponds to the JSON property `brands`
1560
1562
  # @return [Array<String>]
1561
1563
  attr_accessor :brands
@@ -1572,15 +1574,17 @@ module Google
1572
1574
  # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
1573
1575
  # Empty values are not allowed. Each value must be a UTF-8 encoded string with
1574
1576
  # a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
1575
- # returned. Google Merchant Center property google_product_category. Schema.org
1576
- # property [Product.category] (https://schema.org/category). [
1577
- # mc_google_product_category]: https://support.google.com/merchants/answer/
1578
- # 6324436
1577
+ # returned. Corresponding properties: Google Merchant Center property
1578
+ # google_product_category. Schema.org property [Product.category] (https://
1579
+ # schema.org/category). [mc_google_product_category]: https://support.google.com/
1580
+ # merchants/answer/6324436
1579
1581
  # Corresponds to the JSON property `categories`
1580
1582
  # @return [Array<String>]
1581
1583
  attr_accessor :categories
1582
1584
 
1583
- # The id of the collection members when type is Type.COLLECTION. Should not set
1585
+ # The id of the collection members when type is Type.COLLECTION. Non-existent
1586
+ # product ids are allowed. The type of the members must be either Type.PRIMARY
1587
+ # or Type.VARIANT otherwise and INVALID_ARGUMENT error is thrown. Should not set
1584
1588
  # it for other types. A maximum of 1000 values are allowed. Otherwise, an
1585
1589
  # INVALID_ARGUMENT error is return.
1586
1590
  # Corresponds to the JSON property `collectionMemberIds`
@@ -1593,21 +1597,21 @@ module Google
1593
1597
  attr_accessor :color_info
1594
1598
 
1595
1599
  # The condition of the product. Strongly encouraged to use the standard values: "
1596
- # new", "refurbished", "used". A maximum of 5 values are allowed per Product.
1597
- # Each value must be a UTF-8 encoded string with a length limit of 128
1598
- # characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant
1599
- # Center property [condition](https://support.google.com/merchants/answer/
1600
- # 6324469). Schema.org property [Offer.itemCondition](https://schema.org/
1601
- # itemCondition).
1600
+ # new", "refurbished", "used". A maximum of 1 value is allowed per Product. Each
1601
+ # value must be a UTF-8 encoded string with a length limit of 128 characters.
1602
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
1603
+ # Google Merchant Center property [condition](https://support.google.com/
1604
+ # merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://
1605
+ # schema.org/itemCondition).
1602
1606
  # Corresponds to the JSON property `conditions`
1603
1607
  # @return [Array<String>]
1604
1608
  attr_accessor :conditions
1605
1609
 
1606
1610
  # Product description. This field must be a UTF-8 encoded string with a length
1607
1611
  # limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
1608
- # Google Merchant Center property [description](https://support.google.com/
1609
- # merchants/answer/6324468). schema.org property [Product.description](https://
1610
- # schema.org/description).
1612
+ # Corresponding properties: Google Merchant Center property [description](https:/
1613
+ # /support.google.com/merchants/answer/6324468). Schema.org property [Product.
1614
+ # description](https://schema.org/description).
1611
1615
  # Corresponds to the JSON property `description`
1612
1616
  # @return [String]
1613
1617
  attr_accessor :description
@@ -1617,8 +1621,8 @@ module Google
1617
1621
  # expire_time. However, the product can still be retrieved by ProductService.
1618
1622
  # GetProduct and ProductService.ListProducts. expire_time must be later than
1619
1623
  # available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
1620
- # Google Merchant Center property [expiration_date](https://support.google.com/
1621
- # merchants/answer/6324499).
1624
+ # Corresponding properties: Google Merchant Center property [expiration_date](
1625
+ # https://support.google.com/merchants/answer/6324499).
1622
1626
  # Corresponds to the JSON property `expireTime`
1623
1627
  # @return [String]
1624
1628
  attr_accessor :expire_time
@@ -1633,12 +1637,13 @@ module Google
1633
1637
  # The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
1634
1638
  # encoded string with a length limit of 128 characters. Otherwise, an
1635
1639
  # INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
1636
- # an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](
1637
- # https://support.google.com/merchants/answer/6324461). Schema.org property [
1638
- # Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/
1639
- # gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](
1640
- # https://schema.org/gtin13) or [Product.gtin14](https://schema.org/gtin14). If
1641
- # the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
1640
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
1641
+ # Merchant Center property [gtin](https://support.google.com/merchants/answer/
1642
+ # 6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [
1643
+ # Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/
1644
+ # gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](
1645
+ # https://schema.org/gtin14). If the value is not a valid GTIN, an
1646
+ # INVALID_ARGUMENT error is returned.
1642
1647
  # Corresponds to the JSON property `gtin`
1643
1648
  # @return [String]
1644
1649
  attr_accessor :gtin
@@ -1647,27 +1652,28 @@ module Google
1647
1652
  # example, this field is "id_1", if name is `projects/*/locations/global/
1648
1653
  # catalogs/default_catalog/branches/default_branch/products/id_1`. This field
1649
1654
  # must be a UTF-8 encoded string with a length limit of 128 characters.
1650
- # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
1651
- # property [id](https://support.google.com/merchants/answer/6324405). Schema.org
1652
- # Property [Product.sku](https://schema.org/sku).
1655
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
1656
+ # Google Merchant Center property [id](https://support.google.com/merchants/
1657
+ # answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
1653
1658
  # Corresponds to the JSON property `id`
1654
1659
  # @return [String]
1655
1660
  attr_accessor :id
1656
1661
 
1657
1662
  # Product images for the product.Highly recommended to put the main image to the
1658
- # first. A maximum of 300 images are allowed. Google Merchant Center property [
1659
- # image_link](https://support.google.com/merchants/answer/6324350). Schema.org
1660
- # property [Product.image](https://schema.org/image).
1663
+ # first. A maximum of 300 images are allowed. Corresponding properties: Google
1664
+ # Merchant Center property [image_link](https://support.google.com/merchants/
1665
+ # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
1661
1666
  # Corresponds to the JSON property `images`
1662
1667
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Image>]
1663
1668
  attr_accessor :images
1664
1669
 
1665
1670
  # Language of the title/description and other string attributes. Use language
1666
- # tags defined by BCP 47. For product prediction, this field is ignored and the
1667
- # model automatically detects the text language. The Product can include text in
1668
- # different languages, but duplicating Products to provide text in multiple
1669
- # languages can result in degraded model performance. For product search this
1670
- # field is in use. It defaults to "en-US" if unset.
1671
+ # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For
1672
+ # product prediction, this field is ignored and the model automatically detects
1673
+ # the text language. The Product can include text in different languages, but
1674
+ # duplicating Products to provide text in multiple languages can result in
1675
+ # degraded model performance. For product search this field is in use. It
1676
+ # defaults to "en-US" if unset.
1671
1677
  # Corresponds to the JSON property `languageCode`
1672
1678
  # @return [String]
1673
1679
  attr_accessor :language_code
@@ -1675,9 +1681,9 @@ module Google
1675
1681
  # The material of the product. For example, "leather", "wooden". A maximum of 20
1676
1682
  # values are allowed. Each value must be a UTF-8 encoded string with a length
1677
1683
  # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
1678
- # Google Merchant Center property [material](https://support.google.com/
1679
- # merchants/answer/6324410). Schema.org property [Product.material](https://
1680
- # schema.org/material).
1684
+ # Corresponding properties: Google Merchant Center property [material](https://
1685
+ # support.google.com/merchants/answer/6324410). Schema.org property [Product.
1686
+ # material](https://schema.org/material).
1681
1687
  # Corresponds to the JSON property `materials`
1682
1688
  # @return [Array<String>]
1683
1689
  attr_accessor :materials
@@ -1691,9 +1697,10 @@ module Google
1691
1697
  # The pattern or graphic print of the product. For example, "striped", "polka
1692
1698
  # dot", "paisley". A maximum of 20 values are allowed per Product. Each value
1693
1699
  # must be a UTF-8 encoded string with a length limit of 128 characters.
1694
- # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
1695
- # property [pattern](https://support.google.com/merchants/answer/6324483).
1696
- # Schema.org property [Product.pattern](https://schema.org/pattern).
1700
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
1701
+ # Google Merchant Center property [pattern](https://support.google.com/merchants/
1702
+ # answer/6324483). Schema.org property [Product.pattern](https://schema.org/
1703
+ # pattern).
1697
1704
  # Corresponds to the JSON property `patterns`
1698
1705
  # @return [Array<String>]
1699
1706
  attr_accessor :patterns
@@ -1708,10 +1715,9 @@ module Google
1708
1715
  # can only be empty or set to the same value as id. For VARIANT Products, this
1709
1716
  # field cannot be empty. A maximum of 2,000 products are allowed to share the
1710
1717
  # same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.
1711
- # Google Merchant Center Property [item_group_id](https://support.google.com/
1712
- # merchants/answer/6324507). Schema.org Property [Product.inProductGroupWithID](
1713
- # https://schema.org/inProductGroupWithID). This field must be enabled before it
1714
- # can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).
1718
+ # Corresponding properties: Google Merchant Center property [item_group_id](
1719
+ # https://support.google.com/merchants/answer/6324507). Schema.org property [
1720
+ # Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
1715
1721
  # Corresponds to the JSON property `primaryProductId`
1716
1722
  # @return [String]
1717
1723
  attr_accessor :primary_product_id
@@ -1760,10 +1766,11 @@ module Google
1760
1766
  # system and size type are empty, while size value is "32 inches". A maximum of
1761
1767
  # 20 values are allowed per Product. Each value must be a UTF-8 encoded string
1762
1768
  # with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
1763
- # returned. Google Merchant Center property [size](https://support.google.com/
1764
- # merchants/answer/6324492), [size_type](https://support.google.com/merchants/
1765
- # answer/6324497) and [size_system](https://support.google.com/merchants/answer/
1766
- # 6324502). Schema.org property [Product.size](https://schema.org/size).
1769
+ # returned. Corresponding properties: Google Merchant Center property [size](
1770
+ # https://support.google.com/merchants/answer/6324492), [size_type](https://
1771
+ # support.google.com/merchants/answer/6324497), and [size_system](https://
1772
+ # support.google.com/merchants/answer/6324502). Schema.org property [Product.
1773
+ # size](https://schema.org/size).
1767
1774
  # Corresponds to the JSON property `sizes`
1768
1775
  # @return [Array<String>]
1769
1776
  attr_accessor :sizes
@@ -1772,17 +1779,18 @@ module Google
1772
1779
  # Product. This value must be a UTF-8 encoded string with a length limit of 1,
1773
1780
  # 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
1774
1781
  # be used for filtering recommendation results by passing the tag as part of the
1775
- # PredictRequest.filter. Google Merchant Center property [custom_label_0–4](
1776
- # https://support.google.com/merchants/answer/6324473).
1782
+ # PredictRequest.filter. Corresponding properties: Google Merchant Center
1783
+ # property [custom_label_0–4](https://support.google.com/merchants/answer/
1784
+ # 6324473).
1777
1785
  # Corresponds to the JSON property `tags`
1778
1786
  # @return [Array<String>]
1779
1787
  attr_accessor :tags
1780
1788
 
1781
1789
  # Required. Product title. This field must be a UTF-8 encoded string with a
1782
1790
  # length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
1783
- # returned. Google Merchant Center property [title](https://support.google.com/
1784
- # merchants/answer/6324415). Schema.org property [Product.name](https://schema.
1785
- # org/name).
1791
+ # returned. Corresponding properties: Google Merchant Center property [title](
1792
+ # https://support.google.com/merchants/answer/6324415). Schema.org property [
1793
+ # Product.name](https://schema.org/name).
1786
1794
  # Corresponds to the JSON property `title`
1787
1795
  # @return [String]
1788
1796
  attr_accessor :title
@@ -1808,9 +1816,9 @@ module Google
1808
1816
  # recommended to provide a valid uri for the product, otherwise the service
1809
1817
  # performance could be significantly degraded. This field must be a UTF-8
1810
1818
  # encoded string with a length limit of 5,000 characters. Otherwise, an
1811
- # INVALID_ARGUMENT error is returned. Google Merchant Center property [link](
1812
- # https://support.google.com/merchants/answer/6324416). Schema.org property [
1813
- # Offer.url](https://schema.org/url).
1819
+ # INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
1820
+ # Center property [link](https://support.google.com/merchants/answer/6324416).
1821
+ # Schema.org property [Offer.url](https://schema.org/url).
1814
1822
  # Corresponds to the JSON property `uri`
1815
1823
  # @return [String]
1816
1824
  attr_accessor :uri
@@ -2420,25 +2428,26 @@ module Google
2420
2428
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
2421
2429
  attr_accessor :user_info
2422
2430
 
2423
- # The keys to fetch and rollup the matching variant Products attributes. The
2424
- # attributes from all the matching variant Products are merged and de-duplicated.
2425
- # Notice that rollup variant Products attributes will lead to extra query
2426
- # latency. Maximum number of keys is 10. For FulfillmentInfo, a fulfillment type
2427
- # and a fulfillment ID must be provided in the format of "fulfillmentType.
2428
- # fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
2429
- # fulfillment type and "store123" is the store ID. Supported keys are: *
2430
- # colorFamilies * price * originalPrice * discount * inventory(place_id,price) *
2431
- # inventory(place_id,attributes.key), where key is any key in the Product.
2432
- # inventories.attributes map. * attributes.key, where key is any key in the
2433
- # Product.attributes map. * pickupInStore.id, where id is any FulfillmentInfo.
2434
- # place_ids for FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where
2435
- # id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". *
2436
- # sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for
2437
- # FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
2438
- # any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". *
2439
- # customFulfillment1.id, where id is any FulfillmentInfo.place_ids for
2440
- # FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any
2441
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
2431
+ # The keys to fetch and rollup the matching variant Products attributes,
2432
+ # FulfillmentInfo or LocalInventorys attributes. The attributes from all the
2433
+ # matching variant Products or LocalInventorys are merged and de-duplicated.
2434
+ # Notice that rollup attributes will lead to extra query latency. Maximum number
2435
+ # of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID
2436
+ # must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "
2437
+ # pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is
2438
+ # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
2439
+ # discount * variantId * inventory(place_id,price) * inventory(place_id,
2440
+ # original_price) * inventory(place_id,attributes.key), where key is any key in
2441
+ # the Product.inventories.attributes map. * attributes.key, where key is any key
2442
+ # in the Product.attributes map. * pickupInStore.id, where id is any
2443
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
2444
+ # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
2445
+ # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
2446
+ # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
2447
+ # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
2448
+ # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
2449
+ # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
2450
+ # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
2442
2451
  # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
2443
2452
  # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
2444
2453
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
@@ -2452,9 +2461,9 @@ module Google
2452
2461
  # Required. A unique identifier for tracking visitors. For example, this could
2453
2462
  # be implemented with an HTTP cookie, which should be able to uniquely identify
2454
2463
  # a visitor on a single device. This unique identifier should not change if the
2455
- # visitor logs in or out of the website. The field must be a UTF-8 encoded
2456
- # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
2457
- # error is returned.
2464
+ # visitor logs in or out of the website. This should be the same identifier as
2465
+ # UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length
2466
+ # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2458
2467
  # Corresponds to the JSON property `visitorId`
2459
2468
  # @return [String]
2460
2469
  attr_accessor :visitor_id
@@ -2658,8 +2667,8 @@ module Google
2658
2667
  # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
2659
2668
  # customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
2660
2669
  # key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
2661
- # attributes.key" * "inventory(place_id,price)" * "inventory(place_id,attributes.
2662
- # key)"
2670
+ # attributes.key" * "inventory(place_id,price)" * "inventory(place_id,
2671
+ # original_price)" * "inventory(place_id,attributes.key)"
2663
2672
  # Corresponds to the JSON property `key`
2664
2673
  # @return [String]
2665
2674
  attr_accessor :key
@@ -2758,6 +2767,12 @@ module Google
2758
2767
  class GoogleCloudRetailV2SearchResponse
2759
2768
  include Google::Apis::Core::Hashable
2760
2769
 
2770
+ # The fully qualified resource name of applied [controls](https://cloud.google.
2771
+ # com/retail/docs/serving-control-rules).
2772
+ # Corresponds to the JSON property `appliedControls`
2773
+ # @return [Array<String>]
2774
+ attr_accessor :applied_controls
2775
+
2761
2776
  # A unique search token. This should be included in the UserEvent logs resulting
2762
2777
  # from this search, which enables accurate attribution of search model
2763
2778
  # performance.
@@ -2812,6 +2827,7 @@ module Google
2812
2827
 
2813
2828
  # Update properties of this object
2814
2829
  def update!(**args)
2830
+ @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
2815
2831
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
2816
2832
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
2817
2833
  @facets = args[:facets] if args.key?(:facets)
@@ -3037,10 +3053,9 @@ module Google
3037
3053
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Product]
3038
3054
  attr_accessor :inventory
3039
3055
 
3040
- # Indicates which inventory fields in the provided Product to update. If not set
3041
- # or set with empty paths, all inventory fields will be updated. If an
3042
- # unsupported or unknown field is provided, an INVALID_ARGUMENT error is
3043
- # returned and the entire update will be ignored.
3056
+ # Indicates which inventory fields in the provided Product to update. At least
3057
+ # one field must be provided. If an unsupported or unknown field is provided, an
3058
+ # INVALID_ARGUMENT error is returned and the entire update will be ignored.
3044
3059
  # Corresponds to the JSON property `setMask`
3045
3060
  # @return [String]
3046
3061
  attr_accessor :set_mask
@@ -3084,12 +3099,15 @@ module Google
3084
3099
  class GoogleCloudRetailV2UserEvent
3085
3100
  include Google::Apis::Core::Hashable
3086
3101
 
3087
- # Extra user event features to include in the recommendation model. The key must
3088
- # be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise,
3089
- # an INVALID_ARGUMENT error is returned. For product recommendation, an example
3090
- # of extra user information is traffic_channel, i.e. how user arrives at the
3091
- # site. Users can arrive at the site by coming to the site directly, or coming
3092
- # through Google search, and etc.
3102
+ # Extra user event features to include in the recommendation model. This field
3103
+ # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
3104
+ # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
3105
+ # 000 characters. * For text attributes, at most 400 values are allowed. Empty
3106
+ # values are not allowed. Each value must be a UTF-8 encoded string with a
3107
+ # length limit of 256 characters. * For number attributes, at most 400 values
3108
+ # are allowed. For product recommendation, an example of extra user information
3109
+ # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
3110
+ # site by coming to the site directly, or coming through Google search, and etc.
3093
3111
  # Corresponds to the JSON property `attributes`
3094
3112
  # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
3095
3113
  attr_accessor :attributes
@@ -3131,12 +3149,11 @@ module Google
3131
3149
 
3132
3150
  # Required. User event type. Allowed values are: * `add-to-cart`: Products being
3133
3151
  # added to cart. * `category-page-view`: Special pages such as sale or promotion
3134
- # pages viewed. * `completion`: Completion query result showed/clicked. * `
3135
- # detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage
3136
- # viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-
3137
- # not-offered`: Promotion is not offered to a user. * `purchase-complete`: User
3138
- # finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`:
3139
- # User viewing a shopping cart.
3152
+ # pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-
3153
+ # view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user.
3154
+ # * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-
3155
+ # complete`: User finishing a purchase. * `search`: Product search. * `shopping-
3156
+ # cart-page-view`: User viewing a shopping cart.
3140
3157
  # Corresponds to the JSON property `eventType`
3141
3158
  # @return [String]
3142
3159
  attr_accessor :event_type
@@ -3203,12 +3220,12 @@ module Google
3203
3220
 
3204
3221
  # The main product details related to the event. This field is required for the
3205
3222
  # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
3206
- # complete` In a `search` event, this field represents the products returned to
3207
- # the end user on the current page (the end user may have not finished browsing
3208
- # the whole page yet). When a new page is returned to the end user, after
3209
- # pagination/filtering/ordering even for the same query, a new `search` event
3210
- # with different product_details is desired. The end user may have not finished
3211
- # browsing the whole page yet.
3223
+ # complete` * `search` In a `search` event, this field represents the products
3224
+ # returned to the end user on the current page (the end user may have not
3225
+ # finished browsing the whole page yet). When a new page is returned to the end
3226
+ # user, after pagination/filtering/ordering even for the same query, a new `
3227
+ # search` event with different product_details is desired. The end user may have
3228
+ # not finished browsing the whole page yet.
3212
3229
  # Corresponds to the JSON property `productDetails`
3213
3230
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ProductDetail>]
3214
3231
  attr_accessor :product_details
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.22.0"
19
+ GEM_VERSION = "0.26.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.4.0"
22
+ GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211116"
25
+ REVISION = "20220121"
26
26
  end
27
27
  end
28
28
  end
@@ -1431,6 +1431,7 @@ module Google
1431
1431
  class GoogleCloudRetailV2SearchResponse
1432
1432
  # @private
1433
1433
  class Representation < Google::Apis::Core::JsonRepresentation
1434
+ collection :applied_controls, as: 'appliedControls'
1434
1435
  property :attribution_token, as: 'attributionToken'
1435
1436
  property :corrected_query, as: 'correctedQuery'
1436
1437
  collection :facets, as: 'facets', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet::Representation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.0
4
+ version: 0.26.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-12-06 00:00:00.000000000 Z
11
+ date: 2022-01-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.22.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.26.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Retail API V2