google-apis-retail_v2 0.19.0 → 0.23.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: 1cc744b4883f63b65feb4b5398dac6d8367d0462bccf1ad3077f0e604f5664a5
4
- data.tar.gz: 2595bda7d65085f010819b881ffac7f12e19904c669dba0a96e30a107f5a4861
3
+ metadata.gz: 1599b481f2aaed78125c27588176be269312c6abb0582d3aa4fd4ca4294755a3
4
+ data.tar.gz: f7d1bc53553c40ddceaf6b461fb49696be85d0c7338e71a6dd6b95c7c212fb61
5
5
  SHA512:
6
- metadata.gz: aeed8321fe4915ef9ea7e82c90b912c0f30f1f7fb669c1fd39dcc24ceafef1be15246e9f82b83d02ee52e70a64ea0d40337d8d1491d6e20eb8e28dcd8e03e40a
7
- data.tar.gz: b26e24a2e0721114e12707ede5a8d97ffe5c1b39dda615451dcc03b840250a36a9f5140f227498db058368090484bfcefaf80ee2379dbc64c2d0aeca47d822c6
6
+ metadata.gz: c9052890d848455cb40fccb29b8ed92bed90e332a41047da18e66bb849b24ab2debf64afd698bef7198e484a88ba3c4117748a3d4e8d98a683f46d9556da51c1
7
+ data.tar.gz: 24bb1e70f8045210d58d401881544f782c2f9ea327d0ee0ef9bfd4b98879be588af567ec29ccb40a28b653cb36312f8d1a6214af8114b7b833b04fc9dcebf824
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.23.0 (2021-12-09)
4
+
5
+ * Regenerated from discovery document revision 20211203
6
+
7
+ ### v0.22.0 (2021-11-17)
8
+
9
+ * Regenerated from discovery document revision 20211116
10
+
11
+ ### v0.21.0 (2021-11-10)
12
+
13
+ * Regenerated from discovery document revision 20211104
14
+
15
+ ### v0.20.0 (2021-11-03)
16
+
17
+ * Regenerated from discovery document revision 20211028
18
+
3
19
  ### v0.19.0 (2021-10-26)
4
20
 
5
21
  * Regenerated from discovery document revision 20211021
@@ -318,7 +318,7 @@ module Google
318
318
  # or the region IDs for "same-day-delivery" to be added for this type. Duplicate
319
319
  # IDs will be automatically ignored. At least 1 value is required, and a maximum
320
320
  # of 2000 values are allowed. Each value must be a string with a length limit of
321
- # 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "
321
+ # 10 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "
322
322
  # REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total
323
323
  # number of place IDs exceeds 2000 for this type after adding, then the update
324
324
  # will be rejected.
@@ -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
@@ -742,7 +738,7 @@ module Google
742
738
  # The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
743
739
  # in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
744
740
  # maximum of 3000 values are allowed. Each value must be a string with a length
745
- # limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
741
+ # limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1"
746
742
  # or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
747
743
  # Corresponds to the JSON property `placeIds`
748
744
  # @return [Array<String>]
@@ -1032,8 +1028,8 @@ module Google
1032
1028
 
1033
1029
  # Unique identifier provided by client, within the ancestor dataset scope.
1034
1030
  # Ensures idempotency and used for request deduplication. Server-generated if
1035
- # unspecified. Up to 128 characters long and must match the pattern: "[a-zA-Z0-
1036
- # 9_]+". This is returned as Operation.name in ImportMetadata. Only supported
1031
+ # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
1032
+ # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
1037
1033
  # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1038
1034
  # Corresponds to the JSON property `requestId`
1039
1035
  # @return [String]
@@ -1522,8 +1518,11 @@ module Google
1522
1518
  # :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
1523
1519
  # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
1524
1520
  # be a UTF-8 encoded string with a length limit of 128 characters. * For
1525
- # indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example,
1526
- # key0LikeThis or KEY_1_LIKE_THIS.
1521
+ # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
1522
+ # `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
1523
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
1524
+ # encoded string with a length limit of 256 characters. * For number attributes,
1525
+ # at most 400 values are allowed.
1527
1526
  # Corresponds to the JSON property `attributes`
1528
1527
  # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
1529
1528
  attr_accessor :attributes
@@ -1534,9 +1533,9 @@ module Google
1534
1533
  attr_accessor :audience
1535
1534
 
1536
1535
  # 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).
1536
+ # Corresponding properties: Google Merchant Center property [availability](https:
1537
+ # //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
1538
+ # availability](https://schema.org/availability).
1540
1539
  # Corresponds to the JSON property `availability`
1541
1540
  # @return [String]
1542
1541
  attr_accessor :availability
@@ -1553,9 +1552,9 @@ module Google
1553
1552
 
1554
1553
  # The brands of the product. A maximum of 30 brands are allowed. Each brand must
1555
1554
  # 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).
1555
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
1556
+ # Merchant Center property [brand](https://support.google.com/merchants/answer/
1557
+ # 6324351). Schema.org property [Product.brand](https://schema.org/brand).
1559
1558
  # Corresponds to the JSON property `brands`
1560
1559
  # @return [Array<String>]
1561
1560
  attr_accessor :brands
@@ -1572,10 +1571,10 @@ module Google
1572
1571
  # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
1573
1572
  # Empty values are not allowed. Each value must be a UTF-8 encoded string with
1574
1573
  # 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
1574
+ # returned. Corresponding properties: Google Merchant Center property
1575
+ # google_product_category. Schema.org property [Product.category] (https://
1576
+ # schema.org/category). [mc_google_product_category]: https://support.google.com/
1577
+ # merchants/answer/6324436
1579
1578
  # Corresponds to the JSON property `categories`
1580
1579
  # @return [Array<String>]
1581
1580
  attr_accessor :categories
@@ -1595,19 +1594,19 @@ module Google
1595
1594
  # The condition of the product. Strongly encouraged to use the standard values: "
1596
1595
  # new", "refurbished", "used". A maximum of 5 values are allowed per Product.
1597
1596
  # 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).
1597
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
1598
+ # properties: Google Merchant Center property [condition](https://support.google.
1599
+ # com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https:
1600
+ # //schema.org/itemCondition).
1602
1601
  # Corresponds to the JSON property `conditions`
1603
1602
  # @return [Array<String>]
1604
1603
  attr_accessor :conditions
1605
1604
 
1606
1605
  # Product description. This field must be a UTF-8 encoded string with a length
1607
1606
  # 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).
1607
+ # Corresponding properties: Google Merchant Center property [description](https:/
1608
+ # /support.google.com/merchants/answer/6324468). Schema.org property [Product.
1609
+ # description](https://schema.org/description).
1611
1610
  # Corresponds to the JSON property `description`
1612
1611
  # @return [String]
1613
1612
  attr_accessor :description
@@ -1617,8 +1616,8 @@ module Google
1617
1616
  # expire_time. However, the product can still be retrieved by ProductService.
1618
1617
  # GetProduct and ProductService.ListProducts. expire_time must be later than
1619
1618
  # 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).
1619
+ # Corresponding properties: Google Merchant Center property [expiration_date](
1620
+ # https://support.google.com/merchants/answer/6324499).
1622
1621
  # Corresponds to the JSON property `expireTime`
1623
1622
  # @return [String]
1624
1623
  attr_accessor :expire_time
@@ -1633,12 +1632,13 @@ module Google
1633
1632
  # The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
1634
1633
  # encoded string with a length limit of 128 characters. Otherwise, an
1635
1634
  # 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.
1635
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
1636
+ # Merchant Center property [gtin](https://support.google.com/merchants/answer/
1637
+ # 6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [
1638
+ # Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/
1639
+ # gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](
1640
+ # https://schema.org/gtin14). If the value is not a valid GTIN, an
1641
+ # INVALID_ARGUMENT error is returned.
1642
1642
  # Corresponds to the JSON property `gtin`
1643
1643
  # @return [String]
1644
1644
  attr_accessor :gtin
@@ -1647,27 +1647,28 @@ module Google
1647
1647
  # example, this field is "id_1", if name is `projects/*/locations/global/
1648
1648
  # catalogs/default_catalog/branches/default_branch/products/id_1`. This field
1649
1649
  # 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).
1650
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
1651
+ # Google Merchant Center property [id](https://support.google.com/merchants/
1652
+ # answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
1653
1653
  # Corresponds to the JSON property `id`
1654
1654
  # @return [String]
1655
1655
  attr_accessor :id
1656
1656
 
1657
1657
  # 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).
1658
+ # first. A maximum of 300 images are allowed. Corresponding properties: Google
1659
+ # Merchant Center property [image_link](https://support.google.com/merchants/
1660
+ # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
1661
1661
  # Corresponds to the JSON property `images`
1662
1662
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Image>]
1663
1663
  attr_accessor :images
1664
1664
 
1665
1665
  # 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.
1666
+ # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For
1667
+ # product prediction, this field is ignored and the model automatically detects
1668
+ # the text language. The Product can include text in different languages, but
1669
+ # duplicating Products to provide text in multiple languages can result in
1670
+ # degraded model performance. For product search this field is in use. It
1671
+ # defaults to "en-US" if unset.
1671
1672
  # Corresponds to the JSON property `languageCode`
1672
1673
  # @return [String]
1673
1674
  attr_accessor :language_code
@@ -1675,9 +1676,9 @@ module Google
1675
1676
  # The material of the product. For example, "leather", "wooden". A maximum of 20
1676
1677
  # values are allowed. Each value must be a UTF-8 encoded string with a length
1677
1678
  # 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).
1679
+ # Corresponding properties: Google Merchant Center property [material](https://
1680
+ # support.google.com/merchants/answer/6324410). Schema.org property [Product.
1681
+ # material](https://schema.org/material).
1681
1682
  # Corresponds to the JSON property `materials`
1682
1683
  # @return [Array<String>]
1683
1684
  attr_accessor :materials
@@ -1691,9 +1692,10 @@ module Google
1691
1692
  # The pattern or graphic print of the product. For example, "striped", "polka
1692
1693
  # dot", "paisley". A maximum of 20 values are allowed per Product. Each value
1693
1694
  # 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).
1695
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
1696
+ # Google Merchant Center property [pattern](https://support.google.com/merchants/
1697
+ # answer/6324483). Schema.org property [Product.pattern](https://schema.org/
1698
+ # pattern).
1697
1699
  # Corresponds to the JSON property `patterns`
1698
1700
  # @return [Array<String>]
1699
1701
  attr_accessor :patterns
@@ -1708,10 +1710,9 @@ module Google
1708
1710
  # can only be empty or set to the same value as id. For VARIANT Products, this
1709
1711
  # field cannot be empty. A maximum of 2,000 products are allowed to share the
1710
1712
  # 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).
1713
+ # Corresponding properties: Google Merchant Center property [item_group_id](
1714
+ # https://support.google.com/merchants/answer/6324507). Schema.org property [
1715
+ # Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
1715
1716
  # Corresponds to the JSON property `primaryProductId`
1716
1717
  # @return [String]
1717
1718
  attr_accessor :primary_product_id
@@ -1760,10 +1761,11 @@ module Google
1760
1761
  # system and size type are empty, while size value is "32 inches". A maximum of
1761
1762
  # 20 values are allowed per Product. Each value must be a UTF-8 encoded string
1762
1763
  # 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).
1764
+ # returned. Corresponding properties: Google Merchant Center property [size](
1765
+ # https://support.google.com/merchants/answer/6324492), [size_type](https://
1766
+ # support.google.com/merchants/answer/6324497), and [size_system](https://
1767
+ # support.google.com/merchants/answer/6324502). Schema.org property [Product.
1768
+ # size](https://schema.org/size).
1767
1769
  # Corresponds to the JSON property `sizes`
1768
1770
  # @return [Array<String>]
1769
1771
  attr_accessor :sizes
@@ -1772,17 +1774,18 @@ module Google
1772
1774
  # Product. This value must be a UTF-8 encoded string with a length limit of 1,
1773
1775
  # 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
1774
1776
  # 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).
1777
+ # PredictRequest.filter. Corresponding properties: Google Merchant Center
1778
+ # property [custom_label_0–4](https://support.google.com/merchants/answer/
1779
+ # 6324473).
1777
1780
  # Corresponds to the JSON property `tags`
1778
1781
  # @return [Array<String>]
1779
1782
  attr_accessor :tags
1780
1783
 
1781
1784
  # Required. Product title. This field must be a UTF-8 encoded string with a
1782
1785
  # 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).
1786
+ # returned. Corresponding properties: Google Merchant Center property [title](
1787
+ # https://support.google.com/merchants/answer/6324415). Schema.org property [
1788
+ # Product.name](https://schema.org/name).
1786
1789
  # Corresponds to the JSON property `title`
1787
1790
  # @return [String]
1788
1791
  attr_accessor :title
@@ -1808,9 +1811,9 @@ module Google
1808
1811
  # recommended to provide a valid uri for the product, otherwise the service
1809
1812
  # performance could be significantly degraded. This field must be a UTF-8
1810
1813
  # 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).
1814
+ # INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
1815
+ # Center property [link](https://support.google.com/merchants/answer/6324416).
1816
+ # Schema.org property [Offer.url](https://schema.org/url).
1814
1817
  # Corresponds to the JSON property `uri`
1815
1818
  # @return [String]
1816
1819
  attr_accessor :uri
@@ -1952,15 +1955,15 @@ module Google
1952
1955
  include Google::Apis::Core::Hashable
1953
1956
 
1954
1957
  # The type of Products allowed to be ingested into the catalog. Acceptable
1955
- # values are: * `primary` (default): You can only ingest Product.Type.PRIMARY
1956
- # Products. This means Product.primary_product_id can only be empty or set to
1957
- # the same value as Product.id. * `variant`: You can only ingest Product.Type.
1958
- # VARIANT Products. This means Product.primary_product_id cannot be empty. If
1959
- # this field is set to an invalid value other than these, an INVALID_ARGUMENT
1960
- # error is returned. If this field is `variant` and
1961
- # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
1962
- # is returned. See [Using product levels](https://cloud.google.com/retail/
1963
- # recommendations-ai/docs/catalog#product-levels) for more details.
1958
+ # values are: * `primary` (default): You can ingest Products of all types. When
1959
+ # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
1960
+ # `variant`: You can only ingest Product.Type.VARIANT Products. This means
1961
+ # Product.primary_product_id cannot be empty. If this field is set to an invalid
1962
+ # value other than these, an INVALID_ARGUMENT error is returned. If this field
1963
+ # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
1964
+ # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
1965
+ # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
1966
+ # details.
1964
1967
  # Corresponds to the JSON property `ingestionProductType`
1965
1968
  # @return [String]
1966
1969
  attr_accessor :ingestion_product_type
@@ -1995,8 +1998,8 @@ module Google
1995
1998
  include Google::Apis::Core::Hashable
1996
1999
 
1997
2000
  # ID of the promotion. For example, "free gift". The value value must be a UTF-8
1998
- # encoded string with a length limit of 128 characters, and match the pattern: a-
1999
- # zA-Z*. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2001
+ # encoded string with a length limit of 128 characters, and match the pattern: `
2002
+ # a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2000
2003
  # INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
2001
2004
  # (https://support.google.com/merchants/answer/7050148).
2002
2005
  # Corresponds to the JSON property `promotionId`
@@ -2257,7 +2260,7 @@ module Google
2257
2260
  # or the region IDs for "same-day-delivery", to be removed for this type. At
2258
2261
  # least 1 value is required, and a maximum of 2000 values are allowed. Each
2259
2262
  # value must be a string with a length limit of 10 characters, matching the
2260
- # pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
2263
+ # pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
2261
2264
  # INVALID_ARGUMENT error is returned.
2262
2265
  # Corresponds to the JSON property `placeIds`
2263
2266
  # @return [Array<String>]
@@ -2420,24 +2423,26 @@ module Google
2420
2423
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
2421
2424
  attr_accessor :user_info
2422
2425
 
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
- # attributes.key, where key is any key in the Product.attributes map. *
2432
- # pickupInStore.id, where id is any FulfillmentInfo.place_ids for
2433
- # FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any
2434
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". *
2435
- # sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for
2436
- # FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
2437
- # any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". *
2438
- # customFulfillment1.id, where id is any FulfillmentInfo.place_ids for
2439
- # FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any
2440
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
2426
+ # The keys to fetch and rollup the matching variant Products attributes,
2427
+ # FulfillmentInfo or LocalInventorys attributes. The attributes from all the
2428
+ # matching variant Products or LocalInventorys are merged and de-duplicated.
2429
+ # Notice that rollup attributes will lead to extra query latency. Maximum number
2430
+ # of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID
2431
+ # must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "
2432
+ # pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is
2433
+ # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
2434
+ # discount * variantId * inventory(place_id,price) * inventory(place_id,
2435
+ # original_price) * inventory(place_id,attributes.key), where key is any key in
2436
+ # the Product.inventories.attributes map. * attributes.key, where key is any key
2437
+ # in the Product.attributes map. * pickupInStore.id, where id is any
2438
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
2439
+ # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
2440
+ # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
2441
+ # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
2442
+ # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
2443
+ # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
2444
+ # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
2445
+ # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
2441
2446
  # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
2442
2447
  # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
2443
2448
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
@@ -2655,9 +2660,10 @@ module Google
2655
2660
  # colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
2656
2661
  # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
2657
2662
  # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
2658
- # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
2659
- # discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,
2660
- # price)"
2663
+ # customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
2664
+ # key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
2665
+ # attributes.key" * "inventory(place_id,price)" * "inventory(place_id,
2666
+ # original_price)" * "inventory(place_id,attributes.key)"
2661
2667
  # Corresponds to the JSON property `key`
2662
2668
  # @return [String]
2663
2669
  attr_accessor :key
@@ -2756,6 +2762,12 @@ module Google
2756
2762
  class GoogleCloudRetailV2SearchResponse
2757
2763
  include Google::Apis::Core::Hashable
2758
2764
 
2765
+ # The fully qualified resource name of applied [controls](https://cloud.google.
2766
+ # com/retail/docs/serving-control-rules).
2767
+ # Corresponds to the JSON property `appliedControls`
2768
+ # @return [Array<String>]
2769
+ attr_accessor :applied_controls
2770
+
2759
2771
  # A unique search token. This should be included in the UserEvent logs resulting
2760
2772
  # from this search, which enables accurate attribution of search model
2761
2773
  # performance.
@@ -2810,6 +2822,7 @@ module Google
2810
2822
 
2811
2823
  # Update properties of this object
2812
2824
  def update!(**args)
2825
+ @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
2813
2826
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
2814
2827
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
2815
2828
  @facets = args[:facets] if args.key?(:facets)
@@ -3082,12 +3095,15 @@ module Google
3082
3095
  class GoogleCloudRetailV2UserEvent
3083
3096
  include Google::Apis::Core::Hashable
3084
3097
 
3085
- # Extra user event features to include in the recommendation model. The key must
3086
- # be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise,
3087
- # an INVALID_ARGUMENT error is returned. For product recommendation, an example
3088
- # of extra user information is traffic_channel, i.e. how user arrives at the
3089
- # site. Users can arrive at the site by coming to the site directly, or coming
3090
- # through Google search, and etc.
3098
+ # Extra user event features to include in the recommendation model. This field
3099
+ # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
3100
+ # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
3101
+ # 000 characters. * For text attributes, at most 400 values are allowed. Empty
3102
+ # values are not allowed. Each value must be a UTF-8 encoded string with a
3103
+ # length limit of 256 characters. * For number attributes, at most 400 values
3104
+ # are allowed. For product recommendation, an example of extra user information
3105
+ # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
3106
+ # site by coming to the site directly, or coming through Google search, and etc.
3091
3107
  # Corresponds to the JSON property `attributes`
3092
3108
  # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
3093
3109
  attr_accessor :attributes
@@ -3129,12 +3145,11 @@ module Google
3129
3145
 
3130
3146
  # Required. User event type. Allowed values are: * `add-to-cart`: Products being
3131
3147
  # added to cart. * `category-page-view`: Special pages such as sale or promotion
3132
- # pages viewed. * `completion`: Completion query result showed/clicked. * `
3133
- # detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage
3134
- # viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-
3135
- # not-offered`: Promotion is not offered to a user. * `purchase-complete`: User
3136
- # finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`:
3137
- # User viewing a shopping cart.
3148
+ # pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-
3149
+ # view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user.
3150
+ # * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-
3151
+ # complete`: User finishing a purchase. * `search`: Product search. * `shopping-
3152
+ # cart-page-view`: User viewing a shopping cart.
3138
3153
  # Corresponds to the JSON property `eventType`
3139
3154
  # @return [String]
3140
3155
  attr_accessor :event_type
@@ -3456,6 +3471,35 @@ module Google
3456
3471
  end
3457
3472
  end
3458
3473
 
3474
+ # Metadata related to the progress of the AddLocalInventories operation.
3475
+ # Currently empty because there is no meaningful metadata populated from the
3476
+ # AddLocalInventories method.
3477
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
3478
+ include Google::Apis::Core::Hashable
3479
+
3480
+ def initialize(**args)
3481
+ update!(**args)
3482
+ end
3483
+
3484
+ # Update properties of this object
3485
+ def update!(**args)
3486
+ end
3487
+ end
3488
+
3489
+ # Response of the AddLocalInventories API. Currently empty because there is no
3490
+ # meaningful response populated from the AddLocalInventories method.
3491
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
3492
+ include Google::Apis::Core::Hashable
3493
+
3494
+ def initialize(**args)
3495
+ update!(**args)
3496
+ end
3497
+
3498
+ # Update properties of this object
3499
+ def update!(**args)
3500
+ end
3501
+ end
3502
+
3459
3503
  # Configuration of destination for Export related errors.
3460
3504
  class GoogleCloudRetailV2alphaExportErrorsConfig
3461
3505
  include Google::Apis::Core::Hashable
@@ -3812,6 +3856,35 @@ module Google
3812
3856
  end
3813
3857
  end
3814
3858
 
3859
+ # Metadata related to the progress of the RemoveLocalInventories operation.
3860
+ # Currently empty because there is no meaningful metadata populated from the
3861
+ # RemoveLocalInventories method.
3862
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
3863
+ include Google::Apis::Core::Hashable
3864
+
3865
+ def initialize(**args)
3866
+ update!(**args)
3867
+ end
3868
+
3869
+ # Update properties of this object
3870
+ def update!(**args)
3871
+ end
3872
+ end
3873
+
3874
+ # Response of the RemoveLocalInventories API. Currently empty because there is
3875
+ # no meaningful response populated from the RemoveLocalInventories method.
3876
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
3877
+ include Google::Apis::Core::Hashable
3878
+
3879
+ def initialize(**args)
3880
+ update!(**args)
3881
+ end
3882
+
3883
+ # Update properties of this object
3884
+ def update!(**args)
3885
+ end
3886
+ end
3887
+
3815
3888
  # Metadata related to the progress of the SetInventory operation. Currently
3816
3889
  # empty because there is no meaningful metadata populated from the SetInventory
3817
3890
  # method.
@@ -3841,6 +3914,35 @@ module Google
3841
3914
  end
3842
3915
  end
3843
3916
 
3917
+ # Metadata related to the progress of the SetLocalInventories operation.
3918
+ # Currently empty because there is no meaningful metadata populated from the
3919
+ # SetLocalInventories method.
3920
+ class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
3921
+ include Google::Apis::Core::Hashable
3922
+
3923
+ def initialize(**args)
3924
+ update!(**args)
3925
+ end
3926
+
3927
+ # Update properties of this object
3928
+ def update!(**args)
3929
+ end
3930
+ end
3931
+
3932
+ # Response of the SetLocalInventories API. Currently empty because there is no
3933
+ # meaningful response populated from the SetLocalInventories method.
3934
+ class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
3935
+ include Google::Apis::Core::Hashable
3936
+
3937
+ def initialize(**args)
3938
+ update!(**args)
3939
+ end
3940
+
3941
+ # Update properties of this object
3942
+ def update!(**args)
3943
+ end
3944
+ end
3945
+
3844
3946
  # A summary of import result. The UserEventImportSummary summarizes the import
3845
3947
  # status for user events.
3846
3948
  class GoogleCloudRetailV2alphaUserEventImportSummary
@@ -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.19.0"
19
+ GEM_VERSION = "0.23.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211021"
25
+ REVISION = "20211203"
26
26
  end
27
27
  end
28
28
  end
@@ -502,6 +502,18 @@ module Google
502
502
  include Google::Apis::Core::JsonObjectSupport
503
503
  end
504
504
 
505
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
506
+ class Representation < Google::Apis::Core::JsonRepresentation; end
507
+
508
+ include Google::Apis::Core::JsonObjectSupport
509
+ end
510
+
511
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
512
+ class Representation < Google::Apis::Core::JsonRepresentation; end
513
+
514
+ include Google::Apis::Core::JsonObjectSupport
515
+ end
516
+
505
517
  class GoogleCloudRetailV2alphaExportErrorsConfig
506
518
  class Representation < Google::Apis::Core::JsonRepresentation; end
507
519
 
@@ -592,6 +604,18 @@ module Google
592
604
  include Google::Apis::Core::JsonObjectSupport
593
605
  end
594
606
 
607
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
608
+ class Representation < Google::Apis::Core::JsonRepresentation; end
609
+
610
+ include Google::Apis::Core::JsonObjectSupport
611
+ end
612
+
613
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
614
+ class Representation < Google::Apis::Core::JsonRepresentation; end
615
+
616
+ include Google::Apis::Core::JsonObjectSupport
617
+ end
618
+
595
619
  class GoogleCloudRetailV2alphaSetInventoryMetadata
596
620
  class Representation < Google::Apis::Core::JsonRepresentation; end
597
621
 
@@ -604,6 +628,18 @@ module Google
604
628
  include Google::Apis::Core::JsonObjectSupport
605
629
  end
606
630
 
631
+ class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
632
+ class Representation < Google::Apis::Core::JsonRepresentation; end
633
+
634
+ include Google::Apis::Core::JsonObjectSupport
635
+ end
636
+
637
+ class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
638
+ class Representation < Google::Apis::Core::JsonRepresentation; end
639
+
640
+ include Google::Apis::Core::JsonObjectSupport
641
+ end
642
+
607
643
  class GoogleCloudRetailV2alphaUserEventImportSummary
608
644
  class Representation < Google::Apis::Core::JsonRepresentation; end
609
645
 
@@ -1407,6 +1443,7 @@ module Google
1407
1443
  class GoogleCloudRetailV2SearchResponse
1408
1444
  # @private
1409
1445
  class Representation < Google::Apis::Core::JsonRepresentation
1446
+ collection :applied_controls, as: 'appliedControls'
1410
1447
  property :attribution_token, as: 'attributionToken'
1411
1448
  property :corrected_query, as: 'correctedQuery'
1412
1449
  collection :facets, as: 'facets', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet::Representation
@@ -1573,6 +1610,18 @@ module Google
1573
1610
  end
1574
1611
  end
1575
1612
 
1613
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
1614
+ # @private
1615
+ class Representation < Google::Apis::Core::JsonRepresentation
1616
+ end
1617
+ end
1618
+
1619
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
1620
+ # @private
1621
+ class Representation < Google::Apis::Core::JsonRepresentation
1622
+ end
1623
+ end
1624
+
1576
1625
  class GoogleCloudRetailV2alphaExportErrorsConfig
1577
1626
  # @private
1578
1627
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1695,6 +1744,18 @@ module Google
1695
1744
  end
1696
1745
  end
1697
1746
 
1747
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
1748
+ # @private
1749
+ class Representation < Google::Apis::Core::JsonRepresentation
1750
+ end
1751
+ end
1752
+
1753
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
1754
+ # @private
1755
+ class Representation < Google::Apis::Core::JsonRepresentation
1756
+ end
1757
+ end
1758
+
1698
1759
  class GoogleCloudRetailV2alphaSetInventoryMetadata
1699
1760
  # @private
1700
1761
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1707,6 +1768,18 @@ module Google
1707
1768
  end
1708
1769
  end
1709
1770
 
1771
+ class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
1772
+ # @private
1773
+ class Representation < Google::Apis::Core::JsonRepresentation
1774
+ end
1775
+ end
1776
+
1777
+ class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
1778
+ # @private
1779
+ class Representation < Google::Apis::Core::JsonRepresentation
1780
+ end
1781
+ end
1782
+
1710
1783
  class GoogleCloudRetailV2alphaUserEventImportSummary
1711
1784
  # @private
1712
1785
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -67,10 +67,10 @@ module Google
67
67
  # cloud-retail, contact Cloud Retail support team first.
68
68
  # @param [String] device_type
69
69
  # The device type context for completion suggestions. It is useful to apply
70
- # different suggestions on different device types, e.g. DESKTOP, MOBILE. If it
71
- # is empty, the suggestions are across all device types. Supported formats: *
72
- # UNKNOWN_DEVICE_TYPE * DESKTOP * MOBILE * A customized string starts with
73
- # OTHER_, e.g. OTHER_IPHONE.
70
+ # different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If
71
+ # it is empty, the suggestions are across all device types. Supported formats: *
72
+ # `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
73
+ # `OTHER_`, e.g. `OTHER_IPHONE`.
74
74
  # @param [Array<String>, String] language_codes
75
75
  # The list of languages of the query. This is the BCP-47 language code, such as "
76
76
  # en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages]
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.19.0
4
+ version: 0.23.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-10-27 00:00:00.000000000 Z
11
+ date: 2021-12-13 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.19.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.23.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: []