google-cloud-retail-v2 0.6.4 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/retail/v2/catalog_pb.rb +0 -3
  4. data/lib/google/cloud/retail/v2/catalog_service/client.rb +9 -9
  5. data/lib/google/cloud/retail/v2/catalog_service_pb.rb +1 -0
  6. data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +0 -8
  7. data/lib/google/cloud/retail/v2/common_pb.rb +6 -4
  8. data/lib/google/cloud/retail/v2/completion_service/client.rb +17 -18
  9. data/lib/google/cloud/retail/v2/completion_service.rb +1 -2
  10. data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +7 -7
  11. data/lib/google/cloud/retail/v2/import_config_pb.rb +0 -1
  12. data/lib/google/cloud/retail/v2/prediction_service/client.rb +6 -3
  13. data/lib/google/cloud/retail/v2/product_pb.rb +1 -1
  14. data/lib/google/cloud/retail/v2/product_service/client.rb +319 -18
  15. data/lib/google/cloud/retail/v2/product_service_pb.rb +27 -1
  16. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +45 -7
  17. data/lib/google/cloud/retail/v2/promotion_pb.rb +22 -0
  18. data/lib/google/cloud/retail/v2/purge_config_pb.rb +1 -1
  19. data/lib/google/cloud/retail/v2/search_service/client.rb +25 -15
  20. data/lib/google/cloud/retail/v2/search_service.rb +1 -2
  21. data/lib/google/cloud/retail/v2/search_service_pb.rb +14 -2
  22. data/lib/google/cloud/retail/v2/search_service_services_pb.rb +2 -4
  23. data/lib/google/cloud/retail/v2/user_event_pb.rb +0 -1
  24. data/lib/google/cloud/retail/v2/user_event_service/client.rb +4 -3
  25. data/lib/google/cloud/retail/v2/user_event_service_pb.rb +1 -0
  26. data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +4 -3
  27. data/lib/google/cloud/retail/v2/version.rb +1 -1
  28. data/lib/google/cloud/retail/v2.rb +2 -0
  29. data/proto_docs/google/cloud/retail/v2/catalog_service.rb +9 -0
  30. data/proto_docs/google/cloud/retail/v2/common.rb +88 -25
  31. data/proto_docs/google/cloud/retail/v2/completion_service.rb +18 -15
  32. data/proto_docs/google/cloud/retail/v2/import_config.rb +29 -21
  33. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +6 -3
  34. data/proto_docs/google/cloud/retail/v2/product.rb +48 -39
  35. data/proto_docs/google/cloud/retail/v2/product_service.rb +134 -2
  36. data/proto_docs/google/cloud/retail/v2/promotion.rb +43 -0
  37. data/proto_docs/google/cloud/retail/v2/search_service.rb +64 -10
  38. data/proto_docs/google/cloud/retail/v2/user_event.rb +25 -12
  39. metadata +5 -3
@@ -30,7 +30,6 @@ module Google
30
30
  # * `add-to-cart`: Products being added to cart.
31
31
  # * `category-page-view`: Special pages such as sale or promotion pages
32
32
  # viewed.
33
- # * `completion`: Completion query result showed/clicked.
34
33
  # * `detail-page-view`: Products detail page viewed.
35
34
  # * `home-page-view`: Homepage viewed.
36
35
  # * `promotion-offered`: Promotion is offered to a user.
@@ -108,6 +107,7 @@ module Google
108
107
  # * `add-to-cart`
109
108
  # * `detail-page-view`
110
109
  # * `purchase-complete`
110
+ # * `search`
111
111
  #
112
112
  # In a `search` event, this field represents the products returned to the end
113
113
  # user on the current page (the end user may have not finished browsing the
@@ -118,22 +118,35 @@ module Google
118
118
  # desired. The end user may have not finished browsing the whole page yet.
119
119
  # @!attribute [rw] completion_detail
120
120
  # @return [::Google::Cloud::Retail::V2::CompletionDetail]
121
- # The main completion details related to the event.
121
+ # The main auto-completion details related to the event.
122
122
  #
123
- # In a `completion` event, this field represents the completions returned to
124
- # the end user and the clicked completion by the end user. In a `search`
125
- # event, it represents the search event happens after clicking completion.
123
+ # This field should be set for `search` event when autocomplete function is
124
+ # enabled and the user clicks a suggestion for search.
126
125
  # @!attribute [rw] attributes
127
126
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
128
127
  # Extra user event features to include in the recommendation model.
129
128
  #
130
- # The key must be a UTF-8 encoded string with a length limit of 5,000
131
- # characters. Otherwise, an INVALID_ARGUMENT error is returned.
132
- #
133
- # For product recommendation, an example of extra user information is
134
- # traffic_channel, i.e. how user arrives at the site. Users can arrive
135
- # at the site by coming to the site directly, or coming through Google
136
- # search, and etc.
129
+ # If you provide custom attributes for ingested user events, also include
130
+ # them in the user events that you associate with prediction requests. Custom
131
+ # attribute formatting must be consistent between imported events and events
132
+ # provided with prediction requests. This lets the Retail API use
133
+ # those custom attributes when training models and serving predictions, which
134
+ # helps improve recommendation quality.
135
+ #
136
+ # This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
137
+ # error is returned:
138
+ #
139
+ # * The key must be a UTF-8 encoded string with a length limit of 5,000
140
+ # characters.
141
+ # * For text attributes, at most 400 values are allowed. Empty values are not
142
+ # allowed. Each value must be a UTF-8 encoded string with a length limit of
143
+ # 256 characters.
144
+ # * For number attributes, at most 400 values are allowed.
145
+ #
146
+ # For product recommendations, an example of extra user information is
147
+ # traffic_channel, which is how a user arrives at the site. Users can arrive
148
+ # at the site by coming to the site directly, coming through Google
149
+ # search, or in other ways.
137
150
  # @!attribute [rw] cart_id
138
151
  # @return [::String]
139
152
  # The ID or name of the associated shopping cart. This ID is used
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-retail-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.4
4
+ version: 0.7.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-01-11 00:00:00.000000000 Z
11
+ date: 2022-03-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -202,6 +202,7 @@ files:
202
202
  - lib/google/cloud/retail/v2/product_service/paths.rb
203
203
  - lib/google/cloud/retail/v2/product_service_pb.rb
204
204
  - lib/google/cloud/retail/v2/product_service_services_pb.rb
205
+ - lib/google/cloud/retail/v2/promotion_pb.rb
205
206
  - lib/google/cloud/retail/v2/purge_config_pb.rb
206
207
  - lib/google/cloud/retail/v2/search_service.rb
207
208
  - lib/google/cloud/retail/v2/search_service/client.rb
@@ -230,6 +231,7 @@ files:
230
231
  - proto_docs/google/cloud/retail/v2/prediction_service.rb
231
232
  - proto_docs/google/cloud/retail/v2/product.rb
232
233
  - proto_docs/google/cloud/retail/v2/product_service.rb
234
+ - proto_docs/google/cloud/retail/v2/promotion.rb
233
235
  - proto_docs/google/cloud/retail/v2/purge_config.rb
234
236
  - proto_docs/google/cloud/retail/v2/search_service.rb
235
237
  - proto_docs/google/cloud/retail/v2/user_event.rb
@@ -263,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
263
265
  - !ruby/object:Gem::Version
264
266
  version: '0'
265
267
  requirements: []
266
- rubygems_version: 3.3.4
268
+ rubygems_version: 3.3.5
267
269
  signing_key:
268
270
  specification_version: 4
269
271
  summary: API Client library for the Retail V2 API