google-apis-retail_v2alpha 0.30.0 → 0.33.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: e063d9dbc9d57e5e5167021c4f4699971eb55a1483a25bc31bd55de7074b5ddc
4
- data.tar.gz: 842cbfd5e27502afd8c0e56772aeffb7274fa30f3d47f36dc82e44bde7b6d0af
3
+ metadata.gz: 28c4b9d5bc9ab2434afee8a37fc05065f33e4c1f877cdbc49c66842ce818531d
4
+ data.tar.gz: 586c391c1b0770ee1add05161217fa51b71fe15949f03c489c0d15a1cd861ffd
5
5
  SHA512:
6
- metadata.gz: f9336b3c25a5f36ea3c41dc3fee2cb87cf932a7512269552aa018b70c208836cfbc6f5e96f3779937ba6eddebfe085217de9069cf42ed0ffdae72ed949a61b1e
7
- data.tar.gz: 77cce5deb4146d7e14327153703190eb03b0f55709791263e0d97522352a79886a75ef6d989249c11e09af5adea5dd1a330f1357d176a0ff8e57b6a12f30b5b2
6
+ metadata.gz: 8c6f8ac592b5a64f5ddd5611412c337c6230aa21dd2e03613ff379f286a7dd7bae87131dad3a07fa0ffcf180381e99f46d34c3490587c921f2353044bfe5fa0a
7
+ data.tar.gz: 7a129795a38abcc73706846069990a9bae357a873e339f907ec2d75b82b53f156476b25092bf345a931d4501491f3a9d349087a3486c027910ef9661881614b3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.33.0 (2022-03-16)
4
+
5
+ * Regenerated from discovery document revision 20220310
6
+
7
+ ### v0.32.0 (2022-03-09)
8
+
9
+ * Regenerated from discovery document revision 20220303
10
+
11
+ ### v0.31.0 (2022-03-04)
12
+
13
+ * Regenerated from discovery document revision 20220224
14
+
3
15
  ### v0.30.0 (2022-02-24)
4
16
 
5
17
  * Regenerated from discovery document revision 20220217
@@ -932,11 +932,11 @@ module Google
932
932
  # Represents a whole or partial calendar date, such as a birthday. The time of
933
933
  # day and time zone are either specified elsewhere or are insignificant. The
934
934
  # date is relative to the Gregorian Calendar. This can represent one of the
935
- # following: * A full date, with non-zero year, month, and day values * A month
936
- # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
937
- # zero month and a zero day * A year and month, with a zero day (e.g., a credit
938
- # card expiration date) Related types: * google.type.TimeOfDay * google.type.
939
- # DateTime * google.protobuf.Timestamp
935
+ # following: * A full date, with non-zero year, month, and day values. * A month
936
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
937
+ # with a zero month and a zero day. * A year and month, with a zero day (for
938
+ # example, a credit card expiration date). Related types: * google.type.
939
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
940
940
  # Corresponds to the JSON property `partitionDate`
941
941
  # @return [Google::Apis::RetailV2alpha::GoogleTypeDate]
942
942
  attr_accessor :partition_date
@@ -1026,8 +1026,11 @@ module Google
1026
1026
  # True` if at least one Product is using this attribute in Product.attributes.
1027
1027
  # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
1028
1028
  # AddCatalogAttribute, ImportCatalogAttributes, or UpdateAttributesConfig APIs.
1029
- # This field is `False` for pre-loaded CatalogAttributes. After catalog changes,
1030
- # it takes about 10 minutes for this field to update.
1029
+ # This field is `False` for pre-loaded CatalogAttributes. Only CatalogAttributes
1030
+ # that are not in use by products can be deleted. CatalogAttributes that are in
1031
+ # use by products cannot be deleted; however, their configuration properties
1032
+ # will reset to default values upon removal request. After catalog changes, it
1033
+ # takes about 10 minutes for this field to update.
1031
1034
  # Corresponds to the JSON property `inUse`
1032
1035
  # @return [Boolean]
1033
1036
  attr_accessor :in_use
@@ -1379,9 +1382,18 @@ module Google
1379
1382
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule]
1380
1383
  attr_accessor :rule
1381
1384
 
1385
+ # Required. Specifies the use case for the control. Affects what condition
1386
+ # fields can be set. Only settable by search controls. Will default to
1387
+ # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
1388
+ # search_solution_use_case per control.
1389
+ # Corresponds to the JSON property `searchSolutionUseCase`
1390
+ # @return [Array<String>]
1391
+ attr_accessor :search_solution_use_case
1392
+
1382
1393
  # Required. Immutable. The solution types that the serving config is used for.
1383
1394
  # Currently we support setting only one type of solution at creation time. Only `
1384
- # SOLUTION_TYPE_SEARCH` value is supported at the moment.
1395
+ # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
1396
+ # provided at creation time, will default to SOLUTION_TYPE_SEARCH.
1385
1397
  # Corresponds to the JSON property `solutionTypes`
1386
1398
  # @return [Array<String>]
1387
1399
  attr_accessor :solution_types
@@ -1397,6 +1409,7 @@ module Google
1397
1409
  @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
1398
1410
  @name = args[:name] if args.key?(:name)
1399
1411
  @rule = args[:rule] if args.key?(:rule)
1412
+ @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
1400
1413
  @solution_types = args[:solution_types] if args.key?(:solution_types)
1401
1414
  end
1402
1415
  end
@@ -1664,7 +1677,10 @@ module Google
1664
1677
  end
1665
1678
  end
1666
1679
 
1667
- # Product thumbnail/detail image.
1680
+ # Product image. Recommendations AI and Retail Search do not use product images
1681
+ # to improve prediction and search results. However, product images can be
1682
+ # returned in results, and are shown in prediction or search previews in the
1683
+ # console.
1668
1684
  class GoogleCloudRetailV2alphaImage
1669
1685
  include Google::Apis::Core::Hashable
1670
1686
 
@@ -2129,10 +2145,10 @@ module Google
2129
2145
  # key must be a UTF-8 encoded string with a length limit of 32 characters. * The
2130
2146
  # key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or
2131
2147
  # KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or
2132
- # number). * The max number of values per attribute is 10. * For text values,
2133
- # the length limit is 256 UTF-8 characters. * The attribute does not support
2134
- # search. The `searchable` field should be unset or set to false. * The max
2135
- # summed total bytes of custom attribute keys and values per product is 5MiB.
2148
+ # number). * Only 1 value is allowed for each attribute. * For text values, the
2149
+ # length limit is 256 UTF-8 characters. * The attribute does not support search.
2150
+ # The `searchable` field should be unset or set to false. * The max summed total
2151
+ # bytes of custom attribute keys and values per product is 5MiB.
2136
2152
  # Corresponds to the JSON property `attributes`
2137
2153
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
2138
2154
  attr_accessor :attributes
@@ -2256,9 +2272,11 @@ module Google
2256
2272
  # do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
2257
2273
  # Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
2258
2274
  # "promotional") * filterOutOfStockItems If your filter blocks all prediction
2259
- # results, nothing will be returned. If you want generic (unfiltered) popular
2260
- # products to be returned instead, set `strictFiltering` to false in `
2261
- # PredictRequest.params`.
2275
+ # results, the API will return generic (unfiltered) popular products. If you
2276
+ # only want results strictly matching the filters, set `strictFiltering` to True
2277
+ # in `PredictRequest.params` to receive empty results instead. Note that the API
2278
+ # will never return items with storageStatus of "EXPIRED" or "DELETED"
2279
+ # regardless of filter choices.
2262
2280
  # Corresponds to the JSON property `filter`
2263
2281
  # @return [String]
2264
2282
  attr_accessor :filter
@@ -2665,7 +2683,7 @@ module Google
2665
2683
  # @return [String]
2666
2684
  attr_accessor :id
2667
2685
 
2668
- # Product images for the product.Highly recommended to put the main image to the
2686
+ # Product images for the product. We highly recommend putting the main image
2669
2687
  # first. A maximum of 300 images are allowed. Corresponding properties: Google
2670
2688
  # Merchant Center property [image_link](https://support.google.com/merchants/
2671
2689
  # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
@@ -3089,6 +3107,115 @@ module Google
3089
3107
  end
3090
3108
  end
3091
3109
 
3110
+ # Metadata related to the progress of the PurgeProducts operation. This will be
3111
+ # returned by the google.longrunning.Operation.metadata field.
3112
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
3113
+ include Google::Apis::Core::Hashable
3114
+
3115
+ # Operation create time.
3116
+ # Corresponds to the JSON property `createTime`
3117
+ # @return [String]
3118
+ attr_accessor :create_time
3119
+
3120
+ # Count of entries that encountered errors while processing.
3121
+ # Corresponds to the JSON property `failureCount`
3122
+ # @return [Fixnum]
3123
+ attr_accessor :failure_count
3124
+
3125
+ # Count of entries that were deleted successfully.
3126
+ # Corresponds to the JSON property `successCount`
3127
+ # @return [Fixnum]
3128
+ attr_accessor :success_count
3129
+
3130
+ # Operation last update time. If the operation is done, this is also the finish
3131
+ # time.
3132
+ # Corresponds to the JSON property `updateTime`
3133
+ # @return [String]
3134
+ attr_accessor :update_time
3135
+
3136
+ def initialize(**args)
3137
+ update!(**args)
3138
+ end
3139
+
3140
+ # Update properties of this object
3141
+ def update!(**args)
3142
+ @create_time = args[:create_time] if args.key?(:create_time)
3143
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
3144
+ @success_count = args[:success_count] if args.key?(:success_count)
3145
+ @update_time = args[:update_time] if args.key?(:update_time)
3146
+ end
3147
+ end
3148
+
3149
+ # Request message for PurgeProducts method.
3150
+ class GoogleCloudRetailV2alphaPurgeProductsRequest
3151
+ include Google::Apis::Core::Hashable
3152
+
3153
+ # Required. The filter string to specify the products to be deleted with a
3154
+ # length limit of 5,000 characters. Empty string filter is not allowed. "*"
3155
+ # implies delete all items in a branch. The eligible fields for filtering are: *
3156
+ # `availability`: Double quoted Product.availability string. * `create_time` :
3157
+ # in ISO 8601 "zulu" format. Supported syntax: * Comparators (">", "<", ">=", "<=
3158
+ # ", "="). Examples: * create_time <= "2015-02-13T17:05:46Z" * availability = "
3159
+ # IN_STOCK” * Conjunctions ("AND") Examples: * create_time <= "2015-02-13T17:05:
3160
+ # 46Z" AND availability = "PREORDER" * Disjunctions ("OR") Examples: *
3161
+ # create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * Can
3162
+ # support nested queries. Examples: * (create_time <= "2015-02-13T17:05:46Z" AND
3163
+ # availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND
3164
+ # availability = "IN_STOCK") * Filter Limits: * Filter should not contain more
3165
+ # than 6 conditions. * Max nesting depth should not exceed 2 levels. Examples
3166
+ # queries: * Delete back order products created before a timestamp. create_time <
3167
+ # = "2015-02-13T17:05:46Z" OR availability = "BACKORDER”
3168
+ # Corresponds to the JSON property `filter`
3169
+ # @return [String]
3170
+ attr_accessor :filter
3171
+
3172
+ # Actually perform the purge. If `force` is set to false, the method will return
3173
+ # the expected purge count without deleting any products.
3174
+ # Corresponds to the JSON property `force`
3175
+ # @return [Boolean]
3176
+ attr_accessor :force
3177
+ alias_method :force?, :force
3178
+
3179
+ def initialize(**args)
3180
+ update!(**args)
3181
+ end
3182
+
3183
+ # Update properties of this object
3184
+ def update!(**args)
3185
+ @filter = args[:filter] if args.key?(:filter)
3186
+ @force = args[:force] if args.key?(:force)
3187
+ end
3188
+ end
3189
+
3190
+ # Response of the PurgeProductsRequest. If the long running operation is
3191
+ # successfully done, then this message is returned by the google.longrunning.
3192
+ # Operations.response field.
3193
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
3194
+ include Google::Apis::Core::Hashable
3195
+
3196
+ # The total count of products purged as a result of the operation.
3197
+ # Corresponds to the JSON property `purgeCount`
3198
+ # @return [Fixnum]
3199
+ attr_accessor :purge_count
3200
+
3201
+ # A sample of the product names that will be deleted. Only populated if `force`
3202
+ # is set to false. A max of 100 names will be returned and the names are chosen
3203
+ # at random.
3204
+ # Corresponds to the JSON property `purgeSample`
3205
+ # @return [Array<String>]
3206
+ attr_accessor :purge_sample
3207
+
3208
+ def initialize(**args)
3209
+ update!(**args)
3210
+ end
3211
+
3212
+ # Update properties of this object
3213
+ def update!(**args)
3214
+ @purge_count = args[:purge_count] if args.key?(:purge_count)
3215
+ @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
3216
+ end
3217
+ end
3218
+
3092
3219
  # Request message for PurgeUserEvents method.
3093
3220
  class GoogleCloudRetailV2alphaPurgeUserEventsRequest
3094
3221
  include Google::Apis::Core::Hashable
@@ -3800,12 +3927,13 @@ module Google
3800
3927
  # @return [String]
3801
3928
  attr_accessor :branch
3802
3929
 
3803
- # The filter applied to every search request when quality improvement such as
3804
- # query expansion is needed. For example, if a query does not have enough
3805
- # results, an expanded query with SearchRequest.canonical_filter will be
3806
- # returned as a supplement of the original query. This field is strongly
3807
- # recommended to achieve high search quality. See SearchRequest.filter for more
3808
- # details about filter syntax.
3930
+ # The default filter that is applied when a user performs a search without
3931
+ # checking any filters on the search page. The filter applied to every search
3932
+ # request when quality improvement such as query expansion is needed. For
3933
+ # example, if a query does not have enough results, an expanded query with
3934
+ # SearchRequest.canonical_filter will be returned as a supplement of the
3935
+ # original query. This field is strongly recommended to achieve high search
3936
+ # quality. See SearchRequest.filter for more details about filter syntax.
3809
3937
  # Corresponds to the JSON property `canonicalFilter`
3810
3938
  # @return [String]
3811
3939
  attr_accessor :canonical_filter
@@ -4804,15 +4932,21 @@ module Google
4804
4932
  class GoogleCloudRetailV2alphaUserEvent
4805
4933
  include Google::Apis::Core::Hashable
4806
4934
 
4807
- # Extra user event features to include in the recommendation model. This field
4808
- # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
4809
- # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
4810
- # 000 characters. * For text attributes, at most 400 values are allowed. Empty
4811
- # values are not allowed. Each value must be a UTF-8 encoded string with a
4812
- # length limit of 256 characters. * For number attributes, at most 400 values
4813
- # are allowed. For product recommendation, an example of extra user information
4814
- # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
4815
- # site by coming to the site directly, or coming through Google search, and etc.
4935
+ # Extra user event features to include in the recommendation model. If you
4936
+ # provide custom attributes for ingested user events, also include them in the
4937
+ # user events that you associate with prediction requests. Custom attribute
4938
+ # formatting must be consistent between imported events and events provided with
4939
+ # prediction requests. This lets the Retail API use those custom attributes when
4940
+ # training models and serving predictions, which helps improve recommendation
4941
+ # quality. This field needs to pass all below criteria, otherwise an
4942
+ # INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string
4943
+ # with a length limit of 5,000 characters. * For text attributes, at most 400
4944
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
4945
+ # encoded string with a length limit of 256 characters. * For number attributes,
4946
+ # at most 400 values are allowed. For product recommendations, an example of
4947
+ # extra user information is traffic_channel, which is how a user arrives at the
4948
+ # site. Users can arrive at the site by coming to the site directly, coming
4949
+ # through Google search, or in other ways.
4816
4950
  # Corresponds to the JSON property `attributes`
4817
4951
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
4818
4952
  attr_accessor :attributes
@@ -5738,11 +5872,11 @@ module Google
5738
5872
  # Represents a whole or partial calendar date, such as a birthday. The time of
5739
5873
  # day and time zone are either specified elsewhere or are insignificant. The
5740
5874
  # date is relative to the Gregorian Calendar. This can represent one of the
5741
- # following: * A full date, with non-zero year, month, and day values * A month
5742
- # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
5743
- # zero month and a zero day * A year and month, with a zero day (e.g., a credit
5744
- # card expiration date) Related types: * google.type.TimeOfDay * google.type.
5745
- # DateTime * google.protobuf.Timestamp
5875
+ # following: * A full date, with non-zero year, month, and day values. * A month
5876
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
5877
+ # with a zero month and a zero day. * A year and month, with a zero day (for
5878
+ # example, a credit card expiration date). Related types: * google.type.
5879
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
5746
5880
  class GoogleTypeDate
5747
5881
  include Google::Apis::Core::Hashable
5748
5882
 
@@ -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.30.0"
19
+ GEM_VERSION = "0.33.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220217"
25
+ REVISION = "20220310"
26
26
  end
27
27
  end
28
28
  end
@@ -526,6 +526,24 @@ module Google
526
526
  include Google::Apis::Core::JsonObjectSupport
527
527
  end
528
528
 
529
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
530
+ class Representation < Google::Apis::Core::JsonRepresentation; end
531
+
532
+ include Google::Apis::Core::JsonObjectSupport
533
+ end
534
+
535
+ class GoogleCloudRetailV2alphaPurgeProductsRequest
536
+ class Representation < Google::Apis::Core::JsonRepresentation; end
537
+
538
+ include Google::Apis::Core::JsonObjectSupport
539
+ end
540
+
541
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
542
+ class Representation < Google::Apis::Core::JsonRepresentation; end
543
+
544
+ include Google::Apis::Core::JsonObjectSupport
545
+ end
546
+
529
547
  class GoogleCloudRetailV2alphaPurgeUserEventsRequest
530
548
  class Representation < Google::Apis::Core::JsonRepresentation; end
531
549
 
@@ -1349,6 +1367,7 @@ module Google
1349
1367
  property :name, as: 'name'
1350
1368
  property :rule, as: 'rule', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule::Representation
1351
1369
 
1370
+ collection :search_solution_use_case, as: 'searchSolutionUseCase'
1352
1371
  collection :solution_types, as: 'solutionTypes'
1353
1372
  end
1354
1373
  end
@@ -1757,6 +1776,32 @@ module Google
1757
1776
  end
1758
1777
  end
1759
1778
 
1779
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
1780
+ # @private
1781
+ class Representation < Google::Apis::Core::JsonRepresentation
1782
+ property :create_time, as: 'createTime'
1783
+ property :failure_count, :numeric_string => true, as: 'failureCount'
1784
+ property :success_count, :numeric_string => true, as: 'successCount'
1785
+ property :update_time, as: 'updateTime'
1786
+ end
1787
+ end
1788
+
1789
+ class GoogleCloudRetailV2alphaPurgeProductsRequest
1790
+ # @private
1791
+ class Representation < Google::Apis::Core::JsonRepresentation
1792
+ property :filter, as: 'filter'
1793
+ property :force, as: 'force'
1794
+ end
1795
+ end
1796
+
1797
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
1798
+ # @private
1799
+ class Representation < Google::Apis::Core::JsonRepresentation
1800
+ property :purge_count, :numeric_string => true, as: 'purgeCount'
1801
+ collection :purge_sample, as: 'purgeSample'
1802
+ end
1803
+ end
1804
+
1760
1805
  class GoogleCloudRetailV2alphaPurgeUserEventsRequest
1761
1806
  # @private
1762
1807
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -72,10 +72,12 @@ module Google
72
72
  # `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
73
73
  # `OTHER_`, e.g. `OTHER_IPHONE`.
74
74
  # @param [Array<String>, String] language_codes
75
- # The list of languages of the query. This is the BCP-47 language code, such as "
76
- # en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages]
77
- # (https://tools.ietf.org/html/bcp47). The maximum number of allowed characters
78
- # is 255. Only "en-US" is currently supported.
75
+ # The language filters applied to the output suggestions. If set, it should
76
+ # contain the language of the query. If not set, suggestions are returned
77
+ # without considering language restrictions. This is the BCP-47 language code,
78
+ # such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying
79
+ # Languages](https://tools.ietf.org/html/bcp47). The maximum number of language
80
+ # codes is 3.
79
81
  # @param [Fixnum] max_suggestions
80
82
  # Completion max suggestions. If left unset or set to 0, then will fallback to
81
83
  # the configured value CompletionConfig.max_suggestions. The maximum allowed max
@@ -84,12 +86,12 @@ module Google
84
86
  # Required. The query used to generate suggestions. The maximum number of
85
87
  # allowed characters is 255.
86
88
  # @param [String] visitor_id
87
- # A unique identifier for tracking visitors. For example, this could be
88
- # implemented with an HTTP cookie, which should be able to uniquely identify a
89
- # visitor on a single device. This unique identifier should not change if the
90
- # visitor logs in or out of the website. The field must be a UTF-8 encoded
91
- # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
92
- # error is returned.
89
+ # Required field. A unique identifier for tracking visitors. For example, this
90
+ # could be implemented with an HTTP cookie, which should be able to uniquely
91
+ # identify a visitor on a single device. This unique identifier should not
92
+ # change if the visitor logs in or out of the website. The field must be a UTF-8
93
+ # encoded string with a length limit of 128 characters. Otherwise, an
94
+ # INVALID_ARGUMENT error is returned.
93
95
  # @param [String] fields
94
96
  # Selector specifying which fields to include in a partial response.
95
97
  # @param [String] quota_user
@@ -858,6 +860,47 @@ module Google
858
860
  execute_or_queue_command(command, &block)
859
861
  end
860
862
 
863
+ # Permanently deletes all selected Products under a branch. This process is
864
+ # asynchronous. If the request is valid, the removal will be enqueued and
865
+ # processed offline. Depending on the number of Products, this operation could
866
+ # take hours to complete. Before the operation completes, some Products may
867
+ # still be returned by GetProduct or ListProducts. Depending on the number of
868
+ # Products, this operation could take hours to complete. To get a sample of
869
+ # Products that would be deleted, set PurgeProductsRequest.force to false.
870
+ # @param [String] parent
871
+ # Required. The resource name of the branch under which the products are created.
872
+ # The format is `projects/$`projectId`/locations/global/catalogs/$`catalogId`/
873
+ # branches/$`branchId``
874
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest] google_cloud_retail_v2alpha_purge_products_request_object
875
+ # @param [String] fields
876
+ # Selector specifying which fields to include in a partial response.
877
+ # @param [String] quota_user
878
+ # Available to use for quota purposes for server-side applications. Can be any
879
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
880
+ # @param [Google::Apis::RequestOptions] options
881
+ # Request-specific options
882
+ #
883
+ # @yield [result, err] Result & error if block supplied
884
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
885
+ # @yieldparam err [StandardError] error object if request failed
886
+ #
887
+ # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
888
+ #
889
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
890
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
891
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
892
+ def purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
893
+ command = make_simple_command(:post, 'v2alpha/{+parent}/products:purge', options)
894
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest::Representation
895
+ command.request_object = google_cloud_retail_v2alpha_purge_products_request_object
896
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
897
+ command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
898
+ command.params['parent'] = parent unless parent.nil?
899
+ command.query['fields'] = fields unless fields.nil?
900
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
901
+ execute_or_queue_command(command, &block)
902
+ end
903
+
861
904
  # Incrementally removes place IDs from a Product.fulfillment_info.place_ids.
862
905
  # This process is asynchronous and does not require the Product to exist before
863
906
  # updating fulfillment information. If the request is valid, the update will be
@@ -1764,13 +1807,14 @@ module Google
1764
1807
  execute_or_queue_command(command, &block)
1765
1808
  end
1766
1809
 
1767
- # Triggers a user event rejoin operation with latest product catalog. Events
1768
- # will not be annotated with detailed product information if product is missing
1769
- # from the catalog at the time the user event is ingested, and these events are
1810
+ # Starts a user event rejoin operation with latest product catalog. Events will
1811
+ # not be annotated with detailed product information if product is missing from
1812
+ # the catalog at the time the user event is ingested, and these events are
1770
1813
  # stored as unjoined events with a limited usage on training and serving. This
1771
- # API can be used to trigger a 'join' operation on specified events with latest
1814
+ # method can be used to start a join operation on specified events with latest
1772
1815
  # version of product catalog. It can also be used to correct events joined with
1773
- # wrong product catalog.
1816
+ # the wrong product catalog. A rejoin operation can take hours or days to
1817
+ # complete.
1774
1818
  # @param [String] parent
1775
1819
  # Required. The parent catalog resource name, such as `projects/1234/locations/
1776
1820
  # global/catalogs/default_catalog`.
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.30.0
4
+ version: 0.33.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: 2022-02-28 00:00:00.000000000 Z
11
+ date: 2022-03-21 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_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.30.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.33.0
62
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: []