google-apis-retail_v2 0.35.0 → 0.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/retail_v2/classes.rb +20 -15
- data/lib/google/apis/retail_v2/gem_version.rb +2 -2
- data/lib/google/apis/retail_v2/service.rb +10 -97
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a1176a95df6f47189465edd0a3ad3b8889c60ec42deb7c350350e78b8194d48c
|
|
4
|
+
data.tar.gz: 41654fa63564cb523233faf5f9f2c2a89a2b5f420364e948b95038197eb787d1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5954282fe9adc8af9905659fad8bc938b4da81bf5c2362147f117713092a5c8d4f9b3fe66ec5cd14f83d8dd9cec58baba9ba49a4698fec3036dfade3c7449dab
|
|
7
|
+
data.tar.gz: 1bed26a6aafa607dd3c3b81f3ed233dd17823b16e5616f578df3eec2ac8be868a491553581fdc10c1185d3031665ca25e55f1181c0275f8afc909f2bf3064658
|
data/CHANGELOG.md
CHANGED
|
@@ -774,12 +774,13 @@ module Google
|
|
|
774
774
|
class GoogleCloudRetailV2CustomAttribute
|
|
775
775
|
include Google::Apis::Core::Hashable
|
|
776
776
|
|
|
777
|
-
# This field
|
|
778
|
-
# the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG'
|
|
779
|
-
#
|
|
780
|
-
#
|
|
781
|
-
#
|
|
782
|
-
#
|
|
777
|
+
# This field is normally ignored unless AttributesConfig.attribute_config_level
|
|
778
|
+
# of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
|
|
779
|
+
# You may learn more on [configuration mode] (https://cloud.google.com/retail/
|
|
780
|
+
# docs/attribute-config#config-modes). if true, custom attribute values are
|
|
781
|
+
# indexed, so that it can be filtered, faceted or boosted in SearchService.
|
|
782
|
+
# Search. This field is ignored in a UserEvent. See SearchRequest.filter,
|
|
783
|
+
# SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
|
|
783
784
|
# Corresponds to the JSON property `indexable`
|
|
784
785
|
# @return [Boolean]
|
|
785
786
|
attr_accessor :indexable
|
|
@@ -792,11 +793,13 @@ module Google
|
|
|
792
793
|
# @return [Array<Float>]
|
|
793
794
|
attr_accessor :numbers
|
|
794
795
|
|
|
795
|
-
# This field
|
|
796
|
-
# the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG'
|
|
797
|
-
#
|
|
798
|
-
#
|
|
799
|
-
#
|
|
796
|
+
# This field is normally ignored unless AttributesConfig.attribute_config_level
|
|
797
|
+
# of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
|
|
798
|
+
# You may learn more on [configuration mode] (https://cloud.google.com/retail/
|
|
799
|
+
# docs/attribute-config#config-modes). If true, custom attribute values are
|
|
800
|
+
# searchable by text queries in SearchService.Search. This field is ignored in a
|
|
801
|
+
# UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error
|
|
802
|
+
# is returned.
|
|
800
803
|
# Corresponds to the JSON property `searchable`
|
|
801
804
|
# @return [Boolean]
|
|
802
805
|
attr_accessor :searchable
|
|
@@ -3051,7 +3054,9 @@ module Google
|
|
|
3051
3054
|
# @return [String]
|
|
3052
3055
|
attr_accessor :attribution_token
|
|
3053
3056
|
|
|
3054
|
-
#
|
|
3057
|
+
# Contains the spell corrected query, if found. If the spell correction type is
|
|
3058
|
+
# AUTOMATIC, then the search results will be based on corrected_query, otherwise
|
|
3059
|
+
# the original query will be used for search.
|
|
3055
3060
|
# Corresponds to the JSON property `correctedQuery`
|
|
3056
3061
|
# @return [String]
|
|
3057
3062
|
attr_accessor :corrected_query
|
|
@@ -3512,9 +3517,9 @@ module Google
|
|
|
3512
3517
|
# @return [String]
|
|
3513
3518
|
attr_accessor :page_view_id
|
|
3514
3519
|
|
|
3515
|
-
# The main product details related to the event. This field is
|
|
3516
|
-
# following event types: * `add-to-cart` * `detail-page-view` * `
|
|
3517
|
-
# complete`
|
|
3520
|
+
# The main product details related to the event. This field is optional except
|
|
3521
|
+
# for the following event types: * `add-to-cart` * `detail-page-view` * `
|
|
3522
|
+
# purchase-complete` In a `search` event, this field represents the products
|
|
3518
3523
|
# returned to the end user on the current page (the end user may have not
|
|
3519
3524
|
# finished browsing the whole page yet). When a new page is returned to the end
|
|
3520
3525
|
# user, after pagination/filtering/ordering even for the same query, a new `
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module RetailV2
|
|
18
18
|
# Version of the google-apis-retail_v2 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.36.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 = "
|
|
25
|
+
REVISION = "20220421"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -929,15 +929,12 @@ module Google
|
|
|
929
929
|
# Makes a recommendation prediction.
|
|
930
930
|
# @param [String] placement
|
|
931
931
|
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
|
932
|
-
# catalogs/default_catalog/
|
|
933
|
-
#
|
|
934
|
-
#
|
|
935
|
-
#
|
|
936
|
-
#
|
|
937
|
-
#
|
|
938
|
-
# https://cloud.google.com/retail/docs/manage-configs). The full list of
|
|
939
|
-
# available serving configs can be seen at https://console.cloud.google.com/ai/
|
|
940
|
-
# retail/catalogs/default_catalog/configs
|
|
932
|
+
# catalogs/default_catalog/placements/*` The ID of the Recommendations AI
|
|
933
|
+
# placement. Before you can request predictions from your model, you must create
|
|
934
|
+
# at least one placement for it. For more information, see [Managing placements](
|
|
935
|
+
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
|
936
|
+
# The full list of available placements can be seen at https://console.cloud.
|
|
937
|
+
# google.com/recommendation/catalogs/default_catalog/placements
|
|
941
938
|
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
|
|
942
939
|
# @param [String] fields
|
|
943
940
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -972,12 +969,10 @@ module Google
|
|
|
972
969
|
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
|
973
970
|
# feature.
|
|
974
971
|
# @param [String] placement
|
|
975
|
-
# Required. The resource name of the
|
|
976
|
-
#
|
|
977
|
-
#
|
|
978
|
-
#
|
|
979
|
-
# . This field is used to identify the serving configuration name and the set of
|
|
980
|
-
# models that will be used to make the search.
|
|
972
|
+
# Required. The resource name of the search engine placement, such as `projects/*
|
|
973
|
+
# /locations/global/catalogs/default_catalog/placements/default_search`. This
|
|
974
|
+
# field is used to identify the serving configuration name and the set of models
|
|
975
|
+
# that will be used to make the search.
|
|
981
976
|
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
|
|
982
977
|
# @param [String] fields
|
|
983
978
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -1008,88 +1003,6 @@ module Google
|
|
|
1008
1003
|
execute_or_queue_command(command, &block)
|
|
1009
1004
|
end
|
|
1010
1005
|
|
|
1011
|
-
# Makes a recommendation prediction.
|
|
1012
|
-
# @param [String] placement
|
|
1013
|
-
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
|
1014
|
-
# catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
|
|
1015
|
-
# global/catalogs/default_catalog/placements/*`. We recommend using the `
|
|
1016
|
-
# servingConfigs` resource. `placements` is a legacy resource. The ID of the
|
|
1017
|
-
# Recommendations AI serving config or placement. Before you can request
|
|
1018
|
-
# predictions from your model, you must create at least one serving config or
|
|
1019
|
-
# placement for it. For more information, see [Managing serving configurations] (
|
|
1020
|
-
# https://cloud.google.com/retail/docs/manage-configs). The full list of
|
|
1021
|
-
# available serving configs can be seen at https://console.cloud.google.com/ai/
|
|
1022
|
-
# retail/catalogs/default_catalog/configs
|
|
1023
|
-
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
|
|
1024
|
-
# @param [String] fields
|
|
1025
|
-
# Selector specifying which fields to include in a partial response.
|
|
1026
|
-
# @param [String] quota_user
|
|
1027
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
1028
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1029
|
-
# @param [Google::Apis::RequestOptions] options
|
|
1030
|
-
# Request-specific options
|
|
1031
|
-
#
|
|
1032
|
-
# @yield [result, err] Result & error if block supplied
|
|
1033
|
-
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse] parsed result object
|
|
1034
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
1035
|
-
#
|
|
1036
|
-
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse]
|
|
1037
|
-
#
|
|
1038
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1039
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1040
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1041
|
-
def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1042
|
-
command = make_simple_command(:post, 'v2/{+placement}:predict', options)
|
|
1043
|
-
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation
|
|
1044
|
-
command.request_object = google_cloud_retail_v2_predict_request_object
|
|
1045
|
-
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation
|
|
1046
|
-
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
|
|
1047
|
-
command.params['placement'] = placement unless placement.nil?
|
|
1048
|
-
command.query['fields'] = fields unless fields.nil?
|
|
1049
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1050
|
-
execute_or_queue_command(command, &block)
|
|
1051
|
-
end
|
|
1052
|
-
|
|
1053
|
-
# Performs a search. This feature is only available for users who have Retail
|
|
1054
|
-
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
|
1055
|
-
# feature.
|
|
1056
|
-
# @param [String] placement
|
|
1057
|
-
# Required. The resource name of the Retail Search serving config, such as `
|
|
1058
|
-
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
|
1059
|
-
# default_serving_config` or the name of the legacy placement resource, such as `
|
|
1060
|
-
# projects/*/locations/global/catalogs/default_catalog/placements/default_search`
|
|
1061
|
-
# . This field is used to identify the serving configuration name and the set of
|
|
1062
|
-
# models that will be used to make the search.
|
|
1063
|
-
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
|
|
1064
|
-
# @param [String] fields
|
|
1065
|
-
# Selector specifying which fields to include in a partial response.
|
|
1066
|
-
# @param [String] quota_user
|
|
1067
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
1068
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1069
|
-
# @param [Google::Apis::RequestOptions] options
|
|
1070
|
-
# Request-specific options
|
|
1071
|
-
#
|
|
1072
|
-
# @yield [result, err] Result & error if block supplied
|
|
1073
|
-
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse] parsed result object
|
|
1074
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
1075
|
-
#
|
|
1076
|
-
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse]
|
|
1077
|
-
#
|
|
1078
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1079
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1080
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1081
|
-
def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1082
|
-
command = make_simple_command(:post, 'v2/{+placement}:search', options)
|
|
1083
|
-
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation
|
|
1084
|
-
command.request_object = google_cloud_retail_v2_search_request_object
|
|
1085
|
-
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation
|
|
1086
|
-
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
|
|
1087
|
-
command.params['placement'] = placement unless placement.nil?
|
|
1088
|
-
command.query['fields'] = fields unless fields.nil?
|
|
1089
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1090
|
-
execute_or_queue_command(command, &block)
|
|
1091
|
-
end
|
|
1092
|
-
|
|
1093
1006
|
# Writes a single user event from the browser. This uses a GET request to due to
|
|
1094
1007
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
|
1095
1008
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-retail_v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.36.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-
|
|
11
|
+
date: 2022-05-02 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_v2/CHANGELOG.md
|
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.
|
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.36.0
|
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
|
|
63
63
|
post_install_message:
|
|
64
64
|
rdoc_options: []
|