google-apis-retail_v2beta 0.19.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f7d15d05d3a8d805fe4e2bb098670c6e91ca1ecda14c338c409573b2477f77e4
4
- data.tar.gz: 66b541010c5ed88e07e9b7b4b3255679179c2c81737c9a646594bb89b1f25207
3
+ metadata.gz: 87730fa76b36bf2889a58f803f05b7c78a0edede1455859efea332c724311fbd
4
+ data.tar.gz: bf16a172bcdbdf5fafe42c93455c3f4c12e89b3e47d605526898b34da6b73461
5
5
  SHA512:
6
- metadata.gz: 153c8d0c9290de93b4e3d453e2bb2c3bafe24f805df11e06e347034adef7d81749fd74198d2b76a90bcb983401381bf7bac902ea64578e296f60f06a151518c9
7
- data.tar.gz: 87079c1602dca343cea8498a1a215bdb512e6beb9f30f989bc30061bcfbc39f079c78038a65c0785672bcdeea228c8c825ad8e082d84a389a728e62ba97a0167
6
+ metadata.gz: 24d8913a036480b3e605dbb38cf3f88fb88473fc2eb3a741320400262f64f2515cb4cb68064e2ed76c962429be68890bf7f783872ba9e6935a0c983676b2a336
7
+ data.tar.gz: 1ac41bbf1134c99d7bd7d9b0e83922b54d5974d832f8dd713d534762404083a739fbe63640e87d60c186c7bd1e97597f38db06393e45c63614c0e0fe5961cf98
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Release history for google-apis-retail_v2beta
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
@@ -647,6 +647,35 @@ module Google
647
647
  end
648
648
  end
649
649
 
650
+ # Metadata related to the progress of the AddLocalInventories operation.
651
+ # Currently empty because there is no meaningful metadata populated from the
652
+ # AddLocalInventories method.
653
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
654
+ include Google::Apis::Core::Hashable
655
+
656
+ def initialize(**args)
657
+ update!(**args)
658
+ end
659
+
660
+ # Update properties of this object
661
+ def update!(**args)
662
+ end
663
+ end
664
+
665
+ # Response of the AddLocalInventories API. Currently empty because there is no
666
+ # meaningful response populated from the AddLocalInventories method.
667
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
668
+ include Google::Apis::Core::Hashable
669
+
670
+ def initialize(**args)
671
+ update!(**args)
672
+ end
673
+
674
+ # Update properties of this object
675
+ def update!(**args)
676
+ end
677
+ end
678
+
650
679
  # Configuration of destination for Export related errors.
651
680
  class GoogleCloudRetailV2alphaExportErrorsConfig
652
681
  include Google::Apis::Core::Hashable
@@ -1003,6 +1032,35 @@ module Google
1003
1032
  end
1004
1033
  end
1005
1034
 
1035
+ # Metadata related to the progress of the RemoveLocalInventories operation.
1036
+ # Currently empty because there is no meaningful metadata populated from the
1037
+ # RemoveLocalInventories method.
1038
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
1039
+ include Google::Apis::Core::Hashable
1040
+
1041
+ def initialize(**args)
1042
+ update!(**args)
1043
+ end
1044
+
1045
+ # Update properties of this object
1046
+ def update!(**args)
1047
+ end
1048
+ end
1049
+
1050
+ # Response of the RemoveLocalInventories API. Currently empty because there is
1051
+ # no meaningful response populated from the RemoveLocalInventories method.
1052
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
1053
+ include Google::Apis::Core::Hashable
1054
+
1055
+ def initialize(**args)
1056
+ update!(**args)
1057
+ end
1058
+
1059
+ # Update properties of this object
1060
+ def update!(**args)
1061
+ end
1062
+ end
1063
+
1006
1064
  # Metadata related to the progress of the SetInventory operation. Currently
1007
1065
  # empty because there is no meaningful metadata populated from the SetInventory
1008
1066
  # method.
@@ -1032,6 +1090,35 @@ module Google
1032
1090
  end
1033
1091
  end
1034
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
+
1035
1122
  # A summary of import result. The UserEventImportSummary summarizes the import
1036
1123
  # status for user events.
1037
1124
  class GoogleCloudRetailV2alphaUserEventImportSummary
@@ -1098,7 +1185,7 @@ module Google
1098
1185
  # or the region IDs for "same-day-delivery" to be added for this type. Duplicate
1099
1186
  # IDs will be automatically ignored. At least 1 value is required, and a maximum
1100
1187
  # of 2000 values are allowed. Each value must be a string with a length limit of
1101
- # 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "
1188
+ # 10 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "
1102
1189
  # REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total
1103
1190
  # number of place IDs exceeds 2000 for this type after adding, then the update
1104
1191
  # will be rejected.
@@ -1476,9 +1563,8 @@ module Google
1476
1563
  alias_method :indexable?, :indexable
1477
1564
 
1478
1565
  # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
1479
- # the key is "lengths_cm". At most 400 values are allowed.Otherwise, an
1480
- # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
1481
- # 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.
1482
1568
  # Corresponds to the JSON property `numbers`
1483
1569
  # @return [Array<Float>]
1484
1570
  attr_accessor :numbers
@@ -1492,11 +1578,8 @@ module Google
1492
1578
  alias_method :searchable?, :searchable
1493
1579
 
1494
1580
  # The textual values of this custom attribute. For example, `["yellow", "green"]`
1495
- # when the key is "color". At most 400 values are allowed. Empty values are not
1496
- # allowed. Each value must be a UTF-8 encoded string with a length limit of 256
1497
- # characters. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of
1498
- # text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is
1499
- # returned.
1581
+ # when the key is "color". Exactly one of text or numbers should be set.
1582
+ # Otherwise, an INVALID_ARGUMENT error is returned.
1500
1583
  # Corresponds to the JSON property `text`
1501
1584
  # @return [Array<String>]
1502
1585
  attr_accessor :text
@@ -1624,7 +1707,7 @@ module Google
1624
1707
  # The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
1625
1708
  # in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
1626
1709
  # maximum of 3000 values are allowed. Each value must be a string with a length
1627
- # limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
1710
+ # limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1"
1628
1711
  # or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
1629
1712
  # Corresponds to the JSON property `placeIds`
1630
1713
  # @return [Array<String>]
@@ -1914,8 +1997,8 @@ module Google
1914
1997
 
1915
1998
  # Unique identifier provided by client, within the ancestor dataset scope.
1916
1999
  # Ensures idempotency and used for request deduplication. Server-generated if
1917
- # unspecified. Up to 128 characters long and must match the pattern: "[a-zA-Z0-
1918
- # 9_]+". This is returned as Operation.name in ImportMetadata. Only supported
2000
+ # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
2001
+ # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
1919
2002
  # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1920
2003
  # Corresponds to the JSON property `requestId`
1921
2004
  # @return [String]
@@ -2404,8 +2487,11 @@ module Google
2404
2487
  # :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
2405
2488
  # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
2406
2489
  # be a UTF-8 encoded string with a length limit of 128 characters. * For
2407
- # indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example,
2408
- # key0LikeThis or KEY_1_LIKE_THIS.
2490
+ # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
2491
+ # `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
2492
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
2493
+ # encoded string with a length limit of 256 characters. * For number attributes,
2494
+ # at most 400 values are allowed.
2409
2495
  # Corresponds to the JSON property `attributes`
2410
2496
  # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
2411
2497
  attr_accessor :attributes
@@ -2416,9 +2502,9 @@ module Google
2416
2502
  attr_accessor :audience
2417
2503
 
2418
2504
  # The online availability of the Product. Default to Availability.IN_STOCK.
2419
- # Google Merchant Center Property [availability](https://support.google.com/
2420
- # merchants/answer/6324448). Schema.org Property [Offer.availability](https://
2421
- # schema.org/availability).
2505
+ # Corresponding properties: Google Merchant Center property [availability](https:
2506
+ # //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
2507
+ # availability](https://schema.org/availability).
2422
2508
  # Corresponds to the JSON property `availability`
2423
2509
  # @return [String]
2424
2510
  attr_accessor :availability
@@ -2435,9 +2521,9 @@ module Google
2435
2521
 
2436
2522
  # The brands of the product. A maximum of 30 brands are allowed. Each brand must
2437
2523
  # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
2438
- # an INVALID_ARGUMENT error is returned. Google Merchant Center property [brand](
2439
- # https://support.google.com/merchants/answer/6324351). Schema.org property [
2440
- # Product.brand](https://schema.org/brand).
2524
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
2525
+ # Merchant Center property [brand](https://support.google.com/merchants/answer/
2526
+ # 6324351). Schema.org property [Product.brand](https://schema.org/brand).
2441
2527
  # Corresponds to the JSON property `brands`
2442
2528
  # @return [Array<String>]
2443
2529
  attr_accessor :brands
@@ -2454,10 +2540,10 @@ module Google
2454
2540
  # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
2455
2541
  # Empty values are not allowed. Each value must be a UTF-8 encoded string with
2456
2542
  # a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
2457
- # returned. Google Merchant Center property google_product_category. Schema.org
2458
- # property [Product.category] (https://schema.org/category). [
2459
- # mc_google_product_category]: https://support.google.com/merchants/answer/
2460
- # 6324436
2543
+ # returned. Corresponding properties: Google Merchant Center property
2544
+ # google_product_category. Schema.org property [Product.category] (https://
2545
+ # schema.org/category). [mc_google_product_category]: https://support.google.com/
2546
+ # merchants/answer/6324436
2461
2547
  # Corresponds to the JSON property `categories`
2462
2548
  # @return [Array<String>]
2463
2549
  attr_accessor :categories
@@ -2477,19 +2563,19 @@ module Google
2477
2563
  # The condition of the product. Strongly encouraged to use the standard values: "
2478
2564
  # new", "refurbished", "used". A maximum of 5 values are allowed per Product.
2479
2565
  # Each value must be a UTF-8 encoded string with a length limit of 128
2480
- # characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant
2481
- # Center property [condition](https://support.google.com/merchants/answer/
2482
- # 6324469). Schema.org property [Offer.itemCondition](https://schema.org/
2483
- # itemCondition).
2566
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
2567
+ # properties: Google Merchant Center property [condition](https://support.google.
2568
+ # com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https:
2569
+ # //schema.org/itemCondition).
2484
2570
  # Corresponds to the JSON property `conditions`
2485
2571
  # @return [Array<String>]
2486
2572
  attr_accessor :conditions
2487
2573
 
2488
2574
  # Product description. This field must be a UTF-8 encoded string with a length
2489
2575
  # limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2490
- # Google Merchant Center property [description](https://support.google.com/
2491
- # merchants/answer/6324468). schema.org property [Product.description](https://
2492
- # schema.org/description).
2576
+ # Corresponding properties: Google Merchant Center property [description](https:/
2577
+ # /support.google.com/merchants/answer/6324468). Schema.org property [Product.
2578
+ # description](https://schema.org/description).
2493
2579
  # Corresponds to the JSON property `description`
2494
2580
  # @return [String]
2495
2581
  attr_accessor :description
@@ -2499,8 +2585,8 @@ module Google
2499
2585
  # expire_time. However, the product can still be retrieved by ProductService.
2500
2586
  # GetProduct and ProductService.ListProducts. expire_time must be later than
2501
2587
  # available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
2502
- # Google Merchant Center property [expiration_date](https://support.google.com/
2503
- # merchants/answer/6324499).
2588
+ # Corresponding properties: Google Merchant Center property [expiration_date](
2589
+ # https://support.google.com/merchants/answer/6324499).
2504
2590
  # Corresponds to the JSON property `expireTime`
2505
2591
  # @return [String]
2506
2592
  attr_accessor :expire_time
@@ -2515,12 +2601,13 @@ module Google
2515
2601
  # The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
2516
2602
  # encoded string with a length limit of 128 characters. Otherwise, an
2517
2603
  # INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
2518
- # an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](
2519
- # https://support.google.com/merchants/answer/6324461). Schema.org property [
2520
- # Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/
2521
- # gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](
2522
- # https://schema.org/gtin13) or [Product.gtin14](https://schema.org/gtin14). If
2523
- # the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
2604
+ # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
2605
+ # Merchant Center property [gtin](https://support.google.com/merchants/answer/
2606
+ # 6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [
2607
+ # Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/
2608
+ # gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](
2609
+ # https://schema.org/gtin14). If the value is not a valid GTIN, an
2610
+ # INVALID_ARGUMENT error is returned.
2524
2611
  # Corresponds to the JSON property `gtin`
2525
2612
  # @return [String]
2526
2613
  attr_accessor :gtin
@@ -2529,27 +2616,28 @@ module Google
2529
2616
  # example, this field is "id_1", if name is `projects/*/locations/global/
2530
2617
  # catalogs/default_catalog/branches/default_branch/products/id_1`. This field
2531
2618
  # must be a UTF-8 encoded string with a length limit of 128 characters.
2532
- # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
2533
- # property [id](https://support.google.com/merchants/answer/6324405). Schema.org
2534
- # Property [Product.sku](https://schema.org/sku).
2619
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
2620
+ # Google Merchant Center property [id](https://support.google.com/merchants/
2621
+ # answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
2535
2622
  # Corresponds to the JSON property `id`
2536
2623
  # @return [String]
2537
2624
  attr_accessor :id
2538
2625
 
2539
2626
  # Product images for the product.Highly recommended to put the main image to the
2540
- # first. A maximum of 300 images are allowed. Google Merchant Center property [
2541
- # image_link](https://support.google.com/merchants/answer/6324350). Schema.org
2542
- # property [Product.image](https://schema.org/image).
2627
+ # first. A maximum of 300 images are allowed. Corresponding properties: Google
2628
+ # Merchant Center property [image_link](https://support.google.com/merchants/
2629
+ # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
2543
2630
  # Corresponds to the JSON property `images`
2544
2631
  # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImage>]
2545
2632
  attr_accessor :images
2546
2633
 
2547
2634
  # Language of the title/description and other string attributes. Use language
2548
- # tags defined by BCP 47. For product prediction, this field is ignored and the
2549
- # model automatically detects the text language. The Product can include text in
2550
- # different languages, but duplicating Products to provide text in multiple
2551
- # languages can result in degraded model performance. For product search this
2552
- # field is in use. It defaults to "en-US" if unset.
2635
+ # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For
2636
+ # product prediction, this field is ignored and the model automatically detects
2637
+ # the text language. The Product can include text in different languages, but
2638
+ # duplicating Products to provide text in multiple languages can result in
2639
+ # degraded model performance. For product search this field is in use. It
2640
+ # defaults to "en-US" if unset.
2553
2641
  # Corresponds to the JSON property `languageCode`
2554
2642
  # @return [String]
2555
2643
  attr_accessor :language_code
@@ -2557,9 +2645,9 @@ module Google
2557
2645
  # The material of the product. For example, "leather", "wooden". A maximum of 20
2558
2646
  # values are allowed. Each value must be a UTF-8 encoded string with a length
2559
2647
  # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2560
- # Google Merchant Center property [material](https://support.google.com/
2561
- # merchants/answer/6324410). Schema.org property [Product.material](https://
2562
- # schema.org/material).
2648
+ # Corresponding properties: Google Merchant Center property [material](https://
2649
+ # support.google.com/merchants/answer/6324410). Schema.org property [Product.
2650
+ # material](https://schema.org/material).
2563
2651
  # Corresponds to the JSON property `materials`
2564
2652
  # @return [Array<String>]
2565
2653
  attr_accessor :materials
@@ -2573,9 +2661,10 @@ module Google
2573
2661
  # The pattern or graphic print of the product. For example, "striped", "polka
2574
2662
  # dot", "paisley". A maximum of 20 values are allowed per Product. Each value
2575
2663
  # must be a UTF-8 encoded string with a length limit of 128 characters.
2576
- # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
2577
- # property [pattern](https://support.google.com/merchants/answer/6324483).
2578
- # Schema.org property [Product.pattern](https://schema.org/pattern).
2664
+ # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
2665
+ # Google Merchant Center property [pattern](https://support.google.com/merchants/
2666
+ # answer/6324483). Schema.org property [Product.pattern](https://schema.org/
2667
+ # pattern).
2579
2668
  # Corresponds to the JSON property `patterns`
2580
2669
  # @return [Array<String>]
2581
2670
  attr_accessor :patterns
@@ -2590,10 +2679,9 @@ module Google
2590
2679
  # can only be empty or set to the same value as id. For VARIANT Products, this
2591
2680
  # field cannot be empty. A maximum of 2,000 products are allowed to share the
2592
2681
  # same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.
2593
- # Google Merchant Center Property [item_group_id](https://support.google.com/
2594
- # merchants/answer/6324507). Schema.org Property [Product.inProductGroupWithID](
2595
- # https://schema.org/inProductGroupWithID). This field must be enabled before it
2596
- # can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).
2682
+ # Corresponding properties: Google Merchant Center property [item_group_id](
2683
+ # https://support.google.com/merchants/answer/6324507). Schema.org property [
2684
+ # Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
2597
2685
  # Corresponds to the JSON property `primaryProductId`
2598
2686
  # @return [String]
2599
2687
  attr_accessor :primary_product_id
@@ -2642,10 +2730,11 @@ module Google
2642
2730
  # system and size type are empty, while size value is "32 inches". A maximum of
2643
2731
  # 20 values are allowed per Product. Each value must be a UTF-8 encoded string
2644
2732
  # with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
2645
- # returned. Google Merchant Center property [size](https://support.google.com/
2646
- # merchants/answer/6324492), [size_type](https://support.google.com/merchants/
2647
- # answer/6324497) and [size_system](https://support.google.com/merchants/answer/
2648
- # 6324502). Schema.org property [Product.size](https://schema.org/size).
2733
+ # returned. Corresponding properties: Google Merchant Center property [size](
2734
+ # https://support.google.com/merchants/answer/6324492), [size_type](https://
2735
+ # support.google.com/merchants/answer/6324497), and [size_system](https://
2736
+ # support.google.com/merchants/answer/6324502). Schema.org property [Product.
2737
+ # size](https://schema.org/size).
2649
2738
  # Corresponds to the JSON property `sizes`
2650
2739
  # @return [Array<String>]
2651
2740
  attr_accessor :sizes
@@ -2654,17 +2743,18 @@ module Google
2654
2743
  # Product. This value must be a UTF-8 encoded string with a length limit of 1,
2655
2744
  # 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
2656
2745
  # be used for filtering recommendation results by passing the tag as part of the
2657
- # PredictRequest.filter. Google Merchant Center property [custom_label_0–4](
2658
- # https://support.google.com/merchants/answer/6324473).
2746
+ # PredictRequest.filter. Corresponding properties: Google Merchant Center
2747
+ # property [custom_label_0–4](https://support.google.com/merchants/answer/
2748
+ # 6324473).
2659
2749
  # Corresponds to the JSON property `tags`
2660
2750
  # @return [Array<String>]
2661
2751
  attr_accessor :tags
2662
2752
 
2663
2753
  # Required. Product title. This field must be a UTF-8 encoded string with a
2664
2754
  # length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
2665
- # returned. Google Merchant Center property [title](https://support.google.com/
2666
- # merchants/answer/6324415). Schema.org property [Product.name](https://schema.
2667
- # org/name).
2755
+ # returned. Corresponding properties: Google Merchant Center property [title](
2756
+ # https://support.google.com/merchants/answer/6324415). Schema.org property [
2757
+ # Product.name](https://schema.org/name).
2668
2758
  # Corresponds to the JSON property `title`
2669
2759
  # @return [String]
2670
2760
  attr_accessor :title
@@ -2690,9 +2780,9 @@ module Google
2690
2780
  # recommended to provide a valid uri for the product, otherwise the service
2691
2781
  # performance could be significantly degraded. This field must be a UTF-8
2692
2782
  # encoded string with a length limit of 5,000 characters. Otherwise, an
2693
- # INVALID_ARGUMENT error is returned. Google Merchant Center property [link](
2694
- # https://support.google.com/merchants/answer/6324416). Schema.org property [
2695
- # Offer.url](https://schema.org/url).
2783
+ # INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
2784
+ # Center property [link](https://support.google.com/merchants/answer/6324416).
2785
+ # Schema.org property [Offer.url](https://schema.org/url).
2696
2786
  # Corresponds to the JSON property `uri`
2697
2787
  # @return [String]
2698
2788
  attr_accessor :uri
@@ -2834,15 +2924,15 @@ module Google
2834
2924
  include Google::Apis::Core::Hashable
2835
2925
 
2836
2926
  # The type of Products allowed to be ingested into the catalog. Acceptable
2837
- # values are: * `primary` (default): You can only ingest Product.Type.PRIMARY
2838
- # Products. This means Product.primary_product_id can only be empty or set to
2839
- # the same value as Product.id. * `variant`: You can only ingest Product.Type.
2840
- # VARIANT Products. This means Product.primary_product_id cannot be empty. If
2841
- # this field is set to an invalid value other than these, an INVALID_ARGUMENT
2842
- # error is returned. If this field is `variant` and
2843
- # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
2844
- # is returned. See [Using product levels](https://cloud.google.com/retail/
2845
- # recommendations-ai/docs/catalog#product-levels) for more details.
2927
+ # values are: * `primary` (default): You can ingest Products of all types. When
2928
+ # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
2929
+ # `variant`: You can only ingest Product.Type.VARIANT Products. This means
2930
+ # Product.primary_product_id cannot be empty. If this field is set to an invalid
2931
+ # value other than these, an INVALID_ARGUMENT error is returned. If this field
2932
+ # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
2933
+ # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
2934
+ # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
2935
+ # details.
2846
2936
  # Corresponds to the JSON property `ingestionProductType`
2847
2937
  # @return [String]
2848
2938
  attr_accessor :ingestion_product_type
@@ -2877,8 +2967,8 @@ module Google
2877
2967
  include Google::Apis::Core::Hashable
2878
2968
 
2879
2969
  # ID of the promotion. For example, "free gift". The value value must be a UTF-8
2880
- # encoded string with a length limit of 128 characters, and match the pattern: a-
2881
- # zA-Z*. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2970
+ # encoded string with a length limit of 128 characters, and match the pattern: `
2971
+ # a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2882
2972
  # INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
2883
2973
  # (https://support.google.com/merchants/answer/7050148).
2884
2974
  # Corresponds to the JSON property `promotionId`
@@ -3139,7 +3229,7 @@ module Google
3139
3229
  # or the region IDs for "same-day-delivery", to be removed for this type. At
3140
3230
  # least 1 value is required, and a maximum of 2000 values are allowed. Each
3141
3231
  # value must be a string with a length limit of 10 characters, matching the
3142
- # pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
3232
+ # pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
3143
3233
  # INVALID_ARGUMENT error is returned.
3144
3234
  # Corresponds to the JSON property `placeIds`
3145
3235
  # @return [Array<String>]
@@ -3302,24 +3392,26 @@ module Google
3302
3392
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo]
3303
3393
  attr_accessor :user_info
3304
3394
 
3305
- # The keys to fetch and rollup the matching variant Products attributes. The
3306
- # attributes from all the matching variant Products are merged and de-duplicated.
3307
- # Notice that rollup variant Products attributes will lead to extra query
3308
- # latency. Maximum number of keys is 10. For FulfillmentInfo, a fulfillment type
3309
- # and a fulfillment ID must be provided in the format of "fulfillmentType.
3310
- # fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
3311
- # fulfillment type and "store123" is the store ID. Supported keys are: *
3312
- # colorFamilies * price * originalPrice * discount * inventory(place_id,price) *
3313
- # attributes.key, where key is any key in the Product.attributes map. *
3314
- # pickupInStore.id, where id is any FulfillmentInfo.place_ids for
3315
- # FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any
3316
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". *
3317
- # sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for
3318
- # FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
3319
- # any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". *
3320
- # customFulfillment1.id, where id is any FulfillmentInfo.place_ids for
3321
- # FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any
3322
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
3395
+ # The keys to fetch and rollup the matching variant Products attributes,
3396
+ # FulfillmentInfo or LocalInventorys attributes. The attributes from all the
3397
+ # matching variant Products or LocalInventorys are merged and de-duplicated.
3398
+ # Notice that rollup attributes will lead to extra query latency. Maximum number
3399
+ # of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID
3400
+ # must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "
3401
+ # pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is
3402
+ # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
3403
+ # discount * variantId * inventory(place_id,price) * inventory(place_id,
3404
+ # original_price) * inventory(place_id,attributes.key), where key is any key in
3405
+ # the Product.inventories.attributes map. * attributes.key, where key is any key
3406
+ # in the Product.attributes map. * pickupInStore.id, where id is any
3407
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
3408
+ # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
3409
+ # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
3410
+ # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
3411
+ # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
3412
+ # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
3413
+ # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
3414
+ # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
3323
3415
  # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
3324
3416
  # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
3325
3417
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
@@ -3537,9 +3629,10 @@ module Google
3537
3629
  # colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
3538
3630
  # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
3539
3631
  # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
3540
- # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
3541
- # discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,
3542
- # price)"
3632
+ # customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
3633
+ # key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
3634
+ # attributes.key" * "inventory(place_id,price)" * "inventory(place_id,
3635
+ # original_price)" * "inventory(place_id,attributes.key)"
3543
3636
  # Corresponds to the JSON property `key`
3544
3637
  # @return [String]
3545
3638
  attr_accessor :key
@@ -3638,6 +3731,12 @@ module Google
3638
3731
  class GoogleCloudRetailV2betaSearchResponse
3639
3732
  include Google::Apis::Core::Hashable
3640
3733
 
3734
+ # The fully qualified resource name of applied [controls](https://cloud.google.
3735
+ # com/retail/docs/serving-control-rules).
3736
+ # Corresponds to the JSON property `appliedControls`
3737
+ # @return [Array<String>]
3738
+ attr_accessor :applied_controls
3739
+
3641
3740
  # A unique search token. This should be included in the UserEvent logs resulting
3642
3741
  # from this search, which enables accurate attribution of search model
3643
3742
  # performance.
@@ -3692,6 +3791,7 @@ module Google
3692
3791
 
3693
3792
  # Update properties of this object
3694
3793
  def update!(**args)
3794
+ @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
3695
3795
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
3696
3796
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
3697
3797
  @facets = args[:facets] if args.key?(:facets)
@@ -3964,12 +4064,15 @@ module Google
3964
4064
  class GoogleCloudRetailV2betaUserEvent
3965
4065
  include Google::Apis::Core::Hashable
3966
4066
 
3967
- # Extra user event features to include in the recommendation model. The key must
3968
- # be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise,
3969
- # an INVALID_ARGUMENT error is returned. For product recommendation, an example
3970
- # of extra user information is traffic_channel, i.e. how user arrives at the
3971
- # site. Users can arrive at the site by coming to the site directly, or coming
3972
- # through Google search, and etc.
4067
+ # Extra user event features to include in the recommendation model. This field
4068
+ # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
4069
+ # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
4070
+ # 000 characters. * For text attributes, at most 400 values are allowed. Empty
4071
+ # values are not allowed. Each value must be a UTF-8 encoded string with a
4072
+ # length limit of 256 characters. * For number attributes, at most 400 values
4073
+ # are allowed. For product recommendation, an example of extra user information
4074
+ # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
4075
+ # site by coming to the site directly, or coming through Google search, and etc.
3973
4076
  # Corresponds to the JSON property `attributes`
3974
4077
  # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
3975
4078
  attr_accessor :attributes
@@ -4011,12 +4114,11 @@ module Google
4011
4114
 
4012
4115
  # Required. User event type. Allowed values are: * `add-to-cart`: Products being
4013
4116
  # added to cart. * `category-page-view`: Special pages such as sale or promotion
4014
- # pages viewed. * `completion`: Completion query result showed/clicked. * `
4015
- # detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage
4016
- # viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-
4017
- # not-offered`: Promotion is not offered to a user. * `purchase-complete`: User
4018
- # finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`:
4019
- # User viewing a shopping cart.
4117
+ # pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-
4118
+ # view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user.
4119
+ # * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-
4120
+ # complete`: User finishing a purchase. * `search`: Product search. * `shopping-
4121
+ # cart-page-view`: User viewing a shopping cart.
4020
4122
  # Corresponds to the JSON property `eventType`
4021
4123
  # @return [String]
4022
4124
  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.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
@@ -172,6 +172,18 @@ module Google
172
172
  include Google::Apis::Core::JsonObjectSupport
173
173
  end
174
174
 
175
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
176
+ class Representation < Google::Apis::Core::JsonRepresentation; end
177
+
178
+ include Google::Apis::Core::JsonObjectSupport
179
+ end
180
+
181
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
182
+ class Representation < Google::Apis::Core::JsonRepresentation; end
183
+
184
+ include Google::Apis::Core::JsonObjectSupport
185
+ end
186
+
175
187
  class GoogleCloudRetailV2alphaExportErrorsConfig
176
188
  class Representation < Google::Apis::Core::JsonRepresentation; end
177
189
 
@@ -262,6 +274,18 @@ module Google
262
274
  include Google::Apis::Core::JsonObjectSupport
263
275
  end
264
276
 
277
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
278
+ class Representation < Google::Apis::Core::JsonRepresentation; end
279
+
280
+ include Google::Apis::Core::JsonObjectSupport
281
+ end
282
+
283
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
284
+ class Representation < Google::Apis::Core::JsonRepresentation; end
285
+
286
+ include Google::Apis::Core::JsonObjectSupport
287
+ end
288
+
265
289
  class GoogleCloudRetailV2alphaSetInventoryMetadata
266
290
  class Representation < Google::Apis::Core::JsonRepresentation; end
267
291
 
@@ -274,6 +298,18 @@ module Google
274
298
  include Google::Apis::Core::JsonObjectSupport
275
299
  end
276
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
+
277
313
  class GoogleCloudRetailV2alphaUserEventImportSummary
278
314
  class Representation < Google::Apis::Core::JsonRepresentation; end
279
315
 
@@ -960,6 +996,18 @@ module Google
960
996
  end
961
997
  end
962
998
 
999
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
1000
+ # @private
1001
+ class Representation < Google::Apis::Core::JsonRepresentation
1002
+ end
1003
+ end
1004
+
1005
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
1006
+ # @private
1007
+ class Representation < Google::Apis::Core::JsonRepresentation
1008
+ end
1009
+ end
1010
+
963
1011
  class GoogleCloudRetailV2alphaExportErrorsConfig
964
1012
  # @private
965
1013
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1082,6 +1130,18 @@ module Google
1082
1130
  end
1083
1131
  end
1084
1132
 
1133
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
1134
+ # @private
1135
+ class Representation < Google::Apis::Core::JsonRepresentation
1136
+ end
1137
+ end
1138
+
1139
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
1140
+ # @private
1141
+ class Representation < Google::Apis::Core::JsonRepresentation
1142
+ end
1143
+ end
1144
+
1085
1145
  class GoogleCloudRetailV2alphaSetInventoryMetadata
1086
1146
  # @private
1087
1147
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1094,6 +1154,18 @@ module Google
1094
1154
  end
1095
1155
  end
1096
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
+
1097
1169
  class GoogleCloudRetailV2alphaUserEventImportSummary
1098
1170
  # @private
1099
1171
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1715,6 +1787,7 @@ module Google
1715
1787
  class GoogleCloudRetailV2betaSearchResponse
1716
1788
  # @private
1717
1789
  class Representation < Google::Apis::Core::JsonRepresentation
1790
+ collection :applied_controls, as: 'appliedControls'
1718
1791
  property :attribution_token, as: 'attributionToken'
1719
1792
  property :corrected_query, as: 'correctedQuery'
1720
1793
  collection :facets, as: 'facets', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet::Representation
@@ -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_v2beta
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_v2beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.19.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.23.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: []