google-apis-retail_v2 0.20.0 → 0.24.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/OVERVIEW.md +1 -1
- data/lib/google/apis/retail_v2/classes.rb +163 -118
- data/lib/google/apis/retail_v2/gem_version.rb +2 -2
- data/lib/google/apis/retail_v2/representations.rb +25 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 12f5a0bb297d32e228610cda346b06d6270767592ea3c5da21c0880949f0c1cd
|
4
|
+
data.tar.gz: 6c4a9047f45d728423eb02cd9287a0aa463c34dd545f7c2ded4548f7aa18f73b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bf1f077b2927924c810b108909d9e4dd55a181634f08ddd25be2c0cc9d21baab1eb1a30abc049a3abad58ca8d0e97361016b388ac782e0933760bdfae77a935f
|
7
|
+
data.tar.gz: 4d67d88455fc4733f4163b12750c886bc901e43db238ebf06d28f3c97f46e6f048647afad0194f47c49efb1d6d02d2fedc882ba06667a7438de80ff4a82305b2
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,21 @@
|
|
1
1
|
# Release history for google-apis-retail_v2
|
2
2
|
|
3
|
+
### v0.24.0 (2021-12-16)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20211210
|
6
|
+
|
7
|
+
### v0.23.0 (2021-12-09)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20211203
|
10
|
+
|
11
|
+
### v0.22.0 (2021-11-17)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20211116
|
14
|
+
|
15
|
+
### v0.21.0 (2021-11-10)
|
16
|
+
|
17
|
+
* Regenerated from discovery document revision 20211104
|
18
|
+
|
3
19
|
### v0.20.0 (2021-11-03)
|
4
20
|
|
5
21
|
* Regenerated from discovery document revision 20211028
|
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.
|
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".
|
700
|
-
# INVALID_ARGUMENT error is returned.
|
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".
|
716
|
-
#
|
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,8 @@ 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.
|
784
782
|
# Corresponds to the JSON property `dataSchema`
|
785
783
|
# @return [String]
|
786
784
|
attr_accessor :data_schema
|
@@ -1434,8 +1432,8 @@ module Google
|
|
1434
1432
|
attr_accessor :original_price
|
1435
1433
|
|
1436
1434
|
# Price of the product. Google Merchant Center property [price](https://support.
|
1437
|
-
# google.com/merchants/answer/6324371). Schema.org property [Offer.
|
1438
|
-
#
|
1435
|
+
# google.com/merchants/answer/6324371). Schema.org property [Offer.price](https:/
|
1436
|
+
# /schema.org/price).
|
1439
1437
|
# Corresponds to the JSON property `price`
|
1440
1438
|
# @return [Float]
|
1441
1439
|
attr_accessor :price
|
@@ -1523,7 +1521,10 @@ module Google
|
|
1523
1521
|
# INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
|
1524
1522
|
# be a UTF-8 encoded string with a length limit of 128 characters. * For
|
1525
1523
|
# indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
|
1526
|
-
# key0LikeThis or KEY_1_LIKE_THIS
|
1524
|
+
# `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
|
1525
|
+
# values are allowed. Empty values are not allowed. Each value must be a UTF-8
|
1526
|
+
# encoded string with a length limit of 256 characters. * For number attributes,
|
1527
|
+
# at most 400 values are allowed.
|
1527
1528
|
# Corresponds to the JSON property `attributes`
|
1528
1529
|
# @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
|
1529
1530
|
attr_accessor :attributes
|
@@ -1534,9 +1535,9 @@ module Google
|
|
1534
1535
|
attr_accessor :audience
|
1535
1536
|
|
1536
1537
|
# The online availability of the Product. Default to Availability.IN_STOCK.
|
1537
|
-
# Google Merchant Center
|
1538
|
-
# merchants/answer/6324448). Schema.org
|
1539
|
-
# schema.org/availability).
|
1538
|
+
# Corresponding properties: Google Merchant Center property [availability](https:
|
1539
|
+
# //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
|
1540
|
+
# availability](https://schema.org/availability).
|
1540
1541
|
# Corresponds to the JSON property `availability`
|
1541
1542
|
# @return [String]
|
1542
1543
|
attr_accessor :availability
|
@@ -1553,9 +1554,9 @@ module Google
|
|
1553
1554
|
|
1554
1555
|
# The brands of the product. A maximum of 30 brands are allowed. Each brand must
|
1555
1556
|
# be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
|
1556
|
-
# an INVALID_ARGUMENT error is returned.
|
1557
|
-
# https://support.google.com/merchants/answer/
|
1558
|
-
# Product.brand](https://schema.org/brand).
|
1557
|
+
# an INVALID_ARGUMENT error is returned. Corresponding properties: Google
|
1558
|
+
# Merchant Center property [brand](https://support.google.com/merchants/answer/
|
1559
|
+
# 6324351). Schema.org property [Product.brand](https://schema.org/brand).
|
1559
1560
|
# Corresponds to the JSON property `brands`
|
1560
1561
|
# @return [Array<String>]
|
1561
1562
|
attr_accessor :brands
|
@@ -1572,10 +1573,10 @@ module Google
|
|
1572
1573
|
# INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
|
1573
1574
|
# Empty values are not allowed. Each value must be a UTF-8 encoded string with
|
1574
1575
|
# a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
|
1575
|
-
# returned. Google Merchant Center property
|
1576
|
-
# property [Product.category] (https://
|
1577
|
-
# mc_google_product_category]: https://support.google.com/
|
1578
|
-
# 6324436
|
1576
|
+
# returned. Corresponding properties: Google Merchant Center property
|
1577
|
+
# google_product_category. Schema.org property [Product.category] (https://
|
1578
|
+
# schema.org/category). [mc_google_product_category]: https://support.google.com/
|
1579
|
+
# merchants/answer/6324436
|
1579
1580
|
# Corresponds to the JSON property `categories`
|
1580
1581
|
# @return [Array<String>]
|
1581
1582
|
attr_accessor :categories
|
@@ -1595,19 +1596,19 @@ module Google
|
|
1595
1596
|
# The condition of the product. Strongly encouraged to use the standard values: "
|
1596
1597
|
# new", "refurbished", "used". A maximum of 5 values are allowed per Product.
|
1597
1598
|
# Each value must be a UTF-8 encoded string with a length limit of 128
|
1598
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
1599
|
-
# Center property [condition](https://support.google.
|
1600
|
-
# 6324469). Schema.org property [Offer.itemCondition](https
|
1601
|
-
# itemCondition).
|
1599
|
+
# characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
|
1600
|
+
# properties: Google Merchant Center property [condition](https://support.google.
|
1601
|
+
# com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https:
|
1602
|
+
# //schema.org/itemCondition).
|
1602
1603
|
# Corresponds to the JSON property `conditions`
|
1603
1604
|
# @return [Array<String>]
|
1604
1605
|
attr_accessor :conditions
|
1605
1606
|
|
1606
1607
|
# Product description. This field must be a UTF-8 encoded string with a length
|
1607
1608
|
# limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
1608
|
-
# Google Merchant Center property [description](https
|
1609
|
-
# merchants/answer/6324468).
|
1610
|
-
# schema.org/description).
|
1609
|
+
# Corresponding properties: Google Merchant Center property [description](https:/
|
1610
|
+
# /support.google.com/merchants/answer/6324468). Schema.org property [Product.
|
1611
|
+
# description](https://schema.org/description).
|
1611
1612
|
# Corresponds to the JSON property `description`
|
1612
1613
|
# @return [String]
|
1613
1614
|
attr_accessor :description
|
@@ -1617,8 +1618,8 @@ module Google
|
|
1617
1618
|
# expire_time. However, the product can still be retrieved by ProductService.
|
1618
1619
|
# GetProduct and ProductService.ListProducts. expire_time must be later than
|
1619
1620
|
# available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
|
1620
|
-
# Google Merchant Center property [expiration_date](
|
1621
|
-
# merchants/answer/6324499).
|
1621
|
+
# Corresponding properties: Google Merchant Center property [expiration_date](
|
1622
|
+
# https://support.google.com/merchants/answer/6324499).
|
1622
1623
|
# Corresponds to the JSON property `expireTime`
|
1623
1624
|
# @return [String]
|
1624
1625
|
attr_accessor :expire_time
|
@@ -1633,12 +1634,13 @@ module Google
|
|
1633
1634
|
# The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
|
1634
1635
|
# encoded string with a length limit of 128 characters. Otherwise, an
|
1635
1636
|
# INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
|
1636
|
-
# an INVALID_ARGUMENT error is returned.
|
1637
|
-
# https://support.google.com/merchants/answer/
|
1638
|
-
#
|
1639
|
-
#
|
1640
|
-
# https://schema.org/gtin13) or [Product.gtin14](
|
1641
|
-
# the value is not a valid GTIN, an
|
1637
|
+
# an INVALID_ARGUMENT error is returned. Corresponding properties: Google
|
1638
|
+
# Merchant Center property [gtin](https://support.google.com/merchants/answer/
|
1639
|
+
# 6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [
|
1640
|
+
# Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/
|
1641
|
+
# gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](
|
1642
|
+
# https://schema.org/gtin14). If the value is not a valid GTIN, an
|
1643
|
+
# INVALID_ARGUMENT error is returned.
|
1642
1644
|
# Corresponds to the JSON property `gtin`
|
1643
1645
|
# @return [String]
|
1644
1646
|
attr_accessor :gtin
|
@@ -1647,27 +1649,28 @@ module Google
|
|
1647
1649
|
# example, this field is "id_1", if name is `projects/*/locations/global/
|
1648
1650
|
# catalogs/default_catalog/branches/default_branch/products/id_1`. This field
|
1649
1651
|
# must be a UTF-8 encoded string with a length limit of 128 characters.
|
1650
|
-
# Otherwise, an INVALID_ARGUMENT error is returned.
|
1651
|
-
# property [id](https://support.google.com/merchants/
|
1652
|
-
#
|
1652
|
+
# Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
|
1653
|
+
# Google Merchant Center property [id](https://support.google.com/merchants/
|
1654
|
+
# answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
|
1653
1655
|
# Corresponds to the JSON property `id`
|
1654
1656
|
# @return [String]
|
1655
1657
|
attr_accessor :id
|
1656
1658
|
|
1657
1659
|
# Product images for the product.Highly recommended to put the main image to the
|
1658
|
-
# first. A maximum of 300 images are allowed.
|
1659
|
-
# image_link](https://support.google.com/merchants/
|
1660
|
-
# property [Product.image](https://schema.org/image).
|
1660
|
+
# first. A maximum of 300 images are allowed. Corresponding properties: Google
|
1661
|
+
# Merchant Center property [image_link](https://support.google.com/merchants/
|
1662
|
+
# answer/6324350). Schema.org property [Product.image](https://schema.org/image).
|
1661
1663
|
# Corresponds to the JSON property `images`
|
1662
1664
|
# @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Image>]
|
1663
1665
|
attr_accessor :images
|
1664
1666
|
|
1665
1667
|
# Language of the title/description and other string attributes. Use language
|
1666
|
-
# tags defined by BCP 47. For
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
# field is in use. It
|
1668
|
+
# tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For
|
1669
|
+
# product prediction, this field is ignored and the model automatically detects
|
1670
|
+
# the text language. The Product can include text in different languages, but
|
1671
|
+
# duplicating Products to provide text in multiple languages can result in
|
1672
|
+
# degraded model performance. For product search this field is in use. It
|
1673
|
+
# defaults to "en-US" if unset.
|
1671
1674
|
# Corresponds to the JSON property `languageCode`
|
1672
1675
|
# @return [String]
|
1673
1676
|
attr_accessor :language_code
|
@@ -1675,9 +1678,9 @@ module Google
|
|
1675
1678
|
# The material of the product. For example, "leather", "wooden". A maximum of 20
|
1676
1679
|
# values are allowed. Each value must be a UTF-8 encoded string with a length
|
1677
1680
|
# limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
1678
|
-
# Google Merchant Center property [material](https://
|
1679
|
-
# merchants/answer/6324410). Schema.org property [Product.
|
1680
|
-
# schema.org/material).
|
1681
|
+
# Corresponding properties: Google Merchant Center property [material](https://
|
1682
|
+
# support.google.com/merchants/answer/6324410). Schema.org property [Product.
|
1683
|
+
# material](https://schema.org/material).
|
1681
1684
|
# Corresponds to the JSON property `materials`
|
1682
1685
|
# @return [Array<String>]
|
1683
1686
|
attr_accessor :materials
|
@@ -1691,9 +1694,10 @@ module Google
|
|
1691
1694
|
# The pattern or graphic print of the product. For example, "striped", "polka
|
1692
1695
|
# dot", "paisley". A maximum of 20 values are allowed per Product. Each value
|
1693
1696
|
# must be a UTF-8 encoded string with a length limit of 128 characters.
|
1694
|
-
# Otherwise, an INVALID_ARGUMENT error is returned.
|
1695
|
-
# property [pattern](https://support.google.com/merchants/
|
1696
|
-
# Schema.org property [Product.pattern](https://schema.org/
|
1697
|
+
# Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
|
1698
|
+
# Google Merchant Center property [pattern](https://support.google.com/merchants/
|
1699
|
+
# answer/6324483). Schema.org property [Product.pattern](https://schema.org/
|
1700
|
+
# pattern).
|
1697
1701
|
# Corresponds to the JSON property `patterns`
|
1698
1702
|
# @return [Array<String>]
|
1699
1703
|
attr_accessor :patterns
|
@@ -1708,10 +1712,9 @@ module Google
|
|
1708
1712
|
# can only be empty or set to the same value as id. For VARIANT Products, this
|
1709
1713
|
# field cannot be empty. A maximum of 2,000 products are allowed to share the
|
1710
1714
|
# same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.
|
1711
|
-
# Google Merchant Center
|
1712
|
-
# merchants/answer/6324507). Schema.org
|
1713
|
-
# https://schema.org/inProductGroupWithID).
|
1714
|
-
# can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).
|
1715
|
+
# Corresponding properties: Google Merchant Center property [item_group_id](
|
1716
|
+
# https://support.google.com/merchants/answer/6324507). Schema.org property [
|
1717
|
+
# Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
|
1715
1718
|
# Corresponds to the JSON property `primaryProductId`
|
1716
1719
|
# @return [String]
|
1717
1720
|
attr_accessor :primary_product_id
|
@@ -1760,10 +1763,11 @@ module Google
|
|
1760
1763
|
# system and size type are empty, while size value is "32 inches". A maximum of
|
1761
1764
|
# 20 values are allowed per Product. Each value must be a UTF-8 encoded string
|
1762
1765
|
# with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
|
1763
|
-
# returned. Google Merchant Center property [size](
|
1764
|
-
# merchants/answer/6324492), [size_type](https://
|
1765
|
-
# answer/6324497) and [size_system](https://
|
1766
|
-
# 6324502). Schema.org property [Product.
|
1766
|
+
# returned. Corresponding properties: Google Merchant Center property [size](
|
1767
|
+
# https://support.google.com/merchants/answer/6324492), [size_type](https://
|
1768
|
+
# support.google.com/merchants/answer/6324497), and [size_system](https://
|
1769
|
+
# support.google.com/merchants/answer/6324502). Schema.org property [Product.
|
1770
|
+
# size](https://schema.org/size).
|
1767
1771
|
# Corresponds to the JSON property `sizes`
|
1768
1772
|
# @return [Array<String>]
|
1769
1773
|
attr_accessor :sizes
|
@@ -1772,17 +1776,18 @@ module Google
|
|
1772
1776
|
# Product. This value must be a UTF-8 encoded string with a length limit of 1,
|
1773
1777
|
# 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
|
1774
1778
|
# be used for filtering recommendation results by passing the tag as part of the
|
1775
|
-
# PredictRequest.filter. Google Merchant Center
|
1776
|
-
# https://support.google.com/merchants/answer/
|
1779
|
+
# PredictRequest.filter. Corresponding properties: Google Merchant Center
|
1780
|
+
# property [custom_label_0–4](https://support.google.com/merchants/answer/
|
1781
|
+
# 6324473).
|
1777
1782
|
# Corresponds to the JSON property `tags`
|
1778
1783
|
# @return [Array<String>]
|
1779
1784
|
attr_accessor :tags
|
1780
1785
|
|
1781
1786
|
# Required. Product title. This field must be a UTF-8 encoded string with a
|
1782
1787
|
# length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
|
1783
|
-
# returned. Google Merchant Center property [title](
|
1784
|
-
# merchants/answer/6324415). Schema.org property [
|
1785
|
-
# org/name).
|
1788
|
+
# returned. Corresponding properties: Google Merchant Center property [title](
|
1789
|
+
# https://support.google.com/merchants/answer/6324415). Schema.org property [
|
1790
|
+
# Product.name](https://schema.org/name).
|
1786
1791
|
# Corresponds to the JSON property `title`
|
1787
1792
|
# @return [String]
|
1788
1793
|
attr_accessor :title
|
@@ -1808,9 +1813,9 @@ module Google
|
|
1808
1813
|
# recommended to provide a valid uri for the product, otherwise the service
|
1809
1814
|
# performance could be significantly degraded. This field must be a UTF-8
|
1810
1815
|
# encoded string with a length limit of 5,000 characters. Otherwise, an
|
1811
|
-
# INVALID_ARGUMENT error is returned. Google Merchant
|
1812
|
-
# https://support.google.com/merchants/answer/6324416).
|
1813
|
-
# Offer.url](https://schema.org/url).
|
1816
|
+
# INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
|
1817
|
+
# Center property [link](https://support.google.com/merchants/answer/6324416).
|
1818
|
+
# Schema.org property [Offer.url](https://schema.org/url).
|
1814
1819
|
# Corresponds to the JSON property `uri`
|
1815
1820
|
# @return [String]
|
1816
1821
|
attr_accessor :uri
|
@@ -1952,15 +1957,15 @@ module Google
|
|
1952
1957
|
include Google::Apis::Core::Hashable
|
1953
1958
|
|
1954
1959
|
# The type of Products allowed to be ingested into the catalog. Acceptable
|
1955
|
-
# values are: * `primary` (default): You can
|
1956
|
-
#
|
1957
|
-
#
|
1958
|
-
#
|
1959
|
-
#
|
1960
|
-
#
|
1961
|
-
#
|
1962
|
-
#
|
1963
|
-
#
|
1960
|
+
# values are: * `primary` (default): You can ingest Products of all types. When
|
1961
|
+
# ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
|
1962
|
+
# `variant`: You can only ingest Product.Type.VARIANT Products. This means
|
1963
|
+
# Product.primary_product_id cannot be empty. If this field is set to an invalid
|
1964
|
+
# value other than these, an INVALID_ARGUMENT error is returned. If this field
|
1965
|
+
# is `variant` and merchant_center_product_id_field is `itemGroupId`, an
|
1966
|
+
# INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
|
1967
|
+
# google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
|
1968
|
+
# details.
|
1964
1969
|
# Corresponds to the JSON property `ingestionProductType`
|
1965
1970
|
# @return [String]
|
1966
1971
|
attr_accessor :ingestion_product_type
|
@@ -2420,24 +2425,26 @@ module Google
|
|
2420
2425
|
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
|
2421
2426
|
attr_accessor :user_info
|
2422
2427
|
|
2423
|
-
# The keys to fetch and rollup the matching variant Products attributes
|
2424
|
-
#
|
2425
|
-
#
|
2426
|
-
#
|
2427
|
-
#
|
2428
|
-
# fulfillmentId". E.g., in "
|
2429
|
-
# fulfillment type and "store123" is
|
2430
|
-
#
|
2431
|
-
#
|
2432
|
-
#
|
2433
|
-
#
|
2434
|
-
#
|
2435
|
-
#
|
2436
|
-
#
|
2437
|
-
#
|
2438
|
-
#
|
2439
|
-
# FulfillmentInfo.type "
|
2440
|
-
#
|
2428
|
+
# The keys to fetch and rollup the matching variant Products attributes,
|
2429
|
+
# FulfillmentInfo or LocalInventorys attributes. The attributes from all the
|
2430
|
+
# matching variant Products or LocalInventorys are merged and de-duplicated.
|
2431
|
+
# Notice that rollup attributes will lead to extra query latency. Maximum number
|
2432
|
+
# of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID
|
2433
|
+
# must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "
|
2434
|
+
# pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is
|
2435
|
+
# the store ID. Supported keys are: * colorFamilies * price * originalPrice *
|
2436
|
+
# discount * variantId * inventory(place_id,price) * inventory(place_id,
|
2437
|
+
# original_price) * inventory(place_id,attributes.key), where key is any key in
|
2438
|
+
# the Product.inventories.attributes map. * attributes.key, where key is any key
|
2439
|
+
# in the Product.attributes map. * pickupInStore.id, where id is any
|
2440
|
+
# FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
|
2441
|
+
# shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
|
2442
|
+
# type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
|
2443
|
+
# place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
|
2444
|
+
# where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
|
2445
|
+
# delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
|
2446
|
+
# for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
|
2447
|
+
# any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
|
2441
2448
|
# customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
|
2442
2449
|
# FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
|
2443
2450
|
# FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
|
@@ -2451,9 +2458,9 @@ module Google
|
|
2451
2458
|
# Required. A unique identifier for tracking visitors. For example, this could
|
2452
2459
|
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
2453
2460
|
# a visitor on a single device. This unique identifier should not change if the
|
2454
|
-
# visitor logs in or out of the website.
|
2455
|
-
#
|
2456
|
-
# error is returned.
|
2461
|
+
# visitor logs in or out of the website. This should be the same identifier as
|
2462
|
+
# UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length
|
2463
|
+
# limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2457
2464
|
# Corresponds to the JSON property `visitorId`
|
2458
2465
|
# @return [String]
|
2459
2466
|
attr_accessor :visitor_id
|
@@ -2655,9 +2662,10 @@ module Google
|
|
2655
2662
|
# colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
|
2656
2663
|
# * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
|
2657
2664
|
# customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
|
2658
|
-
# customFulfillment4" * "customFulfillment5" *
|
2659
|
-
#
|
2660
|
-
# price)"
|
2665
|
+
# customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
|
2666
|
+
# key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
|
2667
|
+
# attributes.key" * "inventory(place_id,price)" * "inventory(place_id,
|
2668
|
+
# original_price)" * "inventory(place_id,attributes.key)"
|
2661
2669
|
# Corresponds to the JSON property `key`
|
2662
2670
|
# @return [String]
|
2663
2671
|
attr_accessor :key
|
@@ -2756,6 +2764,12 @@ module Google
|
|
2756
2764
|
class GoogleCloudRetailV2SearchResponse
|
2757
2765
|
include Google::Apis::Core::Hashable
|
2758
2766
|
|
2767
|
+
# The fully qualified resource name of applied [controls](https://cloud.google.
|
2768
|
+
# com/retail/docs/serving-control-rules).
|
2769
|
+
# Corresponds to the JSON property `appliedControls`
|
2770
|
+
# @return [Array<String>]
|
2771
|
+
attr_accessor :applied_controls
|
2772
|
+
|
2759
2773
|
# A unique search token. This should be included in the UserEvent logs resulting
|
2760
2774
|
# from this search, which enables accurate attribution of search model
|
2761
2775
|
# performance.
|
@@ -2810,6 +2824,7 @@ module Google
|
|
2810
2824
|
|
2811
2825
|
# Update properties of this object
|
2812
2826
|
def update!(**args)
|
2827
|
+
@applied_controls = args[:applied_controls] if args.key?(:applied_controls)
|
2813
2828
|
@attribution_token = args[:attribution_token] if args.key?(:attribution_token)
|
2814
2829
|
@corrected_query = args[:corrected_query] if args.key?(:corrected_query)
|
2815
2830
|
@facets = args[:facets] if args.key?(:facets)
|
@@ -3035,10 +3050,9 @@ module Google
|
|
3035
3050
|
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2Product]
|
3036
3051
|
attr_accessor :inventory
|
3037
3052
|
|
3038
|
-
# Indicates which inventory fields in the provided Product to update.
|
3039
|
-
#
|
3040
|
-
#
|
3041
|
-
# returned and the entire update will be ignored.
|
3053
|
+
# Indicates which inventory fields in the provided Product to update. At least
|
3054
|
+
# one field must be provided. If an unsupported or unknown field is provided, an
|
3055
|
+
# INVALID_ARGUMENT error is returned and the entire update will be ignored.
|
3042
3056
|
# Corresponds to the JSON property `setMask`
|
3043
3057
|
# @return [String]
|
3044
3058
|
attr_accessor :set_mask
|
@@ -3082,12 +3096,15 @@ module Google
|
|
3082
3096
|
class GoogleCloudRetailV2UserEvent
|
3083
3097
|
include Google::Apis::Core::Hashable
|
3084
3098
|
|
3085
|
-
# Extra user event features to include in the recommendation model.
|
3086
|
-
#
|
3087
|
-
#
|
3088
|
-
#
|
3089
|
-
#
|
3090
|
-
#
|
3099
|
+
# Extra user event features to include in the recommendation model. This field
|
3100
|
+
# needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
|
3101
|
+
# returned: * The key must be a UTF-8 encoded string with a length limit of 5,
|
3102
|
+
# 000 characters. * For text attributes, at most 400 values are allowed. Empty
|
3103
|
+
# values are not allowed. Each value must be a UTF-8 encoded string with a
|
3104
|
+
# length limit of 256 characters. * For number attributes, at most 400 values
|
3105
|
+
# are allowed. For product recommendation, an example of extra user information
|
3106
|
+
# is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
|
3107
|
+
# site by coming to the site directly, or coming through Google search, and etc.
|
3091
3108
|
# Corresponds to the JSON property `attributes`
|
3092
3109
|
# @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
|
3093
3110
|
attr_accessor :attributes
|
@@ -3129,12 +3146,11 @@ module Google
|
|
3129
3146
|
|
3130
3147
|
# Required. User event type. Allowed values are: * `add-to-cart`: Products being
|
3131
3148
|
# added to cart. * `category-page-view`: Special pages such as sale or promotion
|
3132
|
-
# pages viewed. * `
|
3133
|
-
#
|
3134
|
-
#
|
3135
|
-
#
|
3136
|
-
#
|
3137
|
-
# User viewing a shopping cart.
|
3149
|
+
# pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-
|
3150
|
+
# view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user.
|
3151
|
+
# * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-
|
3152
|
+
# complete`: User finishing a purchase. * `search`: Product search. * `shopping-
|
3153
|
+
# cart-page-view`: User viewing a shopping cart.
|
3138
3154
|
# Corresponds to the JSON property `eventType`
|
3139
3155
|
# @return [String]
|
3140
3156
|
attr_accessor :event_type
|
@@ -3899,6 +3915,35 @@ module Google
|
|
3899
3915
|
end
|
3900
3916
|
end
|
3901
3917
|
|
3918
|
+
# Metadata related to the progress of the SetLocalInventories operation.
|
3919
|
+
# Currently empty because there is no meaningful metadata populated from the
|
3920
|
+
# SetLocalInventories method.
|
3921
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
|
3922
|
+
include Google::Apis::Core::Hashable
|
3923
|
+
|
3924
|
+
def initialize(**args)
|
3925
|
+
update!(**args)
|
3926
|
+
end
|
3927
|
+
|
3928
|
+
# Update properties of this object
|
3929
|
+
def update!(**args)
|
3930
|
+
end
|
3931
|
+
end
|
3932
|
+
|
3933
|
+
# Response of the SetLocalInventories API. Currently empty because there is no
|
3934
|
+
# meaningful response populated from the SetLocalInventories method.
|
3935
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
|
3936
|
+
include Google::Apis::Core::Hashable
|
3937
|
+
|
3938
|
+
def initialize(**args)
|
3939
|
+
update!(**args)
|
3940
|
+
end
|
3941
|
+
|
3942
|
+
# Update properties of this object
|
3943
|
+
def update!(**args)
|
3944
|
+
end
|
3945
|
+
end
|
3946
|
+
|
3902
3947
|
# A summary of import result. The UserEventImportSummary summarizes the import
|
3903
3948
|
# status for user events.
|
3904
3949
|
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
|
+
GEM_VERSION = "0.24.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 = "
|
25
|
+
REVISION = "20211210"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -628,6 +628,18 @@ module Google
|
|
628
628
|
include Google::Apis::Core::JsonObjectSupport
|
629
629
|
end
|
630
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
|
+
|
631
643
|
class GoogleCloudRetailV2alphaUserEventImportSummary
|
632
644
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
633
645
|
|
@@ -1431,6 +1443,7 @@ module Google
|
|
1431
1443
|
class GoogleCloudRetailV2SearchResponse
|
1432
1444
|
# @private
|
1433
1445
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1446
|
+
collection :applied_controls, as: 'appliedControls'
|
1434
1447
|
property :attribution_token, as: 'attributionToken'
|
1435
1448
|
property :corrected_query, as: 'correctedQuery'
|
1436
1449
|
collection :facets, as: 'facets', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet::Representation
|
@@ -1755,6 +1768,18 @@ module Google
|
|
1755
1768
|
end
|
1756
1769
|
end
|
1757
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
|
+
|
1758
1783
|
class GoogleCloudRetailV2alphaUserEventImportSummary
|
1759
1784
|
# @private
|
1760
1785
|
class Representation < Google::Apis::Core::JsonRepresentation
|
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.
|
4
|
+
version: 0.24.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:
|
11
|
+
date: 2022-01-10 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.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.24.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.
|
78
|
+
rubygems_version: 3.3.4
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Retail API V2
|