google-apis-retail_v2alpha 0.17.0 → 0.21.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: ebc5348a1550e8bab9415592500f3d695802bdf85145487e866beea54fbe1f88
4
- data.tar.gz: 772a44e0ef905d9179381a8c58f2d3bae90bd0e50662935b3b28fb48d25fe8f9
3
+ metadata.gz: bafb3e22626a98ee8ec463c20ac057ba504147866243d9579fa0b16d7b5f2653
4
+ data.tar.gz: 459112597f37a9e3dc2bf26ae5eb8340fc97f294ae9ccd6875828cec19e78566
5
5
  SHA512:
6
- metadata.gz: b94beb2a88ad73b349a5b5e0ed3ac139100382e1809feb2c7dd71028676eb51104fe9b16ebb7605354f2cc343bebcbdf0aba6a677203bf647c840bfd49efaa2c
7
- data.tar.gz: a3b7500ca53023d1125612220b2f3b1b27fc7917e77918a7bd98da3a24e2d455f8f2ea3a8433ef7e9f91582c9987825967c3921678c5a120647a176809565753
6
+ metadata.gz: 9e0f49b410dfc12f9b3529b4cfb5c02c095817f9374e3559541f4c96aa1fd5e4b405d57078c6a9f2c65fd3b43f336ab84d7505abf2263d66122322292a4339cd
7
+ data.tar.gz: b23c08c2cc4797efbe80488850d3b795d92038011cbc38393369de3600e8d34973727b590edf8acb3cc41f1501b213492c67f4b38bef9a0ab98076c548fa742d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.21.0 (2021-11-10)
4
+
5
+ * Regenerated from discovery document revision 20211104
6
+
7
+ ### v0.20.0 (2021-11-03)
8
+
9
+ * Regenerated from discovery document revision 20211028
10
+
11
+ ### v0.19.0 (2021-10-26)
12
+
13
+ * Regenerated from discovery document revision 20211021
14
+
15
+ ### v0.18.0 (2021-10-13)
16
+
17
+ * Regenerated from discovery document revision 20211011
18
+
3
19
  ### v0.17.0 (2021-10-05)
4
20
 
5
21
  * Regenerated from discovery document revision 20210930
data/OVERVIEW.md CHANGED
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Retail service in particular.)
67
67
 
@@ -294,8 +294,8 @@ module Google
294
294
  end
295
295
  end
296
296
 
297
- # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
298
- # is no meaningful response populated from the AddFulfillmentPlaces method.
297
+ # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
298
+ # no meaningful response populated from the AddFulfillmentPlaces method.
299
299
  class GoogleCloudRetailV2AddFulfillmentPlacesResponse
300
300
  include Google::Apis::Core::Hashable
301
301
 
@@ -657,7 +657,7 @@ module Google
657
657
  # or the region IDs for "same-day-delivery" to be added for this type. Duplicate
658
658
  # IDs will be automatically ignored. At least 1 value is required, and a maximum
659
659
  # of 2000 values are allowed. Each value must be a string with a length limit of
660
- # 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "
660
+ # 10 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "
661
661
  # REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total
662
662
  # number of place IDs exceeds 2000 for this type after adding, then the update
663
663
  # will be rejected.
@@ -689,8 +689,8 @@ module Google
689
689
  end
690
690
  end
691
691
 
692
- # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
693
- # is no meaningful response populated from the AddFulfillmentPlaces method.
692
+ # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
693
+ # no meaningful response populated from the AddFulfillmentPlaces method.
694
694
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse
695
695
  include Google::Apis::Core::Hashable
696
696
 
@@ -703,6 +703,86 @@ module Google
703
703
  end
704
704
  end
705
705
 
706
+ # Metadata related to the progress of the AddLocalInventories operation.
707
+ # Currently empty because there is no meaningful metadata populated from the
708
+ # AddLocalInventories method.
709
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
710
+ include Google::Apis::Core::Hashable
711
+
712
+ def initialize(**args)
713
+ update!(**args)
714
+ end
715
+
716
+ # Update properties of this object
717
+ def update!(**args)
718
+ end
719
+ end
720
+
721
+ # Request message for AddLocalInventories method.
722
+ class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
723
+ include Google::Apis::Core::Hashable
724
+
725
+ # Indicates which inventory fields in the provided list of LocalInventory to
726
+ # update. The field is updated to the provided value. If a field is set while
727
+ # the place does not have a previous local inventory, the local inventory at
728
+ # that store is created. If a field is set while the value of that field is not
729
+ # provided, the original field value, if it exists, is deleted. If the mask is
730
+ # not set or set with empty paths, all inventory fields will be updated. If an
731
+ # unsupported or unknown field is provided, an INVALID_ARGUMENT error is
732
+ # returned and the entire update will be ignored.
733
+ # Corresponds to the JSON property `addMask`
734
+ # @return [String]
735
+ attr_accessor :add_mask
736
+
737
+ # The time when the inventory updates are issued. Used to prevent out-of-order
738
+ # updates on local inventory fields. If not provided, the internal system time
739
+ # will be used.
740
+ # Corresponds to the JSON property `addTime`
741
+ # @return [String]
742
+ attr_accessor :add_time
743
+
744
+ # If set to true, and the Product is not found, the local inventory will still
745
+ # be processed and retained for at most 1 day and processed once the Product is
746
+ # created. If set to false, a NOT_FOUND error is returned if the Product is not
747
+ # found.
748
+ # Corresponds to the JSON property `allowMissing`
749
+ # @return [Boolean]
750
+ attr_accessor :allow_missing
751
+ alias_method :allow_missing?, :allow_missing
752
+
753
+ # Required. A list of inventory information at difference places. Each place is
754
+ # identified by its place ID. At most 1000 inventories are allowed per request.
755
+ # Corresponds to the JSON property `localInventories`
756
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
757
+ attr_accessor :local_inventories
758
+
759
+ def initialize(**args)
760
+ update!(**args)
761
+ end
762
+
763
+ # Update properties of this object
764
+ def update!(**args)
765
+ @add_mask = args[:add_mask] if args.key?(:add_mask)
766
+ @add_time = args[:add_time] if args.key?(:add_time)
767
+ @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
768
+ @local_inventories = args[:local_inventories] if args.key?(:local_inventories)
769
+ end
770
+ end
771
+
772
+ # Response of the AddLocalInventories API. Currently empty because there is no
773
+ # meaningful response populated from the AddLocalInventories method.
774
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
775
+ include Google::Apis::Core::Hashable
776
+
777
+ def initialize(**args)
778
+ update!(**args)
779
+ end
780
+
781
+ # Update properties of this object
782
+ def update!(**args)
783
+ end
784
+ end
785
+
706
786
  # An intended audience of the Product for whom it's sold.
707
787
  class GoogleCloudRetailV2alphaAudience
708
788
  include Google::Apis::Core::Hashable
@@ -1080,20 +1160,6 @@ module Google
1080
1160
  end
1081
1161
  end
1082
1162
 
1083
- # Metadata related to the EnrollSolution method. This will be returned by the
1084
- # google.longrunning.Operation.metadata field.
1085
- class GoogleCloudRetailV2alphaEnrollSolutionMetadata
1086
- include Google::Apis::Core::Hashable
1087
-
1088
- def initialize(**args)
1089
- update!(**args)
1090
- end
1091
-
1092
- # Update properties of this object
1093
- def update!(**args)
1094
- end
1095
- end
1096
-
1097
1163
  # Configuration of destination for Export related errors.
1098
1164
  class GoogleCloudRetailV2alphaExportErrorsConfig
1099
1165
  include Google::Apis::Core::Hashable
@@ -1204,7 +1270,7 @@ module Google
1204
1270
  # The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
1205
1271
  # in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
1206
1272
  # maximum of 3000 values are allowed. Each value must be a string with a length
1207
- # limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
1273
+ # limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1"
1208
1274
  # or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
1209
1275
  # Corresponds to the JSON property `placeIds`
1210
1276
  # @return [Array<String>]
@@ -1494,8 +1560,8 @@ module Google
1494
1560
 
1495
1561
  # Unique identifier provided by client, within the ancestor dataset scope.
1496
1562
  # Ensures idempotency and used for request deduplication. Server-generated if
1497
- # unspecified. Up to 128 characters long and must match the pattern: "[a-zA-Z0-
1498
- # 9_]+". This is returned as Operation.name in ImportMetadata. Only supported
1563
+ # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
1564
+ # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
1499
1565
  # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1500
1566
  # Corresponds to the JSON property `requestId`
1501
1567
  # @return [String]
@@ -1706,6 +1772,44 @@ module Google
1706
1772
  end
1707
1773
  end
1708
1774
 
1775
+ # The inventory information at a place (e.g. a store) identified by a place ID.
1776
+ class GoogleCloudRetailV2alphaLocalInventory
1777
+ include Google::Apis::Core::Hashable
1778
+
1779
+ # Additional local inventory attributes, for example, store name, promotion tags,
1780
+ # etc. * At most 5 values are allowed. Otherwise, an INVALID_ARGUMENT error is
1781
+ # returned. * The key must be a UTF-8 encoded string with a length limit of 10
1782
+ # characters. * The key must match the pattern: `a-zA-Z0-9*`. For example,
1783
+ # key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same
1784
+ # type (text or number). * The max number of values per attribute is 10. * For
1785
+ # text values, the length limit is 10 UTF-8 characters. * The attribute does not
1786
+ # support search. The `searchable` field should be unset or set to false.
1787
+ # Corresponds to the JSON property `attributes`
1788
+ # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
1789
+ attr_accessor :attributes
1790
+
1791
+ # The place ID for the current set of inventory information.
1792
+ # Corresponds to the JSON property `placeId`
1793
+ # @return [String]
1794
+ attr_accessor :place_id
1795
+
1796
+ # The price information of a Product.
1797
+ # Corresponds to the JSON property `priceInfo`
1798
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo]
1799
+ attr_accessor :price_info
1800
+
1801
+ def initialize(**args)
1802
+ update!(**args)
1803
+ end
1804
+
1805
+ # Update properties of this object
1806
+ def update!(**args)
1807
+ @attributes = args[:attributes] if args.key?(:attributes)
1808
+ @place_id = args[:place_id] if args.key?(:place_id)
1809
+ @price_info = args[:price_info] if args.key?(:price_info)
1810
+ end
1811
+ end
1812
+
1709
1813
  # Represents a link between a Merchant Center account and a branch. Once a link
1710
1814
  # is established, products from the linked merchant center account will be
1711
1815
  # streamed to the linked branch.
@@ -2056,7 +2160,7 @@ module Google
2056
2160
  # :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
2057
2161
  # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
2058
2162
  # be a UTF-8 encoded string with a length limit of 128 characters. * For
2059
- # indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example,
2163
+ # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
2060
2164
  # key0LikeThis or KEY_1_LIKE_THIS.
2061
2165
  # Corresponds to the JSON property `attributes`
2062
2166
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
@@ -2321,12 +2425,13 @@ module Google
2321
2425
  # @return [String]
2322
2426
  attr_accessor :title
2323
2427
 
2324
- # Input only. The TTL (time to live) of the product. If it is set, expire_time
2325
- # is set as current timestamp plus ttl. The derived expire_time is returned in
2326
- # the output and ttl is left blank when retrieving the Product. If it is set,
2327
- # the product is not available for SearchService.Search after current timestamp
2328
- # plus ttl. However, the product can still be retrieved by ProductService.
2329
- # GetProduct and ProductService.ListProducts.
2428
+ # Input only. The TTL (time to live) of the product. If it is set, it must be a
2429
+ # non-negative value, and expire_time is set as current timestamp plus ttl. The
2430
+ # derived expire_time is returned in the output and ttl is left blank when
2431
+ # retrieving the Product. If it is set, the product is not available for
2432
+ # SearchService.Search after current timestamp plus ttl. However, the product
2433
+ # can still be retrieved by ProductService.GetProduct and ProductService.
2434
+ # ListProducts.
2330
2435
  # Corresponds to the JSON property `ttl`
2331
2436
  # @return [String]
2332
2437
  attr_accessor :ttl
@@ -2485,15 +2590,15 @@ module Google
2485
2590
  include Google::Apis::Core::Hashable
2486
2591
 
2487
2592
  # The type of Products allowed to be ingested into the catalog. Acceptable
2488
- # values are: * `primary` (default): You can only ingest Product.Type.PRIMARY
2489
- # Products. This means Product.primary_product_id can only be empty or set to
2490
- # the same value as Product.id. * `variant`: You can only ingest Product.Type.
2491
- # VARIANT Products. This means Product.primary_product_id cannot be empty. If
2492
- # this field is set to an invalid value other than these, an INVALID_ARGUMENT
2493
- # error is returned. If this field is `variant` and
2494
- # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
2495
- # is returned. See [Using product levels](https://cloud.google.com/retail/
2496
- # recommendations-ai/docs/catalog#product-levels) for more details.
2593
+ # values are: * `primary` (default): You can ingest Products of all types. When
2594
+ # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
2595
+ # `variant`: You can only ingest Product.Type.VARIANT Products. This means
2596
+ # Product.primary_product_id cannot be empty. If this field is set to an invalid
2597
+ # value other than these, an INVALID_ARGUMENT error is returned. If this field
2598
+ # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
2599
+ # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
2600
+ # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
2601
+ # details.
2497
2602
  # Corresponds to the JSON property `ingestionProductType`
2498
2603
  # @return [String]
2499
2604
  attr_accessor :ingestion_product_type
@@ -2528,8 +2633,8 @@ module Google
2528
2633
  include Google::Apis::Core::Hashable
2529
2634
 
2530
2635
  # ID of the promotion. For example, "free gift". The value value must be a UTF-8
2531
- # encoded string with a length limit of 128 characters, and match the pattern: a-
2532
- # zA-Z*. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2636
+ # encoded string with a length limit of 128 characters, and match the pattern: `
2637
+ # a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2533
2638
  # INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
2534
2639
  # (https://support.google.com/merchants/answer/7050148).
2535
2640
  # Corresponds to the JSON property `promotionId`
@@ -2790,7 +2895,7 @@ module Google
2790
2895
  # or the region IDs for "same-day-delivery", to be removed for this type. At
2791
2896
  # least 1 value is required, and a maximum of 2000 values are allowed. Each
2792
2897
  # value must be a string with a length limit of 10 characters, matching the
2793
- # pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
2898
+ # pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
2794
2899
  # INVALID_ARGUMENT error is returned.
2795
2900
  # Corresponds to the JSON property `placeIds`
2796
2901
  # @return [Array<String>]
@@ -2841,6 +2946,73 @@ module Google
2841
2946
  end
2842
2947
  end
2843
2948
 
2949
+ # Metadata related to the progress of the RemoveLocalInventories operation.
2950
+ # Currently empty because there is no meaningful metadata populated from the
2951
+ # RemoveLocalInventories method.
2952
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
2953
+ include Google::Apis::Core::Hashable
2954
+
2955
+ def initialize(**args)
2956
+ update!(**args)
2957
+ end
2958
+
2959
+ # Update properties of this object
2960
+ def update!(**args)
2961
+ end
2962
+ end
2963
+
2964
+ # Request message for RemoveLocalInventories method.
2965
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
2966
+ include Google::Apis::Core::Hashable
2967
+
2968
+ # If set to true, and the Product is not found, the local inventory removal
2969
+ # request will still be processed and retained for at most 1 day and processed
2970
+ # once the Product is created. If set to false, a NOT_FOUND error is returned if
2971
+ # the Product is not found.
2972
+ # Corresponds to the JSON property `allowMissing`
2973
+ # @return [Boolean]
2974
+ attr_accessor :allow_missing
2975
+ alias_method :allow_missing?, :allow_missing
2976
+
2977
+ # Required. A list of place IDs to have their inventory deleted. At most 1000
2978
+ # place IDs are allowed per request.
2979
+ # Corresponds to the JSON property `placeIds`
2980
+ # @return [Array<String>]
2981
+ attr_accessor :place_ids
2982
+
2983
+ # The time when the inventory deletions are issued. Used to prevent out-of-order
2984
+ # updates and deletions on local inventory fields. If not provided, the internal
2985
+ # system time will be used.
2986
+ # Corresponds to the JSON property `removeTime`
2987
+ # @return [String]
2988
+ attr_accessor :remove_time
2989
+
2990
+ def initialize(**args)
2991
+ update!(**args)
2992
+ end
2993
+
2994
+ # Update properties of this object
2995
+ def update!(**args)
2996
+ @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
2997
+ @place_ids = args[:place_ids] if args.key?(:place_ids)
2998
+ @remove_time = args[:remove_time] if args.key?(:remove_time)
2999
+ end
3000
+ end
3001
+
3002
+ # Response of the RemoveLocalInventories API. Currently empty because there is
3003
+ # no meaningful response populated from the RemoveLocalInventories method.
3004
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
3005
+ include Google::Apis::Core::Hashable
3006
+
3007
+ def initialize(**args)
3008
+ update!(**args)
3009
+ end
3010
+
3011
+ # Update properties of this object
3012
+ def update!(**args)
3013
+ end
3014
+ end
3015
+
2844
3016
  # Request message for SearchService.Search method.
2845
3017
  class GoogleCloudRetailV2alphaSearchRequest
2846
3018
  include Google::Apis::Core::Hashable
@@ -2950,6 +3122,12 @@ module Google
2950
3122
  # @return [String]
2951
3123
  attr_accessor :relevance_threshold
2952
3124
 
3125
+ # The search mode of the search request. If not specified, a single search
3126
+ # request triggers both product search and faceted search.
3127
+ # Corresponds to the JSON property `searchMode`
3128
+ # @return [String]
3129
+ attr_accessor :search_mode
3130
+
2953
3131
  # Information of an end user.
2954
3132
  # Corresponds to the JSON property `userInfo`
2955
3133
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
@@ -2962,16 +3140,17 @@ module Google
2962
3140
  # and a fulfillment ID must be provided in the format of "fulfillmentType.
2963
3141
  # fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
2964
3142
  # fulfillment type and "store123" is the store ID. Supported keys are: *
2965
- # colorFamilies * price * originalPrice * discount * attributes.key, where key
2966
- # is any key in the Product.attributes map. * pickupInStore.id, where id is any
2967
- # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
2968
- # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
2969
- # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
2970
- # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
2971
- # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
2972
- # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
2973
- # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
2974
- # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
3143
+ # colorFamilies * price * originalPrice * discount * inventory(place_id,price) *
3144
+ # attributes.key, where key is any key in the Product.attributes map. *
3145
+ # pickupInStore.id, where id is any FulfillmentInfo.place_ids for
3146
+ # FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any
3147
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". *
3148
+ # sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for
3149
+ # FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
3150
+ # any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". *
3151
+ # customFulfillment1.id, where id is any FulfillmentInfo.place_ids for
3152
+ # FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is any
3153
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
2975
3154
  # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
2976
3155
  # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
2977
3156
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
@@ -3012,6 +3191,7 @@ module Google
3012
3191
  @query = args[:query] if args.key?(:query)
3013
3192
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
3014
3193
  @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
3194
+ @search_mode = args[:search_mode] if args.key?(:search_mode)
3015
3195
  @user_info = args[:user_info] if args.key?(:user_info)
3016
3196
  @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
3017
3197
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -3190,7 +3370,8 @@ module Google
3190
3370
  # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
3191
3371
  # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
3192
3372
  # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
3193
- # discount" * "rating" * "ratingCount" * "attributes.key"
3373
+ # discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,
3374
+ # price)"
3194
3375
  # Corresponds to the JSON property `key`
3195
3376
  # @return [String]
3196
3377
  attr_accessor :key
@@ -3975,8 +4156,8 @@ module Google
3975
4156
  end
3976
4157
  end
3977
4158
 
3978
- # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
3979
- # is no meaningful response populated from the AddFulfillmentPlaces method.
4159
+ # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
4160
+ # no meaningful response populated from the AddFulfillmentPlaces method.
3980
4161
  class GoogleCloudRetailV2betaAddFulfillmentPlacesResponse
3981
4162
  include Google::Apis::Core::Hashable
3982
4163
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.17.0"
19
+ GEM_VERSION = "0.21.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 = "20210930"
25
+ REVISION = "20211104"
26
26
  end
27
27
  end
28
28
  end
@@ -178,6 +178,24 @@ module Google
178
178
  include Google::Apis::Core::JsonObjectSupport
179
179
  end
180
180
 
181
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
182
+ class Representation < Google::Apis::Core::JsonRepresentation; end
183
+
184
+ include Google::Apis::Core::JsonObjectSupport
185
+ end
186
+
187
+ class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
188
+ class Representation < Google::Apis::Core::JsonRepresentation; end
189
+
190
+ include Google::Apis::Core::JsonObjectSupport
191
+ end
192
+
193
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
181
199
  class GoogleCloudRetailV2alphaAudience
182
200
  class Representation < Google::Apis::Core::JsonRepresentation; end
183
201
 
@@ -238,12 +256,6 @@ module Google
238
256
  include Google::Apis::Core::JsonObjectSupport
239
257
  end
240
258
 
241
- class GoogleCloudRetailV2alphaEnrollSolutionMetadata
242
- class Representation < Google::Apis::Core::JsonRepresentation; end
243
-
244
- include Google::Apis::Core::JsonObjectSupport
245
- end
246
-
247
259
  class GoogleCloudRetailV2alphaExportErrorsConfig
248
260
  class Representation < Google::Apis::Core::JsonRepresentation; end
249
261
 
@@ -358,6 +370,12 @@ module Google
358
370
  include Google::Apis::Core::JsonObjectSupport
359
371
  end
360
372
 
373
+ class GoogleCloudRetailV2alphaLocalInventory
374
+ class Representation < Google::Apis::Core::JsonRepresentation; end
375
+
376
+ include Google::Apis::Core::JsonObjectSupport
377
+ end
378
+
361
379
  class GoogleCloudRetailV2alphaMerchantCenterLink
362
380
  class Representation < Google::Apis::Core::JsonRepresentation; end
363
381
 
@@ -502,6 +520,24 @@ module Google
502
520
  include Google::Apis::Core::JsonObjectSupport
503
521
  end
504
522
 
523
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
524
+ class Representation < Google::Apis::Core::JsonRepresentation; end
525
+
526
+ include Google::Apis::Core::JsonObjectSupport
527
+ end
528
+
529
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
530
+ class Representation < Google::Apis::Core::JsonRepresentation; end
531
+
532
+ include Google::Apis::Core::JsonObjectSupport
533
+ end
534
+
535
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
536
+ class Representation < Google::Apis::Core::JsonRepresentation; end
537
+
538
+ include Google::Apis::Core::JsonObjectSupport
539
+ end
540
+
505
541
  class GoogleCloudRetailV2alphaSearchRequest
506
542
  class Representation < Google::Apis::Core::JsonRepresentation; end
507
543
 
@@ -988,6 +1024,29 @@ module Google
988
1024
  end
989
1025
  end
990
1026
 
1027
+ class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
1028
+ # @private
1029
+ class Representation < Google::Apis::Core::JsonRepresentation
1030
+ end
1031
+ end
1032
+
1033
+ class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
1034
+ # @private
1035
+ class Representation < Google::Apis::Core::JsonRepresentation
1036
+ property :add_mask, as: 'addMask'
1037
+ property :add_time, as: 'addTime'
1038
+ property :allow_missing, as: 'allowMissing'
1039
+ collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory::Representation
1040
+
1041
+ end
1042
+ end
1043
+
1044
+ class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
1045
+ # @private
1046
+ class Representation < Google::Apis::Core::JsonRepresentation
1047
+ end
1048
+ end
1049
+
991
1050
  class GoogleCloudRetailV2alphaAudience
992
1051
  # @private
993
1052
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1083,12 +1142,6 @@ module Google
1083
1142
  end
1084
1143
  end
1085
1144
 
1086
- class GoogleCloudRetailV2alphaEnrollSolutionMetadata
1087
- # @private
1088
- class Representation < Google::Apis::Core::JsonRepresentation
1089
- end
1090
- end
1091
-
1092
1145
  class GoogleCloudRetailV2alphaExportErrorsConfig
1093
1146
  # @private
1094
1147
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1269,6 +1322,17 @@ module Google
1269
1322
  end
1270
1323
  end
1271
1324
 
1325
+ class GoogleCloudRetailV2alphaLocalInventory
1326
+ # @private
1327
+ class Representation < Google::Apis::Core::JsonRepresentation
1328
+ hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
1329
+
1330
+ property :place_id, as: 'placeId'
1331
+ property :price_info, as: 'priceInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo::Representation
1332
+
1333
+ end
1334
+ end
1335
+
1272
1336
  class GoogleCloudRetailV2alphaMerchantCenterLink
1273
1337
  # @private
1274
1338
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1518,6 +1582,27 @@ module Google
1518
1582
  end
1519
1583
  end
1520
1584
 
1585
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
1586
+ # @private
1587
+ class Representation < Google::Apis::Core::JsonRepresentation
1588
+ end
1589
+ end
1590
+
1591
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
1592
+ # @private
1593
+ class Representation < Google::Apis::Core::JsonRepresentation
1594
+ property :allow_missing, as: 'allowMissing'
1595
+ collection :place_ids, as: 'placeIds'
1596
+ property :remove_time, as: 'removeTime'
1597
+ end
1598
+ end
1599
+
1600
+ class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
1601
+ # @private
1602
+ class Representation < Google::Apis::Core::JsonRepresentation
1603
+ end
1604
+ end
1605
+
1521
1606
  class GoogleCloudRetailV2alphaSearchRequest
1522
1607
  # @private
1523
1608
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1539,6 +1624,7 @@ module Google
1539
1624
  property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec::Representation
1540
1625
 
1541
1626
  property :relevance_threshold, as: 'relevanceThreshold'
1627
+ property :search_mode, as: 'searchMode'
1542
1628
  property :user_info, as: 'userInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo::Representation
1543
1629
 
1544
1630
  collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -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]
@@ -367,6 +367,52 @@ module Google
367
367
  execute_or_queue_command(command, &block)
368
368
  end
369
369
 
370
+ # Updates local inventory information for a Product at a list of places, while
371
+ # respecting the last update timestamps of each inventory field. This process is
372
+ # asynchronous and does not require the Product to exist before updating
373
+ # inventory information. If the request is valid, the update will be enqueued
374
+ # and processed downstream. As a consequence, when a response is returned,
375
+ # updates are not immediately manifested in the Product queried by GetProduct or
376
+ # ListProducts. Store inventory information can only be modified using this
377
+ # method. CreateProduct and UpdateProduct has no effect on local inventories.
378
+ # This feature is only available for users who have Retail Search enabled.
379
+ # Please submit a form [here](https://cloud.google.com/contact) to contact Cloud
380
+ # sales if you are interested in using Retail Search.
381
+ # @param [String] product
382
+ # Required. Full resource name of Product, such as `projects/*/locations/global/
383
+ # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
384
+ # the caller does not have permission to access the Product, regardless of
385
+ # whether or not it exists, a PERMISSION_DENIED error is returned.
386
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest] google_cloud_retail_v2alpha_add_local_inventories_request_object
387
+ # @param [String] fields
388
+ # Selector specifying which fields to include in a partial response.
389
+ # @param [String] quota_user
390
+ # Available to use for quota purposes for server-side applications. Can be any
391
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
392
+ # @param [Google::Apis::RequestOptions] options
393
+ # Request-specific options
394
+ #
395
+ # @yield [result, err] Result & error if block supplied
396
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
397
+ # @yieldparam err [StandardError] error object if request failed
398
+ #
399
+ # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
400
+ #
401
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
402
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
403
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
404
+ def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
405
+ command = make_simple_command(:post, 'v2alpha/{+product}:addLocalInventories', options)
406
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest::Representation
407
+ command.request_object = google_cloud_retail_v2alpha_add_local_inventories_request_object
408
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
409
+ command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
410
+ command.params['product'] = product unless product.nil?
411
+ command.query['fields'] = fields unless fields.nil?
412
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
413
+ execute_or_queue_command(command, &block)
414
+ end
415
+
370
416
  # Creates a Product.
371
417
  # @param [String] parent
372
418
  # Required. The parent catalog resource name, such as `projects/*/locations/
@@ -679,6 +725,50 @@ module Google
679
725
  execute_or_queue_command(command, &block)
680
726
  end
681
727
 
728
+ # Remove local inventory information for a Product at a list of places at a
729
+ # removal timestamp. This process is asynchronous. If the request is valid, the
730
+ # removal will be enqueued and processed downstream. As a consequence, when a
731
+ # response is returned, removals are not immediately manifested in the Product
732
+ # queried by GetProduct or ListProducts. Store inventory information can only be
733
+ # removed using this method. CreateProduct and UpdateProduct has no effect on
734
+ # local inventories. This feature is only available for users who have Retail
735
+ # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
736
+ # to contact Cloud sales if you are interested in using Retail Search.
737
+ # @param [String] product
738
+ # Required. Full resource name of Product, such as `projects/*/locations/global/
739
+ # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
740
+ # the caller does not have permission to access the Product, regardless of
741
+ # whether or not it exists, a PERMISSION_DENIED error is returned.
742
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest] google_cloud_retail_v2alpha_remove_local_inventories_request_object
743
+ # @param [String] fields
744
+ # Selector specifying which fields to include in a partial response.
745
+ # @param [String] quota_user
746
+ # Available to use for quota purposes for server-side applications. Can be any
747
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
748
+ # @param [Google::Apis::RequestOptions] options
749
+ # Request-specific options
750
+ #
751
+ # @yield [result, err] Result & error if block supplied
752
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
753
+ # @yieldparam err [StandardError] error object if request failed
754
+ #
755
+ # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
756
+ #
757
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
758
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
759
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
760
+ def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
761
+ command = make_simple_command(:post, 'v2alpha/{+product}:removeLocalInventories', options)
762
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest::Representation
763
+ command.request_object = google_cloud_retail_v2alpha_remove_local_inventories_request_object
764
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
765
+ command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
766
+ command.params['product'] = product unless product.nil?
767
+ command.query['fields'] = fields unless fields.nil?
768
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
769
+ execute_or_queue_command(command, &block)
770
+ end
771
+
682
772
  # Updates inventory information for a Product while respecting the last update
683
773
  # timestamps of each inventory field. This process is asynchronous and does not
684
774
  # require the Product to exist before updating fulfillment information. If the
@@ -891,9 +981,8 @@ module Google
891
981
  # @param [String] placement
892
982
  # Required. The resource name of the search engine placement, such as `projects/*
893
983
  # /locations/global/catalogs/default_catalog/placements/default_search`. This
894
- # field is used to identify the set of models that will be used to make the
895
- # search. We currently support one placement with the following ID: * `
896
- # default_search`.
984
+ # field is used to identify the serving configuration name and the set of models
985
+ # that will be used to make the search.
897
986
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
898
987
  # @param [String] fields
899
988
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.17.0
4
+ version: 0.21.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-11 00:00:00.000000000 Z
11
+ date: 2021-11-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-retail_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.17.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-retail_v2alpha
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.21.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths: