google-apis-retail_v2 0.45.0 → 0.48.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: 874c48ccb188ca9435943902e64fa5e13fa944d73ca04f4802b2b1bcfd08cbe9
4
- data.tar.gz: 539084a82fdb730dbde38fdab81a17c7244d947016b3021c19a9def2135d4078
3
+ metadata.gz: 68adfb51d3ea366a8d6819e8038ffd3a3bd66141d1c7a24416d15bda3b5a5654
4
+ data.tar.gz: 4f2e5a1206ca69a01f954c12fb04cb02bb49211dd45acf1477d26121dea65a94
5
5
  SHA512:
6
- metadata.gz: a0136713627d50b984eb866422f9bb84bba126e45038eacf081f97cfb61123da0fe57c0a1b6fe8d8564cfde92c4e28212f949492320d8c07d709b247672ed169
7
- data.tar.gz: 0aa9988a7028801c8d905f7d1de846b00e5cc466854f3751f809b8df0165532bccbb1acaf9a98df95620409e231de9f54fa09bd5a1e6d7bad9af23de46191d46
6
+ metadata.gz: 3e6641d0fe66b67ccfc9aa086772d11f8698b46d393b5b38eed79e9f51d2db705b57228b9685070d795f6bb8878ddc510f232589b02a68bb1dd87fd4ae77e4e7
7
+ data.tar.gz: 5974cf3ba4623eaf226d097c1d4a1020c409245dceb1380a4322e76e65528bf7c3f6ba64f4506bae235fe55cba86d24e86924064a00e5cd6b50f1e23b4f2fe65
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.48.0 (2022-07-26)
4
+
5
+ * Regenerated from discovery document revision 20220722
6
+
7
+ ### v0.47.0 (2022-07-19)
8
+
9
+ * Regenerated from discovery document revision 20220716
10
+
11
+ ### v0.46.0 (2022-07-12)
12
+
13
+ * Regenerated from discovery document revision 20220707
14
+
3
15
  ### v0.45.0 (2022-07-08)
4
16
 
5
17
  * Regenerated from discovery document revision 20220630
@@ -680,9 +680,8 @@ module Google
680
680
 
681
681
  # Custom attributes for the suggestion term. * For "user-data", the attributes
682
682
  # are additional custom attributes ingested through BigQuery. * For "cloud-
683
- # retail", the attributes are product attributes generated by Cloud Retail. This
684
- # is an experimental feature. Contact Retail Search support team if you are
685
- # interested in enabling it.
683
+ # retail", the attributes are product attributes generated by Cloud Retail. It
684
+ # requires UserEvent.product_details is imported properly.
686
685
  # Corresponds to the JSON property `attributes`
687
686
  # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
688
687
  attr_accessor :attributes
@@ -1411,7 +1410,7 @@ module Google
1411
1410
  # in `PredictRequest.params` to receive empty results instead. Note that the API
1412
1411
  # will never return items with storageStatus of "EXPIRED" or "DELETED"
1413
1412
  # regardless of filter choices. If `filterSyntaxV2` is set to true under the `
1414
- # params` field, then attribute based expressions are expected instead of the
1413
+ # params` field, then attribute-based expressions are expected instead of the
1415
1414
  # above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND
1416
1415
  # NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors:
1417
1416
  # ANY("Red") OR categories: ANY("Phones"))
@@ -1442,7 +1441,7 @@ module Google
1442
1441
  # @return [Fixnum]
1443
1442
  attr_accessor :page_size
1444
1443
 
1445
- # The previous PredictResponse.next_page_token.
1444
+ # This field is not used for now, leave it unset.
1446
1445
  # Corresponds to the JSON property `pageToken`
1447
1446
  # @return [String]
1448
1447
  attr_accessor :page_token
@@ -1464,8 +1463,8 @@ module Google
1464
1463
  # it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
1465
1464
  # high-diversity', 'auto-diversity'`. This gives request-level control and
1466
1465
  # 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.
1466
+ # Boolean. False by default. If set to true, the `filter` field is interpreteted
1467
+ # according to the new, attribute-based syntax.
1469
1468
  # Corresponds to the JSON property `params`
1470
1469
  # @return [Hash<String,Object>]
1471
1470
  attr_accessor :params
@@ -3115,7 +3114,7 @@ module Google
3115
3114
 
3116
3115
  # Contains the spell corrected query, if found. If the spell correction type is
3117
3116
  # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
3118
- # original query will be used for search.
3117
+ # original query is used for search.
3119
3118
  # Corresponds to the JSON property `correctedQuery`
3120
3119
  # @return [String]
3121
3120
  attr_accessor :corrected_query
@@ -3868,6 +3867,51 @@ module Google
3868
3867
  end
3869
3868
  end
3870
3869
 
3870
+ # A BigQuery output result.
3871
+ class GoogleCloudRetailV2alphaBigQueryOutputResult
3872
+ include Google::Apis::Core::Hashable
3873
+
3874
+ # The ID of a BigQuery Dataset.
3875
+ # Corresponds to the JSON property `datasetId`
3876
+ # @return [String]
3877
+ attr_accessor :dataset_id
3878
+
3879
+ # The ID of a BigQuery Table.
3880
+ # Corresponds to the JSON property `tableId`
3881
+ # @return [String]
3882
+ attr_accessor :table_id
3883
+
3884
+ def initialize(**args)
3885
+ update!(**args)
3886
+ end
3887
+
3888
+ # Update properties of this object
3889
+ def update!(**args)
3890
+ @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
3891
+ @table_id = args[:table_id] if args.key?(:table_id)
3892
+ end
3893
+ end
3894
+
3895
+ # Metadata associated with a create operation.
3896
+ class GoogleCloudRetailV2alphaCreateModelMetadata
3897
+ include Google::Apis::Core::Hashable
3898
+
3899
+ # The resource name of the model that this create applies to. Format: projects/`
3900
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
3901
+ # Corresponds to the JSON property `model`
3902
+ # @return [String]
3903
+ attr_accessor :model
3904
+
3905
+ def initialize(**args)
3906
+ update!(**args)
3907
+ end
3908
+
3909
+ # Update properties of this object
3910
+ def update!(**args)
3911
+ @model = args[:model] if args.key?(:model)
3912
+ end
3913
+ end
3914
+
3871
3915
  # Configuration of destination for Export related errors.
3872
3916
  class GoogleCloudRetailV2alphaExportErrorsConfig
3873
3917
  include Google::Apis::Core::Hashable
@@ -3932,6 +3976,11 @@ module Google
3932
3976
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig]
3933
3977
  attr_accessor :errors_config
3934
3978
 
3979
+ # Output result.
3980
+ # Corresponds to the JSON property `outputResult`
3981
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult]
3982
+ attr_accessor :output_result
3983
+
3935
3984
  def initialize(**args)
3936
3985
  update!(**args)
3937
3986
  end
@@ -3940,6 +3989,7 @@ module Google
3940
3989
  def update!(**args)
3941
3990
  @error_samples = args[:error_samples] if args.key?(:error_samples)
3942
3991
  @errors_config = args[:errors_config] if args.key?(:errors_config)
3992
+ @output_result = args[:output_result] if args.key?(:output_result)
3943
3993
  end
3944
3994
  end
3945
3995
 
@@ -3959,6 +4009,11 @@ module Google
3959
4009
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig]
3960
4010
  attr_accessor :errors_config
3961
4011
 
4012
+ # Output result.
4013
+ # Corresponds to the JSON property `outputResult`
4014
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult]
4015
+ attr_accessor :output_result
4016
+
3962
4017
  def initialize(**args)
3963
4018
  update!(**args)
3964
4019
  end
@@ -3967,6 +4022,7 @@ module Google
3967
4022
  def update!(**args)
3968
4023
  @error_samples = args[:error_samples] if args.key?(:error_samples)
3969
4024
  @errors_config = args[:errors_config] if args.key?(:errors_config)
4025
+ @output_result = args[:output_result] if args.key?(:output_result)
3970
4026
  end
3971
4027
  end
3972
4028
 
@@ -4127,6 +4183,278 @@ module Google
4127
4183
  end
4128
4184
  end
4129
4185
 
4186
+ # Metadata that describes the training and serving parameters of a Model. A
4187
+ # Model can be associated with a ServingConfig and then queried through the
4188
+ # Predict api.
4189
+ class GoogleCloudRetailV2alphaModel
4190
+ include Google::Apis::Core::Hashable
4191
+
4192
+ # Output only. Timestamp the Recommendation Model was created at.
4193
+ # Corresponds to the JSON property `createTime`
4194
+ # @return [String]
4195
+ attr_accessor :create_time
4196
+
4197
+ # Output only. The state of data requirements for this model: DATA_OK and
4198
+ # DATA_ERROR. Recommendation model cannot be trained if the data is in
4199
+ # DATA_ERROR state. Recommendation model can have DATA_ERROR state even if
4200
+ # serving state is ACTIVE: models were trained successfully before, but cannot
4201
+ # be refreshed because model no longer has sufficient data for training.
4202
+ # Corresponds to the JSON property `dataState`
4203
+ # @return [String]
4204
+ attr_accessor :data_state
4205
+
4206
+ # Required. The display name of the model. Should be human readable, used to
4207
+ # display Recommendation Models in the Retail Pantheon Dashboard. UTF-8 encoded
4208
+ # string with limit of 1024 characters.
4209
+ # Corresponds to the JSON property `displayName`
4210
+ # @return [String]
4211
+ attr_accessor :display_name
4212
+
4213
+ # Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by
4214
+ # attributes is enabled for the model.
4215
+ # Corresponds to the JSON property `filteringOption`
4216
+ # @return [String]
4217
+ attr_accessor :filtering_option
4218
+
4219
+ # Output only. The timestamp when the latest successful tune finished.
4220
+ # Corresponds to the JSON property `lastTuneTime`
4221
+ # @return [String]
4222
+ attr_accessor :last_tune_time
4223
+
4224
+ # Required. The fully qualified resource name of the model. Format: projects/`
4225
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
4226
+ # catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
4227
+ # Corresponds to the JSON property `name`
4228
+ # @return [String]
4229
+ attr_accessor :name
4230
+
4231
+ # Optional. The optimization objective e.g. `cvr`. Currently supported values: `
4232
+ # ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
4233
+ # model type. Default depends on type of recommendation: `recommended-for-you` =>
4234
+ # `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
4235
+ # revenue_per_order`
4236
+ # Corresponds to the JSON property `optimizationObjective`
4237
+ # @return [String]
4238
+ attr_accessor :optimization_objective
4239
+
4240
+ # The PageOptimizationConfig for model training. This determines how many panels
4241
+ # to optimize for, and which serving configurations to consider for each panel.
4242
+ # The purpose of this model is to optimize which ServingConfig to show on which
4243
+ # panels in way that optimizes the visitors shopping journey.
4244
+ # Corresponds to the JSON property `pageOptimizationConfig`
4245
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig]
4246
+ attr_accessor :page_optimization_config
4247
+
4248
+ # Optional. The state of periodic tuning. The period we use is 3 months - to do
4249
+ # a one-off tune earlier use the TuneModel method. Default value is
4250
+ # PERIODIC_TUNING_ENABLED.
4251
+ # Corresponds to the JSON property `periodicTuningState`
4252
+ # @return [String]
4253
+ attr_accessor :periodic_tuning_state
4254
+
4255
+ # Output only. The list of valid serving configs associated with the
4256
+ # PageOptimizationConfig.
4257
+ # Corresponds to the JSON property `servingConfigLists`
4258
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelServingConfigList>]
4259
+ attr_accessor :serving_config_lists
4260
+
4261
+ # Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
4262
+ # Corresponds to the JSON property `servingState`
4263
+ # @return [String]
4264
+ attr_accessor :serving_state
4265
+
4266
+ # Optional. The training state that the model is in (e.g. TRAINING or PAUSED).
4267
+ # Since part of the cost of running the service is frequency of training - this
4268
+ # can be used to determine when to train model in order to control cost. If not
4269
+ # specified: the default value for CreateModel method is TRAINING. the default
4270
+ # value for UpdateModel method is to keep the state the same as before.
4271
+ # Corresponds to the JSON property `trainingState`
4272
+ # @return [String]
4273
+ attr_accessor :training_state
4274
+
4275
+ # Output only. The tune operation associated with the model. Can be used to
4276
+ # determine if there is an ongoing tune for this recommendation. Empty field
4277
+ # implies no tune is goig on.
4278
+ # Corresponds to the JSON property `tuningOperation`
4279
+ # @return [String]
4280
+ attr_accessor :tuning_operation
4281
+
4282
+ # Required. The type of model e.g. `home-page`. Currently supported values: `
4283
+ # recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
4284
+ # page-optimization`, 'similar-items', 'buy-it-again', `recently-viewed`(
4285
+ # readonly value).
4286
+ # Corresponds to the JSON property `type`
4287
+ # @return [String]
4288
+ attr_accessor :type
4289
+
4290
+ # Output only. Timestamp the Recommendation Model was last updated. E.g. if a
4291
+ # Recommendation Model was paused - this would be the time the pause was
4292
+ # initiated.
4293
+ # Corresponds to the JSON property `updateTime`
4294
+ # @return [String]
4295
+ attr_accessor :update_time
4296
+
4297
+ def initialize(**args)
4298
+ update!(**args)
4299
+ end
4300
+
4301
+ # Update properties of this object
4302
+ def update!(**args)
4303
+ @create_time = args[:create_time] if args.key?(:create_time)
4304
+ @data_state = args[:data_state] if args.key?(:data_state)
4305
+ @display_name = args[:display_name] if args.key?(:display_name)
4306
+ @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
4307
+ @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
4308
+ @name = args[:name] if args.key?(:name)
4309
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
4310
+ @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
4311
+ @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
4312
+ @serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
4313
+ @serving_state = args[:serving_state] if args.key?(:serving_state)
4314
+ @training_state = args[:training_state] if args.key?(:training_state)
4315
+ @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
4316
+ @type = args[:type] if args.key?(:type)
4317
+ @update_time = args[:update_time] if args.key?(:update_time)
4318
+ end
4319
+ end
4320
+
4321
+ # The PageOptimizationConfig for model training. This determines how many panels
4322
+ # to optimize for, and which serving configurations to consider for each panel.
4323
+ # The purpose of this model is to optimize which ServingConfig to show on which
4324
+ # panels in way that optimizes the visitors shopping journey.
4325
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfig
4326
+ include Google::Apis::Core::Hashable
4327
+
4328
+ # Required. The type of UserEvent this page optimization is shown for. Each page
4329
+ # has an associated event type - this will be the corresponding event type for
4330
+ # the page that the page optimization model is used on. Supported types: * `add-
4331
+ # to-cart`: Products being added to cart. * `detail-page-view`: Products detail
4332
+ # page viewed. * `home-page-view`: Homepage viewed * `category-page-view`:
4333
+ # Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `
4334
+ # home-page-view` only allows models with type `recommended-for-you`. All other
4335
+ # page_optimization_event_type allow all Model.types.
4336
+ # Corresponds to the JSON property `pageOptimizationEventType`
4337
+ # @return [String]
4338
+ attr_accessor :page_optimization_event_type
4339
+
4340
+ # Required. A list of panel configurations. Limit = 5.
4341
+ # Corresponds to the JSON property `panels`
4342
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel>]
4343
+ attr_accessor :panels
4344
+
4345
+ # Optional. How to restrict results across panels e.g. can the same
4346
+ # ServingConfig be shown on multiple panels at once. If unspecified, default to `
4347
+ # UNIQUE_MODEL_RESTRICTION`.
4348
+ # Corresponds to the JSON property `restriction`
4349
+ # @return [String]
4350
+ attr_accessor :restriction
4351
+
4352
+ def initialize(**args)
4353
+ update!(**args)
4354
+ end
4355
+
4356
+ # Update properties of this object
4357
+ def update!(**args)
4358
+ @page_optimization_event_type = args[:page_optimization_event_type] if args.key?(:page_optimization_event_type)
4359
+ @panels = args[:panels] if args.key?(:panels)
4360
+ @restriction = args[:restriction] if args.key?(:restriction)
4361
+ end
4362
+ end
4363
+
4364
+ # A candidate to consider for a given panel. Currently only ServingConfig are
4365
+ # valid candidates.
4366
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
4367
+ include Google::Apis::Core::Hashable
4368
+
4369
+ # This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with
4370
+ # full name: `projects/*/locations/global/catalogs/default_catalog/
4371
+ # servingConfigs/my_candidate_config` this would be 'my_candidate_config'
4372
+ # Corresponds to the JSON property `servingConfigId`
4373
+ # @return [String]
4374
+ attr_accessor :serving_config_id
4375
+
4376
+ def initialize(**args)
4377
+ update!(**args)
4378
+ end
4379
+
4380
+ # Update properties of this object
4381
+ def update!(**args)
4382
+ @serving_config_id = args[:serving_config_id] if args.key?(:serving_config_id)
4383
+ end
4384
+ end
4385
+
4386
+ # An individual panel with a list of ServingConfigs to consider for it.
4387
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
4388
+ include Google::Apis::Core::Hashable
4389
+
4390
+ # Required. The candidates to consider on the panel. Limit = 10.
4391
+ # Corresponds to the JSON property `candidates`
4392
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate>]
4393
+ attr_accessor :candidates
4394
+
4395
+ # A candidate to consider for a given panel. Currently only ServingConfig are
4396
+ # valid candidates.
4397
+ # Corresponds to the JSON property `defaultCandidate`
4398
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate]
4399
+ attr_accessor :default_candidate
4400
+
4401
+ # Optional. The name to display for the panel.
4402
+ # Corresponds to the JSON property `displayName`
4403
+ # @return [String]
4404
+ attr_accessor :display_name
4405
+
4406
+ def initialize(**args)
4407
+ update!(**args)
4408
+ end
4409
+
4410
+ # Update properties of this object
4411
+ def update!(**args)
4412
+ @candidates = args[:candidates] if args.key?(:candidates)
4413
+ @default_candidate = args[:default_candidate] if args.key?(:default_candidate)
4414
+ @display_name = args[:display_name] if args.key?(:display_name)
4415
+ end
4416
+ end
4417
+
4418
+ # Represents an ordered combination of valid serving configs, which / may be
4419
+ # used for PAGE_OPTIMIZATION recommendations.
4420
+ class GoogleCloudRetailV2alphaModelServingConfigList
4421
+ include Google::Apis::Core::Hashable
4422
+
4423
+ # Optional. A set of valid serving configs that may be used for
4424
+ # PAGE_OPTIMIZATION.
4425
+ # Corresponds to the JSON property `servingConfigIds`
4426
+ # @return [Array<String>]
4427
+ attr_accessor :serving_config_ids
4428
+
4429
+ def initialize(**args)
4430
+ update!(**args)
4431
+ end
4432
+
4433
+ # Update properties of this object
4434
+ def update!(**args)
4435
+ @serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
4436
+ end
4437
+ end
4438
+
4439
+ # Output result.
4440
+ class GoogleCloudRetailV2alphaOutputResult
4441
+ include Google::Apis::Core::Hashable
4442
+
4443
+ # Export result in BigQuery.
4444
+ # Corresponds to the JSON property `bigqueryResult`
4445
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaBigQueryOutputResult>]
4446
+ attr_accessor :bigquery_result
4447
+
4448
+ def initialize(**args)
4449
+ update!(**args)
4450
+ end
4451
+
4452
+ # Update properties of this object
4453
+ def update!(**args)
4454
+ @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
4455
+ end
4456
+ end
4457
+
4130
4458
  # Metadata related to the progress of the Purge operation. This will be returned
4131
4459
  # by the google.longrunning.Operation.metadata field.
4132
4460
  class GoogleCloudRetailV2alphaPurgeMetadata
@@ -4351,6 +4679,39 @@ module Google
4351
4679
  end
4352
4680
  end
4353
4681
 
4682
+ # Metadata associated with a tune operation.
4683
+ class GoogleCloudRetailV2alphaTuneModelMetadata
4684
+ include Google::Apis::Core::Hashable
4685
+
4686
+ # The resource name of the model that this tune applies to. Format: projects/`
4687
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
4688
+ # Corresponds to the JSON property `model`
4689
+ # @return [String]
4690
+ attr_accessor :model
4691
+
4692
+ def initialize(**args)
4693
+ update!(**args)
4694
+ end
4695
+
4696
+ # Update properties of this object
4697
+ def update!(**args)
4698
+ @model = args[:model] if args.key?(:model)
4699
+ end
4700
+ end
4701
+
4702
+ # Response associated with a tune operation.
4703
+ class GoogleCloudRetailV2alphaTuneModelResponse
4704
+ include Google::Apis::Core::Hashable
4705
+
4706
+ def initialize(**args)
4707
+ update!(**args)
4708
+ end
4709
+
4710
+ # Update properties of this object
4711
+ def update!(**args)
4712
+ end
4713
+ end
4714
+
4354
4715
  # A summary of import result. The UserEventImportSummary summarizes the import
4355
4716
  # status for user events.
4356
4717
  class GoogleCloudRetailV2alphaUserEventImportSummary
@@ -4438,6 +4799,31 @@ module Google
4438
4799
  end
4439
4800
  end
4440
4801
 
4802
+ # A BigQuery output result.
4803
+ class GoogleCloudRetailV2betaBigQueryOutputResult
4804
+ include Google::Apis::Core::Hashable
4805
+
4806
+ # The ID of a BigQuery Dataset.
4807
+ # Corresponds to the JSON property `datasetId`
4808
+ # @return [String]
4809
+ attr_accessor :dataset_id
4810
+
4811
+ # The ID of a BigQuery Table.
4812
+ # Corresponds to the JSON property `tableId`
4813
+ # @return [String]
4814
+ attr_accessor :table_id
4815
+
4816
+ def initialize(**args)
4817
+ update!(**args)
4818
+ end
4819
+
4820
+ # Update properties of this object
4821
+ def update!(**args)
4822
+ @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
4823
+ @table_id = args[:table_id] if args.key?(:table_id)
4824
+ end
4825
+ end
4826
+
4441
4827
  # Configuration of destination for Export related errors.
4442
4828
  class GoogleCloudRetailV2betaExportErrorsConfig
4443
4829
  include Google::Apis::Core::Hashable
@@ -4502,6 +4888,11 @@ module Google
4502
4888
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig]
4503
4889
  attr_accessor :errors_config
4504
4890
 
4891
+ # Output result.
4892
+ # Corresponds to the JSON property `outputResult`
4893
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult]
4894
+ attr_accessor :output_result
4895
+
4505
4896
  def initialize(**args)
4506
4897
  update!(**args)
4507
4898
  end
@@ -4510,6 +4901,7 @@ module Google
4510
4901
  def update!(**args)
4511
4902
  @error_samples = args[:error_samples] if args.key?(:error_samples)
4512
4903
  @errors_config = args[:errors_config] if args.key?(:errors_config)
4904
+ @output_result = args[:output_result] if args.key?(:output_result)
4513
4905
  end
4514
4906
  end
4515
4907
 
@@ -4529,6 +4921,11 @@ module Google
4529
4921
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig]
4530
4922
  attr_accessor :errors_config
4531
4923
 
4924
+ # Output result.
4925
+ # Corresponds to the JSON property `outputResult`
4926
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult]
4927
+ attr_accessor :output_result
4928
+
4532
4929
  def initialize(**args)
4533
4930
  update!(**args)
4534
4931
  end
@@ -4537,6 +4934,7 @@ module Google
4537
4934
  def update!(**args)
4538
4935
  @error_samples = args[:error_samples] if args.key?(:error_samples)
4539
4936
  @errors_config = args[:errors_config] if args.key?(:errors_config)
4937
+ @output_result = args[:output_result] if args.key?(:output_result)
4540
4938
  end
4541
4939
  end
4542
4940
 
@@ -4697,6 +5095,25 @@ module Google
4697
5095
  end
4698
5096
  end
4699
5097
 
5098
+ # Output result.
5099
+ class GoogleCloudRetailV2betaOutputResult
5100
+ include Google::Apis::Core::Hashable
5101
+
5102
+ # Export result in BigQuery.
5103
+ # Corresponds to the JSON property `bigqueryResult`
5104
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2betaBigQueryOutputResult>]
5105
+ attr_accessor :bigquery_result
5106
+
5107
+ def initialize(**args)
5108
+ update!(**args)
5109
+ end
5110
+
5111
+ # Update properties of this object
5112
+ def update!(**args)
5113
+ @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
5114
+ end
5115
+ end
5116
+
4700
5117
  # Metadata related to the progress of the Purge operation. This will be returned
4701
5118
  # by the google.longrunning.Operation.metadata field.
4702
5119
  class GoogleCloudRetailV2betaPurgeMetadata
@@ -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.45.0"
19
+ GEM_VERSION = "0.48.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.9.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220630"
25
+ REVISION = "20220722"
26
26
  end
27
27
  end
28
28
  end
@@ -568,6 +568,18 @@ module Google
568
568
  include Google::Apis::Core::JsonObjectSupport
569
569
  end
570
570
 
571
+ class GoogleCloudRetailV2alphaBigQueryOutputResult
572
+ class Representation < Google::Apis::Core::JsonRepresentation; end
573
+
574
+ include Google::Apis::Core::JsonObjectSupport
575
+ end
576
+
577
+ class GoogleCloudRetailV2alphaCreateModelMetadata
578
+ class Representation < Google::Apis::Core::JsonRepresentation; end
579
+
580
+ include Google::Apis::Core::JsonObjectSupport
581
+ end
582
+
571
583
  class GoogleCloudRetailV2alphaExportErrorsConfig
572
584
  class Representation < Google::Apis::Core::JsonRepresentation; end
573
585
 
@@ -622,6 +634,42 @@ module Google
622
634
  include Google::Apis::Core::JsonObjectSupport
623
635
  end
624
636
 
637
+ class GoogleCloudRetailV2alphaModel
638
+ class Representation < Google::Apis::Core::JsonRepresentation; end
639
+
640
+ include Google::Apis::Core::JsonObjectSupport
641
+ end
642
+
643
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfig
644
+ class Representation < Google::Apis::Core::JsonRepresentation; end
645
+
646
+ include Google::Apis::Core::JsonObjectSupport
647
+ end
648
+
649
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
650
+ class Representation < Google::Apis::Core::JsonRepresentation; end
651
+
652
+ include Google::Apis::Core::JsonObjectSupport
653
+ end
654
+
655
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
656
+ class Representation < Google::Apis::Core::JsonRepresentation; end
657
+
658
+ include Google::Apis::Core::JsonObjectSupport
659
+ end
660
+
661
+ class GoogleCloudRetailV2alphaModelServingConfigList
662
+ class Representation < Google::Apis::Core::JsonRepresentation; end
663
+
664
+ include Google::Apis::Core::JsonObjectSupport
665
+ end
666
+
667
+ class GoogleCloudRetailV2alphaOutputResult
668
+ class Representation < Google::Apis::Core::JsonRepresentation; end
669
+
670
+ include Google::Apis::Core::JsonObjectSupport
671
+ end
672
+
625
673
  class GoogleCloudRetailV2alphaPurgeMetadata
626
674
  class Representation < Google::Apis::Core::JsonRepresentation; end
627
675
 
@@ -694,6 +742,18 @@ module Google
694
742
  include Google::Apis::Core::JsonObjectSupport
695
743
  end
696
744
 
745
+ class GoogleCloudRetailV2alphaTuneModelMetadata
746
+ class Representation < Google::Apis::Core::JsonRepresentation; end
747
+
748
+ include Google::Apis::Core::JsonObjectSupport
749
+ end
750
+
751
+ class GoogleCloudRetailV2alphaTuneModelResponse
752
+ class Representation < Google::Apis::Core::JsonRepresentation; end
753
+
754
+ include Google::Apis::Core::JsonObjectSupport
755
+ end
756
+
697
757
  class GoogleCloudRetailV2alphaUserEventImportSummary
698
758
  class Representation < Google::Apis::Core::JsonRepresentation; end
699
759
 
@@ -724,6 +784,12 @@ module Google
724
784
  include Google::Apis::Core::JsonObjectSupport
725
785
  end
726
786
 
787
+ class GoogleCloudRetailV2betaBigQueryOutputResult
788
+ class Representation < Google::Apis::Core::JsonRepresentation; end
789
+
790
+ include Google::Apis::Core::JsonObjectSupport
791
+ end
792
+
727
793
  class GoogleCloudRetailV2betaExportErrorsConfig
728
794
  class Representation < Google::Apis::Core::JsonRepresentation; end
729
795
 
@@ -778,6 +844,12 @@ module Google
778
844
  include Google::Apis::Core::JsonObjectSupport
779
845
  end
780
846
 
847
+ class GoogleCloudRetailV2betaOutputResult
848
+ class Representation < Google::Apis::Core::JsonRepresentation; end
849
+
850
+ include Google::Apis::Core::JsonObjectSupport
851
+ end
852
+
781
853
  class GoogleCloudRetailV2betaPurgeMetadata
782
854
  class Representation < Google::Apis::Core::JsonRepresentation; end
783
855
 
@@ -1780,6 +1852,21 @@ module Google
1780
1852
  end
1781
1853
  end
1782
1854
 
1855
+ class GoogleCloudRetailV2alphaBigQueryOutputResult
1856
+ # @private
1857
+ class Representation < Google::Apis::Core::JsonRepresentation
1858
+ property :dataset_id, as: 'datasetId'
1859
+ property :table_id, as: 'tableId'
1860
+ end
1861
+ end
1862
+
1863
+ class GoogleCloudRetailV2alphaCreateModelMetadata
1864
+ # @private
1865
+ class Representation < Google::Apis::Core::JsonRepresentation
1866
+ property :model, as: 'model'
1867
+ end
1868
+ end
1869
+
1783
1870
  class GoogleCloudRetailV2alphaExportErrorsConfig
1784
1871
  # @private
1785
1872
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1802,6 +1889,8 @@ module Google
1802
1889
 
1803
1890
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig::Representation
1804
1891
 
1892
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult::Representation
1893
+
1805
1894
  end
1806
1895
  end
1807
1896
 
@@ -1812,6 +1901,8 @@ module Google
1812
1901
 
1813
1902
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig::Representation
1814
1903
 
1904
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult::Representation
1905
+
1815
1906
  end
1816
1907
  end
1817
1908
 
@@ -1864,6 +1955,72 @@ module Google
1864
1955
  end
1865
1956
  end
1866
1957
 
1958
+ class GoogleCloudRetailV2alphaModel
1959
+ # @private
1960
+ class Representation < Google::Apis::Core::JsonRepresentation
1961
+ property :create_time, as: 'createTime'
1962
+ property :data_state, as: 'dataState'
1963
+ property :display_name, as: 'displayName'
1964
+ property :filtering_option, as: 'filteringOption'
1965
+ property :last_tune_time, as: 'lastTuneTime'
1966
+ property :name, as: 'name'
1967
+ property :optimization_objective, as: 'optimizationObjective'
1968
+ property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
1969
+
1970
+ property :periodic_tuning_state, as: 'periodicTuningState'
1971
+ collection :serving_config_lists, as: 'servingConfigLists', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelServingConfigList, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelServingConfigList::Representation
1972
+
1973
+ property :serving_state, as: 'servingState'
1974
+ property :training_state, as: 'trainingState'
1975
+ property :tuning_operation, as: 'tuningOperation'
1976
+ property :type, as: 'type'
1977
+ property :update_time, as: 'updateTime'
1978
+ end
1979
+ end
1980
+
1981
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfig
1982
+ # @private
1983
+ class Representation < Google::Apis::Core::JsonRepresentation
1984
+ property :page_optimization_event_type, as: 'pageOptimizationEventType'
1985
+ collection :panels, as: 'panels', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel::Representation
1986
+
1987
+ property :restriction, as: 'restriction'
1988
+ end
1989
+ end
1990
+
1991
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
1992
+ # @private
1993
+ class Representation < Google::Apis::Core::JsonRepresentation
1994
+ property :serving_config_id, as: 'servingConfigId'
1995
+ end
1996
+ end
1997
+
1998
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
1999
+ # @private
2000
+ class Representation < Google::Apis::Core::JsonRepresentation
2001
+ collection :candidates, as: 'candidates', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
2002
+
2003
+ property :default_candidate, as: 'defaultCandidate', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
2004
+
2005
+ property :display_name, as: 'displayName'
2006
+ end
2007
+ end
2008
+
2009
+ class GoogleCloudRetailV2alphaModelServingConfigList
2010
+ # @private
2011
+ class Representation < Google::Apis::Core::JsonRepresentation
2012
+ collection :serving_config_ids, as: 'servingConfigIds'
2013
+ end
2014
+ end
2015
+
2016
+ class GoogleCloudRetailV2alphaOutputResult
2017
+ # @private
2018
+ class Representation < Google::Apis::Core::JsonRepresentation
2019
+ collection :bigquery_result, as: 'bigqueryResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaBigQueryOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaBigQueryOutputResult::Representation
2020
+
2021
+ end
2022
+ end
2023
+
1867
2024
  class GoogleCloudRetailV2alphaPurgeMetadata
1868
2025
  # @private
1869
2026
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1944,6 +2101,19 @@ module Google
1944
2101
  end
1945
2102
  end
1946
2103
 
2104
+ class GoogleCloudRetailV2alphaTuneModelMetadata
2105
+ # @private
2106
+ class Representation < Google::Apis::Core::JsonRepresentation
2107
+ property :model, as: 'model'
2108
+ end
2109
+ end
2110
+
2111
+ class GoogleCloudRetailV2alphaTuneModelResponse
2112
+ # @private
2113
+ class Representation < Google::Apis::Core::JsonRepresentation
2114
+ end
2115
+ end
2116
+
1947
2117
  class GoogleCloudRetailV2alphaUserEventImportSummary
1948
2118
  # @private
1949
2119
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1976,6 +2146,14 @@ module Google
1976
2146
  end
1977
2147
  end
1978
2148
 
2149
+ class GoogleCloudRetailV2betaBigQueryOutputResult
2150
+ # @private
2151
+ class Representation < Google::Apis::Core::JsonRepresentation
2152
+ property :dataset_id, as: 'datasetId'
2153
+ property :table_id, as: 'tableId'
2154
+ end
2155
+ end
2156
+
1979
2157
  class GoogleCloudRetailV2betaExportErrorsConfig
1980
2158
  # @private
1981
2159
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1998,6 +2176,8 @@ module Google
1998
2176
 
1999
2177
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig::Representation
2000
2178
 
2179
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult::Representation
2180
+
2001
2181
  end
2002
2182
  end
2003
2183
 
@@ -2008,6 +2188,8 @@ module Google
2008
2188
 
2009
2189
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig::Representation
2010
2190
 
2191
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult::Representation
2192
+
2011
2193
  end
2012
2194
  end
2013
2195
 
@@ -2060,6 +2242,14 @@ module Google
2060
2242
  end
2061
2243
  end
2062
2244
 
2245
+ class GoogleCloudRetailV2betaOutputResult
2246
+ # @private
2247
+ class Representation < Google::Apis::Core::JsonRepresentation
2248
+ collection :bigquery_result, as: 'bigqueryResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaBigQueryOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaBigQueryOutputResult::Representation
2249
+
2250
+ end
2251
+ end
2252
+
2063
2253
  class GoogleCloudRetailV2betaPurgeMetadata
2064
2254
  # @private
2065
2255
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -935,9 +935,9 @@ module Google
935
935
 
936
936
  # Makes a recommendation prediction.
937
937
  # @param [String] placement
938
- # Required. Full resource name of the format: `placement=projects/*/locations/
939
- # global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
940
- # locations/global/catalogs/default_catalog/placements/*`. We recommend using
938
+ # Required. Full resource name of the format: ``placement=projects/*/locations/
939
+ # global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
940
+ # locations/global/catalogs/default_catalog/placements/*``. We recommend using
941
941
  # the `servingConfigs` resource. `placements` is a legacy resource. The ID of
942
942
  # the Recommendations AI serving config or placement. Before you can request
943
943
  # predictions from your model, you must create at least one serving config or
@@ -1017,9 +1017,9 @@ module Google
1017
1017
 
1018
1018
  # Makes a recommendation prediction.
1019
1019
  # @param [String] placement
1020
- # Required. Full resource name of the format: `placement=projects/*/locations/
1021
- # global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
1022
- # locations/global/catalogs/default_catalog/placements/*`. We recommend using
1020
+ # Required. Full resource name of the format: ``placement=projects/*/locations/
1021
+ # global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
1022
+ # locations/global/catalogs/default_catalog/placements/*``. We recommend using
1023
1023
  # the `servingConfigs` resource. `placements` is a legacy resource. The ID of
1024
1024
  # the Recommendations AI serving config or placement. Before you can request
1025
1025
  # predictions from your model, you must create at least one serving config or
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.45.0
4
+ version: 0.48.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-07-11 00:00:00.000000000 Z
11
+ date: 2022-08-01 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.45.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.48.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: []