google-apis-retail_v2beta 0.59.0 → 0.61.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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b3fb77eff1104a388f1f370195d8d0b9b1e0b94f482a95292233a1d21a2543d7
|
4
|
+
data.tar.gz: dd6ebc8162bae9172f726a85b3b891e94cbbedfb6d15f3f9708c1344a481b593
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bfb6e3cbd7dec4a2894c024fdbe5e8dfe2c22ceafcf0118c68701476c09d0bfe9f1902ce53a42abcf7ff7512e68189c2f7a8a4a0039870bb644b511b6481cb13
|
7
|
+
data.tar.gz: 77c040e7244f02569722e415f83bfae5d7348862774800519e64cae4344fdd80e2385759bc55c36155eb81b364f01978b98cec3bcb96bd1a2edef2b699dcec01
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-retail_v2beta
|
2
2
|
|
3
|
+
### v0.61.0 (2023-01-04)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20230102
|
6
|
+
|
7
|
+
### v0.60.0 (2022-12-03)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20221130
|
10
|
+
|
3
11
|
### v0.59.0 (2022-11-08)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20221107
|
@@ -1145,8 +1145,8 @@ module Google
|
|
1145
1145
|
attr_accessor :optimization_objective
|
1146
1146
|
|
1147
1147
|
# The PageOptimizationConfig for model training. This determines how many panels
|
1148
|
-
# to optimize for, and which serving
|
1149
|
-
#
|
1148
|
+
# to optimize for, and which serving configs to consider for each panel. The
|
1149
|
+
# purpose of this model is to optimize which ServingConfig to show on which
|
1150
1150
|
# panels in way that optimizes the visitors shopping journey.
|
1151
1151
|
# Corresponds to the JSON property `pageOptimizationConfig`
|
1152
1152
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfig]
|
@@ -1188,14 +1188,14 @@ module Google
|
|
1188
1188
|
|
1189
1189
|
# Required. The type of model e.g. `home-page`. Currently supported values: `
|
1190
1190
|
# recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
|
1191
|
-
# page-optimization`, `similar-items`, `buy-it-again`, and `
|
1192
|
-
# readonly value). This field together with
|
1193
|
-
# model metadata to use to control model
|
1194
|
-
# google.com/retail/docs/models for more
|
1195
|
-
# control and which combination of parameters
|
1196
|
-
# combinations of parameters (e.g. type = `frequently-
|
1197
|
-
# optimization_objective = `ctr`), you receive an error 400
|
1198
|
-
# update a recommendation with this set of knobs.
|
1191
|
+
# page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `
|
1192
|
+
# recently-viewed`(readonly value). This field together with
|
1193
|
+
# optimization_objective describe model metadata to use to control model
|
1194
|
+
# training and serving. See https://cloud.google.com/retail/docs/models for more
|
1195
|
+
# details on what the model metadata control and which combination of parameters
|
1196
|
+
# are valid. For invalid combinations of parameters (e.g. type = `frequently-
|
1197
|
+
# bought-together` and optimization_objective = `ctr`), you receive an error 400
|
1198
|
+
# if you try to create/update a recommendation with this set of knobs.
|
1199
1199
|
# Corresponds to the JSON property `type`
|
1200
1200
|
# @return [String]
|
1201
1201
|
attr_accessor :type
|
@@ -1232,8 +1232,8 @@ module Google
|
|
1232
1232
|
end
|
1233
1233
|
|
1234
1234
|
# The PageOptimizationConfig for model training. This determines how many panels
|
1235
|
-
# to optimize for, and which serving
|
1236
|
-
#
|
1235
|
+
# to optimize for, and which serving configs to consider for each panel. The
|
1236
|
+
# purpose of this model is to optimize which ServingConfig to show on which
|
1237
1237
|
# panels in way that optimizes the visitors shopping journey.
|
1238
1238
|
class GoogleCloudRetailV2alphaModelPageOptimizationConfig
|
1239
1239
|
include Google::Apis::Core::Hashable
|
@@ -2170,7 +2170,8 @@ module Google
|
|
2170
2170
|
|
2171
2171
|
# If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This
|
2172
2172
|
# property only applies to textual custom attributes and requires indexable set
|
2173
|
-
# to enabled to enable exact-searchable.
|
2173
|
+
# to enabled to enable exact-searchable. If unset, the server behavior defaults
|
2174
|
+
# to EXACT_SEARCHABLE_DISABLED.
|
2174
2175
|
# Corresponds to the JSON property `exactSearchableOption`
|
2175
2176
|
# @return [String]
|
2176
2177
|
attr_accessor :exact_searchable_option
|
@@ -2203,7 +2204,9 @@ module Google
|
|
2203
2204
|
# custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute
|
2204
2205
|
# name can contain only alpha-numeric characters and underscores. For example,
|
2205
2206
|
# an attribute named `attributes.abc_xyz` can be indexed, but an attribute named
|
2206
|
-
# `attributes.abc-xyz` cannot be indexed.
|
2207
|
+
# `attributes.abc-xyz` cannot be indexed. For attributes whoes key start with `
|
2208
|
+
# attributes.`, we refer them as custom attributes. Otherwise they are built-in
|
2209
|
+
# attributes such as `color` and `brands`.
|
2207
2210
|
# Corresponds to the JSON property `key`
|
2208
2211
|
# @return [String]
|
2209
2212
|
attr_accessor :key
|
@@ -2216,6 +2219,12 @@ module Google
|
|
2216
2219
|
# @return [String]
|
2217
2220
|
attr_accessor :recommendations_filtering_option
|
2218
2221
|
|
2222
|
+
# If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results.
|
2223
|
+
# If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
|
2224
|
+
# Corresponds to the JSON property `retrievableOption`
|
2225
|
+
# @return [String]
|
2226
|
+
attr_accessor :retrievable_option
|
2227
|
+
|
2219
2228
|
# When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
|
2220
2229
|
# if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
|
2221
2230
|
# SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
|
@@ -2244,6 +2253,7 @@ module Google
|
|
2244
2253
|
@indexable_option = args[:indexable_option] if args.key?(:indexable_option)
|
2245
2254
|
@key = args[:key] if args.key?(:key)
|
2246
2255
|
@recommendations_filtering_option = args[:recommendations_filtering_option] if args.key?(:recommendations_filtering_option)
|
2256
|
+
@retrievable_option = args[:retrievable_option] if args.key?(:retrievable_option)
|
2247
2257
|
@searchable_option = args[:searchable_option] if args.key?(:searchable_option)
|
2248
2258
|
@type = args[:type] if args.key?(:type)
|
2249
2259
|
end
|
@@ -2622,9 +2632,9 @@ module Google
|
|
2622
2632
|
class GoogleCloudRetailV2betaControl
|
2623
2633
|
include Google::Apis::Core::Hashable
|
2624
2634
|
|
2625
|
-
# Output only. List of serving
|
2626
|
-
#
|
2627
|
-
#
|
2635
|
+
# Output only. List of serving config ids that are associated with this control
|
2636
|
+
# in the same Catalog. Note the association is managed via the ServingConfig,
|
2637
|
+
# this is an output only denormalized view.
|
2628
2638
|
# Corresponds to the JSON property `associatedServingConfigIds`
|
2629
2639
|
# @return [Array<String>]
|
2630
2640
|
attr_accessor :associated_serving_config_ids
|
@@ -3744,14 +3754,14 @@ module Google
|
|
3744
3754
|
|
3745
3755
|
# Required. The type of model e.g. `home-page`. Currently supported values: `
|
3746
3756
|
# recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
|
3747
|
-
# page-optimization`, `similar-items`, `buy-it-again`, and `
|
3748
|
-
# readonly value). This field together with
|
3749
|
-
# model metadata to use to control model
|
3750
|
-
# google.com/retail/docs/models for more
|
3751
|
-
# control and which combination of parameters
|
3752
|
-
# combinations of parameters (e.g. type = `frequently-
|
3753
|
-
# optimization_objective = `ctr`), you receive an error 400
|
3754
|
-
# update a recommendation with this set of knobs.
|
3757
|
+
# page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `
|
3758
|
+
# recently-viewed`(readonly value). This field together with
|
3759
|
+
# optimization_objective describe model metadata to use to control model
|
3760
|
+
# training and serving. See https://cloud.google.com/retail/docs/models for more
|
3761
|
+
# details on what the model metadata control and which combination of parameters
|
3762
|
+
# are valid. For invalid combinations of parameters (e.g. type = `frequently-
|
3763
|
+
# bought-together` and optimization_objective = `ctr`), you receive an error 400
|
3764
|
+
# if you try to create/update a recommendation with this set of knobs.
|
3755
3765
|
# Corresponds to the JSON property `type`
|
3756
3766
|
# @return [String]
|
3757
3767
|
attr_accessor :type
|
@@ -4388,7 +4398,8 @@ module Google
|
|
4388
4398
|
# For Type.VARIANT, the following fields are always returned in by default: *
|
4389
4399
|
# name * color_info The maximum number of paths is 30. Otherwise, an
|
4390
4400
|
# INVALID_ARGUMENT error is returned. Note: Returning more fields in
|
4391
|
-
# SearchResponse can increase response payload size and serving latency.
|
4401
|
+
# SearchResponse can increase response payload size and serving latency. This
|
4402
|
+
# field is deprecated. Use the retrievable site-wide control instead.
|
4392
4403
|
# Corresponds to the JSON property `retrievableFields`
|
4393
4404
|
# @return [String]
|
4394
4405
|
attr_accessor :retrievable_fields
|
@@ -6278,7 +6289,8 @@ module Google
|
|
6278
6289
|
# @return [String]
|
6279
6290
|
attr_accessor :diversity_level
|
6280
6291
|
|
6281
|
-
# What kind of diversity to use - data driven or rule based.
|
6292
|
+
# What kind of diversity to use - data driven or rule based. If unset, the
|
6293
|
+
# server behavior defaults to RULE_BASED_DIVERSITY.
|
6282
6294
|
# Corresponds to the JSON property `diversityType`
|
6283
6295
|
# @return [String]
|
6284
6296
|
attr_accessor :diversity_type
|
@@ -6366,7 +6378,7 @@ module Google
|
|
6366
6378
|
# product items with a similar recommendation probability to be ordered by price,
|
6367
6379
|
# with the highest-priced items first. This setting could result in a decrease
|
6368
6380
|
# in click-through and conversion rates. Allowed values are: * `no-price-
|
6369
|
-
# reranking` * `low-price-
|
6381
|
+
# reranking` * `low-price-reranking` * `medium-price-reranking` * `high-price-
|
6370
6382
|
# reranking` If not specified, we choose default based on model type. Default
|
6371
6383
|
# value: `no-price-reranking`. Can only be set if solution_types is
|
6372
6384
|
# SOLUTION_TYPE_RECOMMENDATION.
|
@@ -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
|
+
GEM_VERSION = "0.61.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.11.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20230102"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -1852,6 +1852,7 @@ module Google
|
|
1852
1852
|
property :indexable_option, as: 'indexableOption'
|
1853
1853
|
property :key, as: 'key'
|
1854
1854
|
property :recommendations_filtering_option, as: 'recommendationsFilteringOption'
|
1855
|
+
property :retrievable_option, as: 'retrievableOption'
|
1855
1856
|
property :searchable_option, as: 'searchableOption'
|
1856
1857
|
property :type, as: 'type'
|
1857
1858
|
end
|
@@ -1689,10 +1689,10 @@ module Google
|
|
1689
1689
|
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
1690
1690
|
# the Recommendations AI serving config or placement. Before you can request
|
1691
1691
|
# predictions from your model, you must create at least one serving config or
|
1692
|
-
# placement for it. For more information, see [
|
1693
|
-
#
|
1694
|
-
#
|
1695
|
-
#
|
1692
|
+
# placement for it. For more information, see [Manage serving configs] (https://
|
1693
|
+
# cloud.google.com/retail/docs/manage-configs). The full list of available
|
1694
|
+
# serving configs can be seen at https://console.cloud.google.com/ai/retail/
|
1695
|
+
# catalogs/default_catalog/configs
|
1696
1696
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest] google_cloud_retail_v2beta_predict_request_object
|
1697
1697
|
# @param [String] fields
|
1698
1698
|
# Selector specifying which fields to include in a partial response.
|
@@ -1731,8 +1731,8 @@ module Google
|
|
1731
1731
|
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1732
1732
|
# default_serving_config` or the name of the legacy placement resource, such as `
|
1733
1733
|
# projects/*/locations/global/catalogs/default_catalog/placements/default_search`
|
1734
|
-
# . This field is used to identify the serving
|
1735
|
-
#
|
1734
|
+
# . This field is used to identify the serving config name and the set of models
|
1735
|
+
# that will be used to make the search.
|
1736
1736
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
|
1737
1737
|
# @param [String] fields
|
1738
1738
|
# Selector specifying which fields to include in a partial response.
|
@@ -1995,10 +1995,10 @@ module Google
|
|
1995
1995
|
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
1996
1996
|
# the Recommendations AI serving config or placement. Before you can request
|
1997
1997
|
# predictions from your model, you must create at least one serving config or
|
1998
|
-
# placement for it. For more information, see [
|
1999
|
-
#
|
2000
|
-
#
|
2001
|
-
#
|
1998
|
+
# placement for it. For more information, see [Manage serving configs] (https://
|
1999
|
+
# cloud.google.com/retail/docs/manage-configs). The full list of available
|
2000
|
+
# serving configs can be seen at https://console.cloud.google.com/ai/retail/
|
2001
|
+
# catalogs/default_catalog/configs
|
2002
2002
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest] google_cloud_retail_v2beta_predict_request_object
|
2003
2003
|
# @param [String] fields
|
2004
2004
|
# Selector specifying which fields to include in a partial response.
|
@@ -2074,8 +2074,8 @@ module Google
|
|
2074
2074
|
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
2075
2075
|
# default_serving_config` or the name of the legacy placement resource, such as `
|
2076
2076
|
# projects/*/locations/global/catalogs/default_catalog/placements/default_search`
|
2077
|
-
# . This field is used to identify the serving
|
2078
|
-
#
|
2077
|
+
# . This field is used to identify the serving config name and the set of models
|
2078
|
+
# that will be used to make the search.
|
2079
2079
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
|
2080
2080
|
# @param [String] fields
|
2081
2081
|
# Selector specifying which fields to include in a partial response.
|
@@ -2119,7 +2119,7 @@ module Google
|
|
2119
2119
|
# payload bytes.
|
2120
2120
|
# @param [String] prebuilt_rule
|
2121
2121
|
# The prebuilt rule name that can convert a specific type of raw_json. For
|
2122
|
-
# example: "
|
2122
|
+
# example: "ga4_bq" rule for the GA4 user event schema.
|
2123
2123
|
# @param [String] raw_json
|
2124
2124
|
# An arbitrary serialized JSON string that contains necessary information that
|
2125
2125
|
# can comprise a user event. When this field is specified, the user_event field
|
@@ -2284,6 +2284,11 @@ module Google
|
|
2284
2284
|
# Required. The parent catalog resource name, such as `projects/1234/locations/
|
2285
2285
|
# global/catalogs/default_catalog`.
|
2286
2286
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent] google_cloud_retail_v2beta_user_event_object
|
2287
|
+
# @param [Boolean] write_async
|
2288
|
+
# If set to true, the user event will be written asynchronously after validation,
|
2289
|
+
# and the API will respond without waiting for the write. Therefore, silent
|
2290
|
+
# failures can occur even if the API returns success. In case of silent failures,
|
2291
|
+
# error messages can be found in Stackdriver logs.
|
2287
2292
|
# @param [String] fields
|
2288
2293
|
# Selector specifying which fields to include in a partial response.
|
2289
2294
|
# @param [String] quota_user
|
@@ -2301,13 +2306,14 @@ module Google
|
|
2301
2306
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2302
2307
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2303
2308
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2304
|
-
def write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2309
|
+
def write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2305
2310
|
command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:write', options)
|
2306
2311
|
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent::Representation
|
2307
2312
|
command.request_object = google_cloud_retail_v2beta_user_event_object
|
2308
2313
|
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent::Representation
|
2309
2314
|
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent
|
2310
2315
|
command.params['parent'] = parent unless parent.nil?
|
2316
|
+
command.query['writeAsync'] = write_async unless write_async.nil?
|
2311
2317
|
command.query['fields'] = fields unless fields.nil?
|
2312
2318
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2313
2319
|
execute_or_queue_command(command, &block)
|
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.
|
4
|
+
version: 0.61.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-01-04 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.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.61.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: []
|