google-apis-retail_v2beta 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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bffa1782de1971c6d9d824947c86ce8f91a28a6593d9dafd607d97cb6595f25b
4
- data.tar.gz: c8bb1b1967f1943c20277f464a1a417d9007a09296908d64c6d9c1b79b4cb677
3
+ metadata.gz: 77532d3ad3229df049138ad832de3caac4f9b5eb93034a63208bc001cc232222
4
+ data.tar.gz: bce93727c34fa942675e30bd1c9fc2c4a8500be45b899b169a4696a1f8f4d372
5
5
  SHA512:
6
- metadata.gz: 0e3c4f0fad5cd484c234fc15a7bd26a542b75c1b891b8a9b22418b9d2d7cd84421ea0b436a9a98a8a1abbf66656c91173f5629f1fc0c0e32e5f265b4a785738c
7
- data.tar.gz: 93ec77e2238c9cd3fa3fbefdc48cd7b814c2dd4bafadc4d1e1d1d655e51f1ad9f94d837437093a1ceb6feaeedbfd5aef1449800000f4dcc9b2e96965db515e10
6
+ metadata.gz: a40af22cc91e8f4b6f9ee0d54d7ec52736b220928fda1a29b0690f44b6fb1c4e7ddc2e02f29de4592eb4a5e0da08a0ae153d64b4b733d22c94bcad18e08d686f
7
+ data.tar.gz: 0f826317761ad042e335e5103f8da9a35b9e49294435112a7ea4b07c2c2d9600ba2c39832a486f3af20aafa3d0c1c6d06bb6480e21b84a0264e2f0d078f45086
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Release history for google-apis-retail_v2beta
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_v2beta"
51
51
  client = Google::Apis::RetailV2beta::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.
@@ -1090,6 +1090,35 @@ module Google
1090
1090
  end
1091
1091
  end
1092
1092
 
1093
+ # Metadata related to the progress of the SetLocalInventories operation.
1094
+ # Currently empty because there is no meaningful metadata populated from the
1095
+ # SetLocalInventories method.
1096
+ class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
1097
+ include Google::Apis::Core::Hashable
1098
+
1099
+ def initialize(**args)
1100
+ update!(**args)
1101
+ end
1102
+
1103
+ # Update properties of this object
1104
+ def update!(**args)
1105
+ end
1106
+ end
1107
+
1108
+ # Response of the SetLocalInventories API. Currently empty because there is no
1109
+ # meaningful response populated from the SetLocalInventories method.
1110
+ class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
1111
+ include Google::Apis::Core::Hashable
1112
+
1113
+ def initialize(**args)
1114
+ update!(**args)
1115
+ end
1116
+
1117
+ # Update properties of this object
1118
+ def update!(**args)
1119
+ end
1120
+ end
1121
+
1093
1122
  # A summary of import result. The UserEventImportSummary summarizes the import
1094
1123
  # status for user events.
1095
1124
  class GoogleCloudRetailV2alphaUserEventImportSummary
@@ -1534,9 +1563,8 @@ module Google
1534
1563
  alias_method :indexable?, :indexable
1535
1564
 
1536
1565
  # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
1537
- # the key is "lengths_cm". At most 400 values are allowed.Otherwise, an
1538
- # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
1539
- # set. Otherwise, an INVALID_ARGUMENT error is returned.
1566
+ # the key is "lengths_cm". Exactly one of text or numbers should be set.
1567
+ # Otherwise, an INVALID_ARGUMENT error is returned.
1540
1568
  # Corresponds to the JSON property `numbers`
1541
1569
  # @return [Array<Float>]
1542
1570
  attr_accessor :numbers
@@ -1550,11 +1578,8 @@ module Google
1550
1578
  alias_method :searchable?, :searchable
1551
1579
 
1552
1580
  # The textual values of this custom attribute. For example, `["yellow", "green"]`
1553
- # when the key is "color". At most 400 values are allowed. Empty values are not
1554
- # allowed. Each value must be a UTF-8 encoded string with a length limit of 256
1555
- # characters. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of
1556
- # text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is
1557
- # returned.
1581
+ # when the key is "color". Exactly one of text or numbers should be set.
1582
+ # Otherwise, an INVALID_ARGUMENT error is returned.
1558
1583
  # Corresponds to the JSON property `text`
1559
1584
  # @return [Array<String>]
1560
1585
  attr_accessor :text
@@ -1721,6 +1746,8 @@ module Google
1721
1746
  # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
1722
1747
  # imports: * `user_event` (default): One JSON UserEvent per line. * `
1723
1748
  # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719.
1749
+ # Supported values for control imports: * 'control' (default): One JSON Control
1750
+ # per line.
1724
1751
  # Corresponds to the JSON property `dataSchema`
1725
1752
  # @return [String]
1726
1753
  attr_accessor :data_schema
@@ -2374,8 +2401,8 @@ module Google
2374
2401
  attr_accessor :original_price
2375
2402
 
2376
2403
  # Price of the product. Google Merchant Center property [price](https://support.
2377
- # google.com/merchants/answer/6324371). Schema.org property [Offer.
2378
- # priceSpecification](https://schema.org/priceSpecification).
2404
+ # google.com/merchants/answer/6324371). Schema.org property [Offer.price](https:/
2405
+ # /schema.org/price).
2379
2406
  # Corresponds to the JSON property `price`
2380
2407
  # @return [Float]
2381
2408
  attr_accessor :price
@@ -2463,7 +2490,10 @@ module Google
2463
2490
  # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
2464
2491
  # be a UTF-8 encoded string with a length limit of 128 characters. * For
2465
2492
  # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
2466
- # key0LikeThis or KEY_1_LIKE_THIS.
2493
+ # `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
2494
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
2495
+ # encoded string with a length limit of 256 characters. * For number attributes,
2496
+ # at most 400 values are allowed.
2467
2497
  # Corresponds to the JSON property `attributes`
2468
2498
  # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
2469
2499
  attr_accessor :attributes
@@ -2474,9 +2504,9 @@ module Google
2474
2504
  attr_accessor :audience
2475
2505
 
2476
2506
  # The online availability of the Product. Default to Availability.IN_STOCK.
2477
- # Google Merchant Center Property [availability](https://support.google.com/
2478
- # merchants/answer/6324448). Schema.org Property [Offer.availability](https://
2479
- # schema.org/availability).
2507
+ # Corresponding properties: Google Merchant Center property [availability](https:
2508
+ # //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
2509
+ # availability](https://schema.org/availability).
2480
2510
  # Corresponds to the JSON property `availability`
2481
2511
  # @return [String]
2482
2512
  attr_accessor :availability
@@ -2493,9 +2523,9 @@ module Google
2493
2523
 
2494
2524
  # The brands of the product. A maximum of 30 brands are allowed. Each brand must
2495
2525
  # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
2496
- # an INVALID_ARGUMENT error is returned. Google Merchant Center property [brand](
2497
- # https://support.google.com/merchants/answer/6324351). Schema.org property [
2498
- # Product.brand](https://schema.org/brand).
2526
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
2527
+ # Merchant Center property [brand](https://support.google.com/merchants/answer/
2528
+ # 6324351). Schema.org property [Product.brand](https://schema.org/brand).
2499
2529
  # Corresponds to the JSON property `brands`
2500
2530
  # @return [Array<String>]
2501
2531
  attr_accessor :brands
@@ -2512,10 +2542,10 @@ module Google
2512
2542
  # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
2513
2543
  # Empty values are not allowed. Each value must be a UTF-8 encoded string with
2514
2544
  # a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
2515
- # returned. Google Merchant Center property google_product_category. Schema.org
2516
- # property [Product.category] (https://schema.org/category). [
2517
- # mc_google_product_category]: https://support.google.com/merchants/answer/
2518
- # 6324436
2545
+ # returned. Corresponding properties: Google Merchant Center property
2546
+ # google_product_category. Schema.org property [Product.category] (https://
2547
+ # schema.org/category). [mc_google_product_category]: https://support.google.com/
2548
+ # merchants/answer/6324436
2519
2549
  # Corresponds to the JSON property `categories`
2520
2550
  # @return [Array<String>]
2521
2551
  attr_accessor :categories
@@ -2535,19 +2565,19 @@ module Google
2535
2565
  # The condition of the product. Strongly encouraged to use the standard values: "
2536
2566
  # new", "refurbished", "used". A maximum of 5 values are allowed per Product.
2537
2567
  # Each value must be a UTF-8 encoded string with a length limit of 128
2538
- # characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant
2539
- # Center property [condition](https://support.google.com/merchants/answer/
2540
- # 6324469). Schema.org property [Offer.itemCondition](https://schema.org/
2541
- # itemCondition).
2568
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
2569
+ # properties: Google Merchant Center property [condition](https://support.google.
2570
+ # com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https:
2571
+ # //schema.org/itemCondition).
2542
2572
  # Corresponds to the JSON property `conditions`
2543
2573
  # @return [Array<String>]
2544
2574
  attr_accessor :conditions
2545
2575
 
2546
2576
  # Product description. This field must be a UTF-8 encoded string with a length
2547
2577
  # limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2548
- # Google Merchant Center property [description](https://support.google.com/
2549
- # merchants/answer/6324468). schema.org property [Product.description](https://
2550
- # schema.org/description).
2578
+ # Corresponding properties: Google Merchant Center property [description](https:/
2579
+ # /support.google.com/merchants/answer/6324468). Schema.org property [Product.
2580
+ # description](https://schema.org/description).
2551
2581
  # Corresponds to the JSON property `description`
2552
2582
  # @return [String]
2553
2583
  attr_accessor :description
@@ -2557,8 +2587,8 @@ module Google
2557
2587
  # expire_time. However, the product can still be retrieved by ProductService.
2558
2588
  # GetProduct and ProductService.ListProducts. expire_time must be later than
2559
2589
  # available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
2560
- # Google Merchant Center property [expiration_date](https://support.google.com/
2561
- # merchants/answer/6324499).
2590
+ # Corresponding properties: Google Merchant Center property [expiration_date](
2591
+ # https://support.google.com/merchants/answer/6324499).
2562
2592
  # Corresponds to the JSON property `expireTime`
2563
2593
  # @return [String]
2564
2594
  attr_accessor :expire_time
@@ -2573,12 +2603,13 @@ module Google
2573
2603
  # The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
2574
2604
  # encoded string with a length limit of 128 characters. Otherwise, an
2575
2605
  # INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
2576
- # an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](
2577
- # https://support.google.com/merchants/answer/6324461). Schema.org property [
2578
- # Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/
2579
- # gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](
2580
- # https://schema.org/gtin13) or [Product.gtin14](https://schema.org/gtin14). If
2581
- # the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
2606
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
2607
+ # Merchant Center property [gtin](https://support.google.com/merchants/answer/
2608
+ # 6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [
2609
+ # Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/
2610
+ # gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](
2611
+ # https://schema.org/gtin14). If the value is not a valid GTIN, an
2612
+ # INVALID_ARGUMENT error is returned.
2582
2613
  # Corresponds to the JSON property `gtin`
2583
2614
  # @return [String]
2584
2615
  attr_accessor :gtin
@@ -2587,27 +2618,28 @@ module Google
2587
2618
  # example, this field is "id_1", if name is `projects/*/locations/global/
2588
2619
  # catalogs/default_catalog/branches/default_branch/products/id_1`. This field
2589
2620
  # must be a UTF-8 encoded string with a length limit of 128 characters.
2590
- # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
2591
- # property [id](https://support.google.com/merchants/answer/6324405). Schema.org
2592
- # Property [Product.sku](https://schema.org/sku).
2621
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
2622
+ # Google Merchant Center property [id](https://support.google.com/merchants/
2623
+ # answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
2593
2624
  # Corresponds to the JSON property `id`
2594
2625
  # @return [String]
2595
2626
  attr_accessor :id
2596
2627
 
2597
2628
  # Product images for the product.Highly recommended to put the main image to the
2598
- # first. A maximum of 300 images are allowed. Google Merchant Center property [
2599
- # image_link](https://support.google.com/merchants/answer/6324350). Schema.org
2600
- # property [Product.image](https://schema.org/image).
2629
+ # first. A maximum of 300 images are allowed. Corresponding properties: Google
2630
+ # Merchant Center property [image_link](https://support.google.com/merchants/
2631
+ # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
2601
2632
  # Corresponds to the JSON property `images`
2602
2633
  # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImage>]
2603
2634
  attr_accessor :images
2604
2635
 
2605
2636
  # Language of the title/description and other string attributes. Use language
2606
- # tags defined by BCP 47. For product prediction, this field is ignored and the
2607
- # model automatically detects the text language. The Product can include text in
2608
- # different languages, but duplicating Products to provide text in multiple
2609
- # languages can result in degraded model performance. For product search this
2610
- # field is in use. It defaults to "en-US" if unset.
2637
+ # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For
2638
+ # product prediction, this field is ignored and the model automatically detects
2639
+ # the text language. The Product can include text in different languages, but
2640
+ # duplicating Products to provide text in multiple languages can result in
2641
+ # degraded model performance. For product search this field is in use. It
2642
+ # defaults to "en-US" if unset.
2611
2643
  # Corresponds to the JSON property `languageCode`
2612
2644
  # @return [String]
2613
2645
  attr_accessor :language_code
@@ -2615,9 +2647,9 @@ module Google
2615
2647
  # The material of the product. For example, "leather", "wooden". A maximum of 20
2616
2648
  # values are allowed. Each value must be a UTF-8 encoded string with a length
2617
2649
  # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2618
- # Google Merchant Center property [material](https://support.google.com/
2619
- # merchants/answer/6324410). Schema.org property [Product.material](https://
2620
- # schema.org/material).
2650
+ # Corresponding properties: Google Merchant Center property [material](https://
2651
+ # support.google.com/merchants/answer/6324410). Schema.org property [Product.
2652
+ # material](https://schema.org/material).
2621
2653
  # Corresponds to the JSON property `materials`
2622
2654
  # @return [Array<String>]
2623
2655
  attr_accessor :materials
@@ -2631,9 +2663,10 @@ module Google
2631
2663
  # The pattern or graphic print of the product. For example, "striped", "polka
2632
2664
  # dot", "paisley". A maximum of 20 values are allowed per Product. Each value
2633
2665
  # must be a UTF-8 encoded string with a length limit of 128 characters.
2634
- # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
2635
- # property [pattern](https://support.google.com/merchants/answer/6324483).
2636
- # Schema.org property [Product.pattern](https://schema.org/pattern).
2666
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
2667
+ # Google Merchant Center property [pattern](https://support.google.com/merchants/
2668
+ # answer/6324483). Schema.org property [Product.pattern](https://schema.org/
2669
+ # pattern).
2637
2670
  # Corresponds to the JSON property `patterns`
2638
2671
  # @return [Array<String>]
2639
2672
  attr_accessor :patterns
@@ -2648,10 +2681,9 @@ module Google
2648
2681
  # can only be empty or set to the same value as id. For VARIANT Products, this
2649
2682
  # field cannot be empty. A maximum of 2,000 products are allowed to share the
2650
2683
  # same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.
2651
- # Google Merchant Center Property [item_group_id](https://support.google.com/
2652
- # merchants/answer/6324507). Schema.org Property [Product.inProductGroupWithID](
2653
- # https://schema.org/inProductGroupWithID). This field must be enabled before it
2654
- # can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).
2684
+ # Corresponding properties: Google Merchant Center property [item_group_id](
2685
+ # https://support.google.com/merchants/answer/6324507). Schema.org property [
2686
+ # Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
2655
2687
  # Corresponds to the JSON property `primaryProductId`
2656
2688
  # @return [String]
2657
2689
  attr_accessor :primary_product_id
@@ -2700,10 +2732,11 @@ module Google
2700
2732
  # system and size type are empty, while size value is "32 inches". A maximum of
2701
2733
  # 20 values are allowed per Product. Each value must be a UTF-8 encoded string
2702
2734
  # with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
2703
- # returned. Google Merchant Center property [size](https://support.google.com/
2704
- # merchants/answer/6324492), [size_type](https://support.google.com/merchants/
2705
- # answer/6324497) and [size_system](https://support.google.com/merchants/answer/
2706
- # 6324502). Schema.org property [Product.size](https://schema.org/size).
2735
+ # returned. Corresponding properties: Google Merchant Center property [size](
2736
+ # https://support.google.com/merchants/answer/6324492), [size_type](https://
2737
+ # support.google.com/merchants/answer/6324497), and [size_system](https://
2738
+ # support.google.com/merchants/answer/6324502). Schema.org property [Product.
2739
+ # size](https://schema.org/size).
2707
2740
  # Corresponds to the JSON property `sizes`
2708
2741
  # @return [Array<String>]
2709
2742
  attr_accessor :sizes
@@ -2712,17 +2745,18 @@ module Google
2712
2745
  # Product. This value must be a UTF-8 encoded string with a length limit of 1,
2713
2746
  # 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
2714
2747
  # be used for filtering recommendation results by passing the tag as part of the
2715
- # PredictRequest.filter. Google Merchant Center property [custom_label_0–4](
2716
- # https://support.google.com/merchants/answer/6324473).
2748
+ # PredictRequest.filter. Corresponding properties: Google Merchant Center
2749
+ # property [custom_label_0–4](https://support.google.com/merchants/answer/
2750
+ # 6324473).
2717
2751
  # Corresponds to the JSON property `tags`
2718
2752
  # @return [Array<String>]
2719
2753
  attr_accessor :tags
2720
2754
 
2721
2755
  # Required. Product title. This field must be a UTF-8 encoded string with a
2722
2756
  # length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
2723
- # returned. Google Merchant Center property [title](https://support.google.com/
2724
- # merchants/answer/6324415). Schema.org property [Product.name](https://schema.
2725
- # org/name).
2757
+ # returned. Corresponding properties: Google Merchant Center property [title](
2758
+ # https://support.google.com/merchants/answer/6324415). Schema.org property [
2759
+ # Product.name](https://schema.org/name).
2726
2760
  # Corresponds to the JSON property `title`
2727
2761
  # @return [String]
2728
2762
  attr_accessor :title
@@ -2748,9 +2782,9 @@ module Google
2748
2782
  # recommended to provide a valid uri for the product, otherwise the service
2749
2783
  # performance could be significantly degraded. This field must be a UTF-8
2750
2784
  # encoded string with a length limit of 5,000 characters. Otherwise, an
2751
- # INVALID_ARGUMENT error is returned. Google Merchant Center property [link](
2752
- # https://support.google.com/merchants/answer/6324416). Schema.org property [
2753
- # Offer.url](https://schema.org/url).
2785
+ # INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
2786
+ # Center property [link](https://support.google.com/merchants/answer/6324416).
2787
+ # Schema.org property [Offer.url](https://schema.org/url).
2754
2788
  # Corresponds to the JSON property `uri`
2755
2789
  # @return [String]
2756
2790
  attr_accessor :uri
@@ -2892,15 +2926,15 @@ module Google
2892
2926
  include Google::Apis::Core::Hashable
2893
2927
 
2894
2928
  # The type of Products allowed to be ingested into the catalog. Acceptable
2895
- # values are: * `primary` (default): You can only ingest Product.Type.PRIMARY
2896
- # Products. This means Product.primary_product_id can only be empty or set to
2897
- # the same value as Product.id. * `variant`: You can only ingest Product.Type.
2898
- # VARIANT Products. This means Product.primary_product_id cannot be empty. If
2899
- # this field is set to an invalid value other than these, an INVALID_ARGUMENT
2900
- # error is returned. If this field is `variant` and
2901
- # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
2902
- # is returned. See [Using product levels](https://cloud.google.com/retail/
2903
- # recommendations-ai/docs/catalog#product-levels) for more details.
2929
+ # values are: * `primary` (default): You can ingest Products of all types. When
2930
+ # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
2931
+ # `variant`: You can only ingest Product.Type.VARIANT Products. This means
2932
+ # Product.primary_product_id cannot be empty. If this field is set to an invalid
2933
+ # value other than these, an INVALID_ARGUMENT error is returned. If this field
2934
+ # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
2935
+ # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
2936
+ # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
2937
+ # details.
2904
2938
  # Corresponds to the JSON property `ingestionProductType`
2905
2939
  # @return [String]
2906
2940
  attr_accessor :ingestion_product_type
@@ -3360,24 +3394,26 @@ module Google
3360
3394
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo]
3361
3395
  attr_accessor :user_info
3362
3396
 
3363
- # The keys to fetch and rollup the matching variant Products attributes. The
3364
- # attributes from all the matching variant Products are merged and de-duplicated.
3365
- # Notice that rollup variant Products attributes will lead to extra query
3366
- # latency. Maximum number of keys is 10. For FulfillmentInfo, a fulfillment type
3367
- # and a fulfillment ID must be provided in the format of "fulfillmentType.
3368
- # fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
3369
- # fulfillment type and "store123" is the store ID. Supported keys are: *
3370
- # colorFamilies * price * originalPrice * discount * inventory(place_id,price) *
3371
- # attributes.key, where key is any key in the Product.attributes map. *
3372
- # pickupInStore.id, where id is any FulfillmentInfo.place_ids for
3373
- # FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any
3374
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". *
3375
- # sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for
3376
- # FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
3377
- # any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". *
3378
- # customFulfillment1.id, where id is any FulfillmentInfo.place_ids for
3379
- # FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any
3380
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
3397
+ # The keys to fetch and rollup the matching variant Products attributes,
3398
+ # FulfillmentInfo or LocalInventorys attributes. The attributes from all the
3399
+ # matching variant Products or LocalInventorys are merged and de-duplicated.
3400
+ # Notice that rollup attributes will lead to extra query latency. Maximum number
3401
+ # of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID
3402
+ # must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "
3403
+ # pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is
3404
+ # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
3405
+ # discount * variantId * inventory(place_id,price) * inventory(place_id,
3406
+ # original_price) * inventory(place_id,attributes.key), where key is any key in
3407
+ # the Product.inventories.attributes map. * attributes.key, where key is any key
3408
+ # in the Product.attributes map. * pickupInStore.id, where id is any
3409
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
3410
+ # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
3411
+ # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
3412
+ # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
3413
+ # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
3414
+ # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
3415
+ # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
3416
+ # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
3381
3417
  # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
3382
3418
  # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
3383
3419
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
@@ -3391,9 +3427,9 @@ module Google
3391
3427
  # Required. A unique identifier for tracking visitors. For example, this could
3392
3428
  # be implemented with an HTTP cookie, which should be able to uniquely identify
3393
3429
  # a visitor on a single device. This unique identifier should not change if the
3394
- # visitor logs in or out of the website. The field must be a UTF-8 encoded
3395
- # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
3396
- # error is returned.
3430
+ # visitor logs in or out of the website. This should be the same identifier as
3431
+ # UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length
3432
+ # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
3397
3433
  # Corresponds to the JSON property `visitorId`
3398
3434
  # @return [String]
3399
3435
  attr_accessor :visitor_id
@@ -3595,9 +3631,10 @@ module Google
3595
3631
  # colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
3596
3632
  # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
3597
3633
  # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
3598
- # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
3599
- # discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,
3600
- # price)"
3634
+ # customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
3635
+ # key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
3636
+ # attributes.key" * "inventory(place_id,price)" * "inventory(place_id,
3637
+ # original_price)" * "inventory(place_id,attributes.key)"
3601
3638
  # Corresponds to the JSON property `key`
3602
3639
  # @return [String]
3603
3640
  attr_accessor :key
@@ -3696,6 +3733,12 @@ module Google
3696
3733
  class GoogleCloudRetailV2betaSearchResponse
3697
3734
  include Google::Apis::Core::Hashable
3698
3735
 
3736
+ # The fully qualified resource name of applied [controls](https://cloud.google.
3737
+ # com/retail/docs/serving-control-rules).
3738
+ # Corresponds to the JSON property `appliedControls`
3739
+ # @return [Array<String>]
3740
+ attr_accessor :applied_controls
3741
+
3699
3742
  # A unique search token. This should be included in the UserEvent logs resulting
3700
3743
  # from this search, which enables accurate attribution of search model
3701
3744
  # performance.
@@ -3750,6 +3793,7 @@ module Google
3750
3793
 
3751
3794
  # Update properties of this object
3752
3795
  def update!(**args)
3796
+ @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
3753
3797
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
3754
3798
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
3755
3799
  @facets = args[:facets] if args.key?(:facets)
@@ -3975,10 +4019,9 @@ module Google
3975
4019
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct]
3976
4020
  attr_accessor :inventory
3977
4021
 
3978
- # Indicates which inventory fields in the provided Product to update. If not set
3979
- # or set with empty paths, all inventory fields will be updated. If an
3980
- # unsupported or unknown field is provided, an INVALID_ARGUMENT error is
3981
- # returned and the entire update will be ignored.
4022
+ # Indicates which inventory fields in the provided Product to update. At least
4023
+ # one field must be provided. If an unsupported or unknown field is provided, an
4024
+ # INVALID_ARGUMENT error is returned and the entire update will be ignored.
3982
4025
  # Corresponds to the JSON property `setMask`
3983
4026
  # @return [String]
3984
4027
  attr_accessor :set_mask
@@ -4022,12 +4065,15 @@ module Google
4022
4065
  class GoogleCloudRetailV2betaUserEvent
4023
4066
  include Google::Apis::Core::Hashable
4024
4067
 
4025
- # Extra user event features to include in the recommendation model. The key must
4026
- # be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise,
4027
- # an INVALID_ARGUMENT error is returned. For product recommendation, an example
4028
- # of extra user information is traffic_channel, i.e. how user arrives at the
4029
- # site. Users can arrive at the site by coming to the site directly, or coming
4030
- # through Google search, and etc.
4068
+ # Extra user event features to include in the recommendation model. This field
4069
+ # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
4070
+ # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
4071
+ # 000 characters. * For text attributes, at most 400 values are allowed. Empty
4072
+ # values are not allowed. Each value must be a UTF-8 encoded string with a
4073
+ # length limit of 256 characters. * For number attributes, at most 400 values
4074
+ # are allowed. For product recommendation, an example of extra user information
4075
+ # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
4076
+ # site by coming to the site directly, or coming through Google search, and etc.
4031
4077
  # Corresponds to the JSON property `attributes`
4032
4078
  # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
4033
4079
  attr_accessor :attributes
@@ -4069,12 +4115,11 @@ module Google
4069
4115
 
4070
4116
  # Required. User event type. Allowed values are: * `add-to-cart`: Products being
4071
4117
  # added to cart. * `category-page-view`: Special pages such as sale or promotion
4072
- # pages viewed. * `completion`: Completion query result showed/clicked. * `
4073
- # detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage
4074
- # viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-
4075
- # not-offered`: Promotion is not offered to a user. * `purchase-complete`: User
4076
- # finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`:
4077
- # User viewing a shopping cart.
4118
+ # pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-
4119
+ # view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user.
4120
+ # * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-
4121
+ # complete`: User finishing a purchase. * `search`: Product search. * `shopping-
4122
+ # cart-page-view`: User viewing a shopping cart.
4078
4123
  # Corresponds to the JSON property `eventType`
4079
4124
  # @return [String]
4080
4125
  attr_accessor :event_type
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2beta
18
18
  # Version of the google-apis-retail_v2beta gem
19
- GEM_VERSION = "0.20.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 = "20211028"
25
+ REVISION = "20211210"
26
26
  end
27
27
  end
28
28
  end
@@ -298,6 +298,18 @@ module Google
298
298
  include Google::Apis::Core::JsonObjectSupport
299
299
  end
300
300
 
301
+ class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
302
+ class Representation < Google::Apis::Core::JsonRepresentation; end
303
+
304
+ include Google::Apis::Core::JsonObjectSupport
305
+ end
306
+
307
+ class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
308
+ class Representation < Google::Apis::Core::JsonRepresentation; end
309
+
310
+ include Google::Apis::Core::JsonObjectSupport
311
+ end
312
+
301
313
  class GoogleCloudRetailV2alphaUserEventImportSummary
302
314
  class Representation < Google::Apis::Core::JsonRepresentation; end
303
315
 
@@ -1142,6 +1154,18 @@ module Google
1142
1154
  end
1143
1155
  end
1144
1156
 
1157
+ class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
1158
+ # @private
1159
+ class Representation < Google::Apis::Core::JsonRepresentation
1160
+ end
1161
+ end
1162
+
1163
+ class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
1164
+ # @private
1165
+ class Representation < Google::Apis::Core::JsonRepresentation
1166
+ end
1167
+ end
1168
+
1145
1169
  class GoogleCloudRetailV2alphaUserEventImportSummary
1146
1170
  # @private
1147
1171
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1763,6 +1787,7 @@ module Google
1763
1787
  class GoogleCloudRetailV2betaSearchResponse
1764
1788
  # @private
1765
1789
  class Representation < Google::Apis::Core::JsonRepresentation
1790
+ collection :applied_controls, as: 'appliedControls'
1766
1791
  property :attribution_token, as: 'attributionToken'
1767
1792
  property :corrected_query, as: 'correctedQuery'
1768
1793
  collection :facets, as: 'facets', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet::Representation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.20.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: 2021-11-08 00:00:00.000000000 Z
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_v2beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.20.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.24.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
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.4
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Retail API V2beta