google-apis-retail_v2 0.40.0 → 0.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5e457804fa4324db2dc9c63fc9f84bca169af5566f5b8f134ea0c98666051901
4
- data.tar.gz: 95cd7afd12b90b2aeb5d300a71b8e2b195520a8720b8524128b9b48c6263a79b
3
+ metadata.gz: fdd6b69ea731db6b3a33e9ff1085bb76c38cadbbe0c9441697b5786b2b677960
4
+ data.tar.gz: 9a7f362141132518bb79b45e021abeb15b6f0cc1904cdd826ada8a1633ffb970
5
5
  SHA512:
6
- metadata.gz: 4b8864590998ab3490bf46f49f72c24593d061b74300bd244cf186d7462cd3073794eb55301a1bd6d259d441147fd127452d5d544fb13ea4868429d6b1c9c633
7
- data.tar.gz: 5cf510dde1176d17c404e4881e517ec65e3d5a634689b2946c604cd5a45e4209a14c7a249c41af9b60950ee43224487dd8c575f5f80117954ae31556616f9b9b
6
+ metadata.gz: 75b99e50aa4c72a58185f1c099c4dd88f8eaaac92689fa245d361c249f5a6ee982a03d4765c1fabb99434655d6bd526419b85cfac8e5655c2b518579e6729a4a
7
+ data.tar.gz: e49c99c196ebcc098673d1590a1fcddf3a93eb8fadc4e271a42d3ec26940f357a6a8c460f9b0182de5293ec5e637be70898fdae357174203b90e0cea0248a628
data/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.43.0 (2022-06-23)
4
+
5
+ * Regenerated from discovery document revision 20220617
6
+ * Regenerated using generator version 0.7.0
7
+
8
+ ### v0.42.0 (2022-06-17)
9
+
10
+ * Regenerated from discovery document revision 20220609
11
+ * Regenerated using generator version 0.6.0
12
+
13
+ ### v0.41.0 (2022-06-07)
14
+
15
+ * Regenerated from discovery document revision 20220602
16
+ * Regenerated using generator version 0.5.0
17
+
3
18
  ### v0.40.0 (2022-05-26)
4
19
 
5
20
  * Regenerated from discovery document revision 20220519
@@ -1410,7 +1410,11 @@ module Google
1410
1410
  # only want results strictly matching the filters, set `strictFiltering` to True
1411
1411
  # in `PredictRequest.params` to receive empty results instead. Note that the API
1412
1412
  # will never return items with storageStatus of "EXPIRED" or "DELETED"
1413
- # regardless of filter choices.
1413
+ # regardless of filter choices. If `filterSyntaxV2` is set to true under the `
1414
+ # params` field, then attribute based expressions are expected instead of the
1415
+ # above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND
1416
+ # NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors:
1417
+ # ANY("Red") OR categories: ANY("Phones"))
1414
1418
  # Corresponds to the JSON property `filter`
1415
1419
  # @return [String]
1416
1420
  attr_accessor :filter
@@ -1459,7 +1463,9 @@ module Google
1459
1463
  # price. * `diversityLevel`: String. Default empty. If set to be non-empty, then
1460
1464
  # it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
1461
1465
  # high-diversity', 'auto-diversity'`. This gives request-level control and
1462
- # adjusts prediction results based on product category.
1466
+ # adjusts prediction results based on product category. * `filterSyntaxV2`:
1467
+ # Boolean. False by default. If set to true, the `filter` field will be
1468
+ # interpreteted according to the new, attribute-based syntax.
1463
1469
  # Corresponds to the JSON property `params`
1464
1470
  # @return [Hash<String,Object>]
1465
1471
  attr_accessor :params
@@ -2158,15 +2164,17 @@ module Google
2158
2164
  end
2159
2165
  end
2160
2166
 
2161
- # Promotion information.
2167
+ # Promotion specification.
2162
2168
  class GoogleCloudRetailV2Promotion
2163
2169
  include Google::Apis::Core::Hashable
2164
2170
 
2165
- # ID of the promotion. For example, "free gift". The value must be a UTF-8
2166
- # encoded string with a length limit of 128 characters, and match the pattern: `
2167
- # a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2168
- # INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
2169
- # (https://support.google.com/merchants/answer/7050148).
2171
+ # Promotion identifier, which is the final component of name. For example, this
2172
+ # field is "free_gift", if name is `projects/*/locations/global/catalogs/
2173
+ # default_catalog/promotions/free_gift`. The value must be a UTF-8 encoded
2174
+ # string with a length limit of 128 characters, and match the pattern: `a-zA-Z*`.
2175
+ # For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT
2176
+ # error is returned. Corresponds to Google Merchant Center property [
2177
+ # promotion_id](https://support.google.com/merchants/answer/7050148).
2170
2178
  # Corresponds to the JSON property `promotionId`
2171
2179
  # @return [String]
2172
2180
  attr_accessor :promotion_id
@@ -2916,6 +2924,13 @@ module Google
2916
2924
  class GoogleCloudRetailV2SearchRequestFacetSpecFacetKey
2917
2925
  include Google::Apis::Core::Hashable
2918
2926
 
2927
+ # True to make facet keys case insensitive when getting faceting values with
2928
+ # prefixes or contains; false otherwise.
2929
+ # Corresponds to the JSON property `caseInsensitive`
2930
+ # @return [Boolean]
2931
+ attr_accessor :case_insensitive
2932
+ alias_method :case_insensitive?, :case_insensitive
2933
+
2919
2934
  # Only get facet values that contains the given strings. For example, suppose "
2920
2935
  # categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe".
2921
2936
  # If set "contains" to "Shoe", the "categories" facet will give only "Women >
@@ -2998,6 +3013,7 @@ module Google
2998
3013
 
2999
3014
  # Update properties of this object
3000
3015
  def update!(**args)
3016
+ @case_insensitive = args[:case_insensitive] if args.key?(:case_insensitive)
3001
3017
  @contains = args[:contains] if args.key?(:contains)
3002
3018
  @intervals = args[:intervals] if args.key?(:intervals)
3003
3019
  @key = args[:key] if args.key?(:key)
@@ -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.40.0"
19
+ GEM_VERSION = "0.43.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.4.1"
22
+ GENERATOR_VERSION = "0.7.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220519"
25
+ REVISION = "20220617"
26
26
  end
27
27
  end
28
28
  end
@@ -1561,6 +1561,7 @@ module Google
1561
1561
  class GoogleCloudRetailV2SearchRequestFacetSpecFacetKey
1562
1562
  # @private
1563
1563
  class Representation < Google::Apis::Core::JsonRepresentation
1564
+ property :case_insensitive, as: 'caseInsensitive'
1564
1565
  collection :contains, as: 'contains'
1565
1566
  collection :intervals, as: 'intervals', class: Google::Apis::RetailV2::GoogleCloudRetailV2Interval, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Interval::Representation
1566
1567
 
@@ -929,13 +929,16 @@ module Google
929
929
 
930
930
  # Makes a recommendation prediction.
931
931
  # @param [String] placement
932
- # Required. Full resource name of the format: `name=projects/*/locations/global/
933
- # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
934
- # placement. Before you can request predictions from your model, you must create
935
- # at least one placement for it. For more information, see [Managing placements](
936
- # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
937
- # The full list of available placements can be seen at https://console.cloud.
938
- # google.com/recommendation/catalogs/default_catalog/placements
932
+ # Required. Full resource name of the format: `placement=projects/*/locations/
933
+ # global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
934
+ # locations/global/catalogs/default_catalog/placements/*`. We recommend using
935
+ # the `servingConfigs` resource. `placements` is a legacy resource. The ID of
936
+ # the Recommendations AI serving config or placement. Before you can request
937
+ # predictions from your model, you must create at least one serving config or
938
+ # placement for it. For more information, see [Managing serving configurations] (
939
+ # https://cloud.google.com/retail/docs/manage-configs). The full list of
940
+ # available serving configs can be seen at https://console.cloud.google.com/ai/
941
+ # retail/catalogs/default_catalog/configs
939
942
  # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
940
943
  # @param [String] fields
941
944
  # Selector specifying which fields to include in a partial response.
@@ -970,10 +973,12 @@ module Google
970
973
  # Search enabled. Please enable Retail Search on Cloud Console before using this
971
974
  # feature.
972
975
  # @param [String] placement
973
- # Required. The resource name of the search engine placement, such as `projects/*
974
- # /locations/global/catalogs/default_catalog/placements/default_search`. This
975
- # field is used to identify the serving configuration name and the set of models
976
- # that will be used to make the search.
976
+ # Required. The resource name of the Retail Search serving config, such as `
977
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
978
+ # default_serving_config` or the name of the legacy placement resource, such as `
979
+ # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
980
+ # . This field is used to identify the serving configuration name and the set of
981
+ # models that will be used to make the search.
977
982
  # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
978
983
  # @param [String] fields
979
984
  # Selector specifying which fields to include in a partial response.
@@ -1004,6 +1009,88 @@ module Google
1004
1009
  execute_or_queue_command(command, &block)
1005
1010
  end
1006
1011
 
1012
+ # Makes a recommendation prediction.
1013
+ # @param [String] placement
1014
+ # Required. Full resource name of the format: `placement=projects/*/locations/
1015
+ # global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
1016
+ # locations/global/catalogs/default_catalog/placements/*`. We recommend using
1017
+ # the `servingConfigs` resource. `placements` is a legacy resource. The ID of
1018
+ # the Recommendations AI serving config or placement. Before you can request
1019
+ # predictions from your model, you must create at least one serving config or
1020
+ # placement for it. For more information, see [Managing serving configurations] (
1021
+ # https://cloud.google.com/retail/docs/manage-configs). The full list of
1022
+ # available serving configs can be seen at https://console.cloud.google.com/ai/
1023
+ # retail/catalogs/default_catalog/configs
1024
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
1025
+ # @param [String] fields
1026
+ # Selector specifying which fields to include in a partial response.
1027
+ # @param [String] quota_user
1028
+ # Available to use for quota purposes for server-side applications. Can be any
1029
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1030
+ # @param [Google::Apis::RequestOptions] options
1031
+ # Request-specific options
1032
+ #
1033
+ # @yield [result, err] Result & error if block supplied
1034
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse] parsed result object
1035
+ # @yieldparam err [StandardError] error object if request failed
1036
+ #
1037
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse]
1038
+ #
1039
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1040
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1041
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1042
+ def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1043
+ command = make_simple_command(:post, 'v2/{+placement}:predict', options)
1044
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation
1045
+ command.request_object = google_cloud_retail_v2_predict_request_object
1046
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation
1047
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
1048
+ command.params['placement'] = placement unless placement.nil?
1049
+ command.query['fields'] = fields unless fields.nil?
1050
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1051
+ execute_or_queue_command(command, &block)
1052
+ end
1053
+
1054
+ # Performs a search. This feature is only available for users who have Retail
1055
+ # Search enabled. Please enable Retail Search on Cloud Console before using this
1056
+ # feature.
1057
+ # @param [String] placement
1058
+ # Required. The resource name of the Retail Search serving config, such as `
1059
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1060
+ # default_serving_config` or the name of the legacy placement resource, such as `
1061
+ # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1062
+ # . This field is used to identify the serving configuration name and the set of
1063
+ # models that will be used to make the search.
1064
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
1065
+ # @param [String] fields
1066
+ # Selector specifying which fields to include in a partial response.
1067
+ # @param [String] quota_user
1068
+ # Available to use for quota purposes for server-side applications. Can be any
1069
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1070
+ # @param [Google::Apis::RequestOptions] options
1071
+ # Request-specific options
1072
+ #
1073
+ # @yield [result, err] Result & error if block supplied
1074
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse] parsed result object
1075
+ # @yieldparam err [StandardError] error object if request failed
1076
+ #
1077
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse]
1078
+ #
1079
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1080
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1081
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1082
+ def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1083
+ command = make_simple_command(:post, 'v2/{+placement}:search', options)
1084
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation
1085
+ command.request_object = google_cloud_retail_v2_search_request_object
1086
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation
1087
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
1088
+ command.params['placement'] = placement unless placement.nil?
1089
+ command.query['fields'] = fields unless fields.nil?
1090
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1091
+ execute_or_queue_command(command, &block)
1092
+ end
1093
+
1007
1094
  # Writes a single user event from the browser. This uses a GET request to due to
1008
1095
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1009
1096
  # 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.40.0
4
+ version: 0.43.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-05-30 00:00:00.000000000 Z
11
+ date: 2022-06-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.4'
19
+ version: '0.6'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.4'
29
+ version: '0.6'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -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.40.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.43.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: []