google-apis-retail_v2 0.47.0 → 0.50.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -279,6 +279,26 @@ module Google
279
279
  end
280
280
  end
281
281
 
282
+ # Request for CatalogService.AddCatalogAttribute method.
283
+ class GoogleCloudRetailV2AddCatalogAttributeRequest
284
+ include Google::Apis::Core::Hashable
285
+
286
+ # Catalog level attribute config for an attribute. For example, if customers
287
+ # want to enable/disable facet for a specific attribute.
288
+ # Corresponds to the JSON property `catalogAttribute`
289
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute]
290
+ attr_accessor :catalog_attribute
291
+
292
+ def initialize(**args)
293
+ update!(**args)
294
+ end
295
+
296
+ # Update properties of this object
297
+ def update!(**args)
298
+ @catalog_attribute = args[:catalog_attribute] if args.key?(:catalog_attribute)
299
+ end
300
+ end
301
+
282
302
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
283
303
  # Currently empty because there is no meaningful metadata populated from the
284
304
  # ProductService.AddFulfillmentPlaces method.
@@ -446,6 +466,42 @@ module Google
446
466
  end
447
467
  end
448
468
 
469
+ # Catalog level attribute config.
470
+ class GoogleCloudRetailV2AttributesConfig
471
+ include Google::Apis::Core::Hashable
472
+
473
+ # Output only. The AttributeConfigLevel used for this catalog.
474
+ # Corresponds to the JSON property `attributeConfigLevel`
475
+ # @return [String]
476
+ attr_accessor :attribute_config_level
477
+
478
+ # Enable attribute(s) config at catalog level. For example, indexable,
479
+ # dynamic_facetable, or searchable for each attribute. The key is catalog
480
+ # attribute's name. For example: `color`, `brands`, `attributes.custom_attribute`
481
+ # , such as `attributes.xyz`. The maximum number of catalog attributes allowed
482
+ # in a request is 1000.
483
+ # Corresponds to the JSON property `catalogAttributes`
484
+ # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute>]
485
+ attr_accessor :catalog_attributes
486
+
487
+ # Required. Immutable. The fully qualified resource name of the attribute config.
488
+ # Format: `projects/*/locations/*/catalogs/*/attributesConfig`
489
+ # Corresponds to the JSON property `name`
490
+ # @return [String]
491
+ attr_accessor :name
492
+
493
+ def initialize(**args)
494
+ update!(**args)
495
+ end
496
+
497
+ # Update properties of this object
498
+ def update!(**args)
499
+ @attribute_config_level = args[:attribute_config_level] if args.key?(:attribute_config_level)
500
+ @catalog_attributes = args[:catalog_attributes] if args.key?(:catalog_attributes)
501
+ @name = args[:name] if args.key?(:name)
502
+ end
503
+ end
504
+
449
505
  # An intended audience of the Product for whom it's sold.
450
506
  class GoogleCloudRetailV2Audience
451
507
  include Google::Apis::Core::Hashable
@@ -495,12 +551,11 @@ module Google
495
551
  # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
496
552
  # imports: * `user_event` (default): One JSON UserEvent per line. * `
497
553
  # user_event_ga360`: The schema is available here: https://support.google.com/
498
- # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
499
- # preview. Please contact the support team for importing Google Analytics 4
500
- # events. The schema is available here: https://support.google.com/analytics/
501
- # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
502
- # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
503
- # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
554
+ # analytics/answer/3437719. * `user_event_ga4`: The schema is available here:
555
+ # https://support.google.com/analytics/answer/7029846. Supported values for auto-
556
+ # completion imports: * `suggestions` (default): One JSON completion suggestion
557
+ # per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One
558
+ # JSON allow suggestion per line.
504
559
  # Corresponds to the JSON property `dataSchema`
505
560
  # @return [String]
506
561
  attr_accessor :data_schema
@@ -592,6 +647,79 @@ module Google
592
647
  end
593
648
  end
594
649
 
650
+ # Catalog level attribute config for an attribute. For example, if customers
651
+ # want to enable/disable facet for a specific attribute.
652
+ class GoogleCloudRetailV2CatalogAttribute
653
+ include Google::Apis::Core::Hashable
654
+
655
+ # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet.
656
+ # Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option
657
+ # is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
658
+ # Corresponds to the JSON property `dynamicFacetableOption`
659
+ # @return [String]
660
+ attr_accessor :dynamic_facetable_option
661
+
662
+ # Output only. Indicates whether this attribute has been used by any products. `
663
+ # True` if at least one Product is using this attribute in Product.attributes.
664
+ # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
665
+ # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
666
+ # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
667
+ # loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither
668
+ # in use by products nor predefined can be deleted. CatalogAttributes that are
669
+ # either in use by products or are predefined cannot be deleted; however, their
670
+ # configuration properties will reset to default values upon removal request.
671
+ # After catalog changes, it takes about 10 minutes for this field to update.
672
+ # Corresponds to the JSON property `inUse`
673
+ # @return [Boolean]
674
+ attr_accessor :in_use
675
+ alias_method :in_use?, :in_use
676
+
677
+ # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
678
+ # if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered,
679
+ # faceted, or boosted in SearchService.Search.
680
+ # Corresponds to the JSON property `indexableOption`
681
+ # @return [String]
682
+ attr_accessor :indexable_option
683
+
684
+ # Required. Attribute name. For example: `color`, `brands`, `attributes.
685
+ # custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute
686
+ # name can contain only alpha-numeric characters and underscores. For example,
687
+ # an attribute named `attributes.abc_xyz` can be indexed, but an attribute named
688
+ # `attributes.abc-xyz` cannot be indexed.
689
+ # Corresponds to the JSON property `key`
690
+ # @return [String]
691
+ attr_accessor :key
692
+
693
+ # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
694
+ # if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
695
+ # SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
696
+ # attribute values will not be searchable by text queries in SearchService.
697
+ # Search, as there are no text values associated to numerical attributes.
698
+ # Corresponds to the JSON property `searchableOption`
699
+ # @return [String]
700
+ attr_accessor :searchable_option
701
+
702
+ # Output only. The type of this attribute. This is derived from the attribute in
703
+ # Product.attributes.
704
+ # Corresponds to the JSON property `type`
705
+ # @return [String]
706
+ attr_accessor :type
707
+
708
+ def initialize(**args)
709
+ update!(**args)
710
+ end
711
+
712
+ # Update properties of this object
713
+ def update!(**args)
714
+ @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
715
+ @in_use = args[:in_use] if args.key?(:in_use)
716
+ @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
717
+ @key = args[:key] if args.key?(:key)
718
+ @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
719
+ @type = args[:type] if args.key?(:type)
720
+ end
721
+ end
722
+
595
723
  # The color information of a Product.
596
724
  class GoogleCloudRetailV2ColorInfo
597
725
  include Google::Apis::Core::Hashable
@@ -655,7 +783,7 @@ module Google
655
783
  # CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
656
784
  # recent searches satisfy the follow rules: * They are ordered from latest to
657
785
  # oldest. * They are matched with CompleteQueryRequest.query case insensitively.
658
- # * They are transformed to lower cases. * They are UTF-8 safe. Recent searches
786
+ # * They are transformed to lower case. * They are UTF-8 safe. Recent searches
659
787
  # are deduplicated. More recent searches will be reserved when duplication
660
788
  # happens.
661
789
  # Corresponds to the JSON property `recentSearchResults`
@@ -721,6 +849,105 @@ module Google
721
849
  end
722
850
  end
723
851
 
852
+ # Catalog level autocomplete config for customers to customize autocomplete
853
+ # feature's settings.
854
+ class GoogleCloudRetailV2CompletionConfig
855
+ include Google::Apis::Core::Hashable
856
+
857
+ # The input config source for completion data.
858
+ # Corresponds to the JSON property `allowlistInputConfig`
859
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
860
+ attr_accessor :allowlist_input_config
861
+
862
+ # If set to true, the auto learning function is enabled. Auto learning uses user
863
+ # data to generate suggestions using ML techniques. Default value is false. Only
864
+ # after enabling auto learning can users use `cloud-retail` data in
865
+ # CompleteQueryRequest.
866
+ # Corresponds to the JSON property `autoLearning`
867
+ # @return [Boolean]
868
+ attr_accessor :auto_learning
869
+ alias_method :auto_learning?, :auto_learning
870
+
871
+ # The input config source for completion data.
872
+ # Corresponds to the JSON property `denylistInputConfig`
873
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
874
+ attr_accessor :denylist_input_config
875
+
876
+ # Output only. Name of the LRO corresponding to the latest allowlist import. Can
877
+ # use GetOperation API to retrieve the latest state of the Long Running
878
+ # Operation.
879
+ # Corresponds to the JSON property `lastAllowlistImportOperation`
880
+ # @return [String]
881
+ attr_accessor :last_allowlist_import_operation
882
+
883
+ # Output only. Name of the LRO corresponding to the latest denylist import. Can
884
+ # use GetOperation API to retrieve the latest state of the Long Running
885
+ # Operation.
886
+ # Corresponds to the JSON property `lastDenylistImportOperation`
887
+ # @return [String]
888
+ attr_accessor :last_denylist_import_operation
889
+
890
+ # Output only. Name of the LRO corresponding to the latest suggestion terms list
891
+ # import. Can use GetOperation API to retrieve the latest state of the Long
892
+ # Running Operation.
893
+ # Corresponds to the JSON property `lastSuggestionsImportOperation`
894
+ # @return [String]
895
+ attr_accessor :last_suggestions_import_operation
896
+
897
+ # Specifies the matching order for autocomplete suggestions, e.g., a query
898
+ # consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes",
899
+ # whereas a query of 'red s' with 'exact-prefix' specified would suggest "red
900
+ # shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default
901
+ # value: 'exact-prefix'.
902
+ # Corresponds to the JSON property `matchingOrder`
903
+ # @return [String]
904
+ attr_accessor :matching_order
905
+
906
+ # The maximum number of autocomplete suggestions returned per term. Default
907
+ # value is 20. If left unset or set to 0, then will fallback to default value.
908
+ # Value range is 1 to 20.
909
+ # Corresponds to the JSON property `maxSuggestions`
910
+ # @return [Fixnum]
911
+ attr_accessor :max_suggestions
912
+
913
+ # The minimum number of characters needed to be typed in order to get
914
+ # suggestions. Default value is 2. If left unset or set to 0, then will fallback
915
+ # to default value. Value range is 1 to 20.
916
+ # Corresponds to the JSON property `minPrefixLength`
917
+ # @return [Fixnum]
918
+ attr_accessor :min_prefix_length
919
+
920
+ # Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/
921
+ # completionConfig`
922
+ # Corresponds to the JSON property `name`
923
+ # @return [String]
924
+ attr_accessor :name
925
+
926
+ # The input config source for completion data.
927
+ # Corresponds to the JSON property `suggestionsInputConfig`
928
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
929
+ attr_accessor :suggestions_input_config
930
+
931
+ def initialize(**args)
932
+ update!(**args)
933
+ end
934
+
935
+ # Update properties of this object
936
+ def update!(**args)
937
+ @allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
938
+ @auto_learning = args[:auto_learning] if args.key?(:auto_learning)
939
+ @denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
940
+ @last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
941
+ @last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
942
+ @last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
943
+ @matching_order = args[:matching_order] if args.key?(:matching_order)
944
+ @max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
945
+ @min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
946
+ @name = args[:name] if args.key?(:name)
947
+ @suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
948
+ end
949
+ end
950
+
724
951
  # The input config source for completion data.
725
952
  class GoogleCloudRetailV2CompletionDataInputConfig
726
953
  include Google::Apis::Core::Hashable
@@ -1120,11 +1347,9 @@ module Google
1120
1347
  # the import is finished, a notification will be sent to specified Pub/Sub topic.
1121
1348
  # The message data will be JSON string of a Operation. Format of the Pub/Sub
1122
1349
  # topic is `projects/`project`/topics/`topic``. It has to be within the same
1123
- # project as ImportProductsRequest.parent. Make sure that both `cloud-retail-
1124
- # customer-data-access@system.gserviceaccount.com` and `service-@gcp-sa-retail.
1125
- # iam.gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on
1126
- # the topic. Only supported when ImportProductsRequest.reconciliation_mode is
1127
- # set to `FULL`.
1350
+ # project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-
1351
+ # retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission
1352
+ # on the topic.
1128
1353
  # Corresponds to the JSON property `notificationPubsubTopic`
1129
1354
  # @return [String]
1130
1355
  attr_accessor :notification_pubsub_topic
@@ -1433,15 +1658,15 @@ module Google
1433
1658
  # @return [Hash<String,String>]
1434
1659
  attr_accessor :labels
1435
1660
 
1436
- # Maximum number of results to return per page. Set this property to the number
1437
- # of prediction results needed. If zero, the service will choose a reasonable
1661
+ # Maximum number of results to return. Set this property to the number of
1662
+ # prediction results needed. If zero, the service will choose a reasonable
1438
1663
  # default. The maximum allowed value is 100. Values above 100 will be coerced to
1439
1664
  # 100.
1440
1665
  # Corresponds to the JSON property `pageSize`
1441
1666
  # @return [Fixnum]
1442
1667
  attr_accessor :page_size
1443
1668
 
1444
- # This field is not used for now, leave it unset.
1669
+ # This field is not used; leave it unset.
1445
1670
  # Corresponds to the JSON property `pageToken`
1446
1671
  # @return [String]
1447
1672
  attr_accessor :page_token
@@ -1748,7 +1973,7 @@ module Google
1748
1973
 
1749
1974
  # The id of the collection members when type is Type.COLLECTION. Non-existent
1750
1975
  # product ids are allowed. The type of the members must be either Type.PRIMARY
1751
- # or Type.VARIANT otherwise and INVALID_ARGUMENT error is thrown. Should not set
1976
+ # or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set
1752
1977
  # it for other types. A maximum of 1000 values are allowed. Otherwise, an
1753
1978
  # INVALID_ARGUMENT error is return.
1754
1979
  # Corresponds to the JSON property `collectionMemberIds`
@@ -2400,6 +2625,25 @@ module Google
2400
2625
  end
2401
2626
  end
2402
2627
 
2628
+ # Request for CatalogService.RemoveCatalogAttribute method.
2629
+ class GoogleCloudRetailV2RemoveCatalogAttributeRequest
2630
+ include Google::Apis::Core::Hashable
2631
+
2632
+ # Required. The attribute name key of the CatalogAttribute to remove.
2633
+ # Corresponds to the JSON property `key`
2634
+ # @return [String]
2635
+ attr_accessor :key
2636
+
2637
+ def initialize(**args)
2638
+ update!(**args)
2639
+ end
2640
+
2641
+ # Update properties of this object
2642
+ def update!(**args)
2643
+ @key = args[:key] if args.key?(:key)
2644
+ end
2645
+ end
2646
+
2403
2647
  # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
2404
2648
  # Currently empty because there is no meaningful metadata populated from the
2405
2649
  # ProductService.RemoveFulfillmentPlaces method.
@@ -3010,6 +3254,13 @@ module Google
3010
3254
  # @return [Array<String>]
3011
3255
  attr_accessor :restricted_values
3012
3256
 
3257
+ # Returns the min and max value for each numerical facet intervals. Ignored for
3258
+ # textual facets.
3259
+ # Corresponds to the JSON property `returnMinMax`
3260
+ # @return [Boolean]
3261
+ attr_accessor :return_min_max
3262
+ alias_method :return_min_max?, :return_min_max
3263
+
3013
3264
  def initialize(**args)
3014
3265
  update!(**args)
3015
3266
  end
@@ -3024,6 +3275,7 @@ module Google
3024
3275
  @prefixes = args[:prefixes] if args.key?(:prefixes)
3025
3276
  @query = args[:query] if args.key?(:query)
3026
3277
  @restricted_values = args[:restricted_values] if args.key?(:restricted_values)
3278
+ @return_min_max = args[:return_min_max] if args.key?(:return_min_max)
3027
3279
  end
3028
3280
  end
3029
3281
 
@@ -3226,6 +3478,18 @@ module Google
3226
3478
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Interval]
3227
3479
  attr_accessor :interval
3228
3480
 
3481
+ # The maximum value in the FacetValue.interval. Only supported on numerical
3482
+ # facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
3483
+ # Corresponds to the JSON property `maxValue`
3484
+ # @return [Float]
3485
+ attr_accessor :max_value
3486
+
3487
+ # The minimum value in the FacetValue.interval. Only supported on numerical
3488
+ # facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
3489
+ # Corresponds to the JSON property `minValue`
3490
+ # @return [Float]
3491
+ attr_accessor :min_value
3492
+
3229
3493
  # Text value of a facet, such as "Black" for facet "colorFamilies".
3230
3494
  # Corresponds to the JSON property `value`
3231
3495
  # @return [String]
@@ -3239,6 +3503,8 @@ module Google
3239
3503
  def update!(**args)
3240
3504
  @count = args[:count] if args.key?(:count)
3241
3505
  @interval = args[:interval] if args.key?(:interval)
3506
+ @max_value = args[:max_value] if args.key?(:max_value)
3507
+ @min_value = args[:min_value] if args.key?(:min_value)
3242
3508
  @value = args[:value] if args.key?(:value)
3243
3509
  end
3244
3510
  end
@@ -3294,6 +3560,15 @@ module Google
3294
3560
  # @return [Hash<String,String>]
3295
3561
  attr_accessor :matching_variant_fields
3296
3562
 
3563
+ # Specifies previous events related to this product for this user based on
3564
+ # UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set
3565
+ # only when SearchRequest.PersonalizationSpec.mode is SearchRequest.
3566
+ # PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that
3567
+ # this product has been purchased before.
3568
+ # Corresponds to the JSON property `personalLabels`
3569
+ # @return [Array<String>]
3570
+ attr_accessor :personal_labels
3571
+
3297
3572
  # Product captures all metadata information of items to be recommended or
3298
3573
  # searched.
3299
3574
  # Corresponds to the JSON property `product`
@@ -3326,6 +3601,7 @@ module Google
3326
3601
  @id = args[:id] if args.key?(:id)
3327
3602
  @matching_variant_count = args[:matching_variant_count] if args.key?(:matching_variant_count)
3328
3603
  @matching_variant_fields = args[:matching_variant_fields] if args.key?(:matching_variant_fields)
3604
+ @personal_labels = args[:personal_labels] if args.key?(:personal_labels)
3329
3605
  @product = args[:product] if args.key?(:product)
3330
3606
  @variant_rollup_values = args[:variant_rollup_values] if args.key?(:variant_rollup_values)
3331
3607
  end
@@ -3867,6 +4143,31 @@ module Google
3867
4143
  end
3868
4144
  end
3869
4145
 
4146
+ # A BigQuery output result.
4147
+ class GoogleCloudRetailV2alphaBigQueryOutputResult
4148
+ include Google::Apis::Core::Hashable
4149
+
4150
+ # The ID of a BigQuery Dataset.
4151
+ # Corresponds to the JSON property `datasetId`
4152
+ # @return [String]
4153
+ attr_accessor :dataset_id
4154
+
4155
+ # The ID of a BigQuery Table.
4156
+ # Corresponds to the JSON property `tableId`
4157
+ # @return [String]
4158
+ attr_accessor :table_id
4159
+
4160
+ def initialize(**args)
4161
+ update!(**args)
4162
+ end
4163
+
4164
+ # Update properties of this object
4165
+ def update!(**args)
4166
+ @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
4167
+ @table_id = args[:table_id] if args.key?(:table_id)
4168
+ end
4169
+ end
4170
+
3870
4171
  # Metadata associated with a create operation.
3871
4172
  class GoogleCloudRetailV2alphaCreateModelMetadata
3872
4173
  include Google::Apis::Core::Hashable
@@ -3951,6 +4252,11 @@ module Google
3951
4252
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig]
3952
4253
  attr_accessor :errors_config
3953
4254
 
4255
+ # Output result.
4256
+ # Corresponds to the JSON property `outputResult`
4257
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult]
4258
+ attr_accessor :output_result
4259
+
3954
4260
  def initialize(**args)
3955
4261
  update!(**args)
3956
4262
  end
@@ -3959,6 +4265,7 @@ module Google
3959
4265
  def update!(**args)
3960
4266
  @error_samples = args[:error_samples] if args.key?(:error_samples)
3961
4267
  @errors_config = args[:errors_config] if args.key?(:errors_config)
4268
+ @output_result = args[:output_result] if args.key?(:output_result)
3962
4269
  end
3963
4270
  end
3964
4271
 
@@ -3978,6 +4285,11 @@ module Google
3978
4285
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig]
3979
4286
  attr_accessor :errors_config
3980
4287
 
4288
+ # Output result.
4289
+ # Corresponds to the JSON property `outputResult`
4290
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult]
4291
+ attr_accessor :output_result
4292
+
3981
4293
  def initialize(**args)
3982
4294
  update!(**args)
3983
4295
  end
@@ -3986,6 +4298,7 @@ module Google
3986
4298
  def update!(**args)
3987
4299
  @error_samples = args[:error_samples] if args.key?(:error_samples)
3988
4300
  @errors_config = args[:errors_config] if args.key?(:errors_config)
4301
+ @output_result = args[:output_result] if args.key?(:output_result)
3989
4302
  end
3990
4303
  end
3991
4304
 
@@ -4064,6 +4377,11 @@ module Google
4064
4377
  # @return [Fixnum]
4065
4378
  attr_accessor :success_count
4066
4379
 
4380
+ # Metadata related to transform user events operation.
4381
+ # Corresponds to the JSON property `transformedUserEventsMetadata`
4382
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaTransformedUserEventsMetadata]
4383
+ attr_accessor :transformed_user_events_metadata
4384
+
4067
4385
  # Operation last update time. If the operation is done, this is also the finish
4068
4386
  # time.
4069
4387
  # Corresponds to the JSON property `updateTime`
@@ -4081,6 +4399,7 @@ module Google
4081
4399
  @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
4082
4400
  @request_id = args[:request_id] if args.key?(:request_id)
4083
4401
  @success_count = args[:success_count] if args.key?(:success_count)
4402
+ @transformed_user_events_metadata = args[:transformed_user_events_metadata] if args.key?(:transformed_user_events_metadata)
4084
4403
  @update_time = args[:update_time] if args.key?(:update_time)
4085
4404
  end
4086
4405
  end
@@ -4167,8 +4486,8 @@ module Google
4167
4486
  attr_accessor :data_state
4168
4487
 
4169
4488
  # Required. The display name of the model. Should be human readable, used to
4170
- # display Recommendation Models in the Retail Pantheon Dashboard. UTF-8 encoded
4171
- # string with limit of 1024 characters.
4489
+ # display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8
4490
+ # encoded string with limit of 1024 characters.
4172
4491
  # Corresponds to the JSON property `displayName`
4173
4492
  # @return [String]
4174
4493
  attr_accessor :display_name
@@ -4215,6 +4534,12 @@ module Google
4215
4534
  # @return [String]
4216
4535
  attr_accessor :periodic_tuning_state
4217
4536
 
4537
+ # Output only. The list of valid serving configs associated with the
4538
+ # PageOptimizationConfig.
4539
+ # Corresponds to the JSON property `servingConfigLists`
4540
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelServingConfigList>]
4541
+ attr_accessor :serving_config_lists
4542
+
4218
4543
  # Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
4219
4544
  # Corresponds to the JSON property `servingState`
4220
4545
  # @return [String]
@@ -4266,6 +4591,7 @@ module Google
4266
4591
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
4267
4592
  @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
4268
4593
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
4594
+ @serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
4269
4595
  @serving_state = args[:serving_state] if args.key?(:serving_state)
4270
4596
  @training_state = args[:training_state] if args.key?(:training_state)
4271
4597
  @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
@@ -4371,6 +4697,46 @@ module Google
4371
4697
  end
4372
4698
  end
4373
4699
 
4700
+ # Represents an ordered combination of valid serving configs, which / may be
4701
+ # used for PAGE_OPTIMIZATION recommendations.
4702
+ class GoogleCloudRetailV2alphaModelServingConfigList
4703
+ include Google::Apis::Core::Hashable
4704
+
4705
+ # Optional. A set of valid serving configs that may be used for
4706
+ # PAGE_OPTIMIZATION.
4707
+ # Corresponds to the JSON property `servingConfigIds`
4708
+ # @return [Array<String>]
4709
+ attr_accessor :serving_config_ids
4710
+
4711
+ def initialize(**args)
4712
+ update!(**args)
4713
+ end
4714
+
4715
+ # Update properties of this object
4716
+ def update!(**args)
4717
+ @serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
4718
+ end
4719
+ end
4720
+
4721
+ # Output result.
4722
+ class GoogleCloudRetailV2alphaOutputResult
4723
+ include Google::Apis::Core::Hashable
4724
+
4725
+ # Export result in BigQuery.
4726
+ # Corresponds to the JSON property `bigqueryResult`
4727
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaBigQueryOutputResult>]
4728
+ attr_accessor :bigquery_result
4729
+
4730
+ def initialize(**args)
4731
+ update!(**args)
4732
+ end
4733
+
4734
+ # Update properties of this object
4735
+ def update!(**args)
4736
+ @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
4737
+ end
4738
+ end
4739
+
4374
4740
  # Metadata related to the progress of the Purge operation. This will be returned
4375
4741
  # by the google.longrunning.Operation.metadata field.
4376
4742
  class GoogleCloudRetailV2alphaPurgeMetadata
@@ -4595,6 +4961,32 @@ module Google
4595
4961
  end
4596
4962
  end
4597
4963
 
4964
+ # Metadata related to transform user events operation.
4965
+ class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
4966
+ include Google::Apis::Core::Hashable
4967
+
4968
+ # Count of entries in the source user events BigQuery table.
4969
+ # Corresponds to the JSON property `sourceEventsCount`
4970
+ # @return [Fixnum]
4971
+ attr_accessor :source_events_count
4972
+
4973
+ # Count of entries in the transformed user events BigQuery table, which could be
4974
+ # different from the actually imported number of user events.
4975
+ # Corresponds to the JSON property `transformedEventsCount`
4976
+ # @return [Fixnum]
4977
+ attr_accessor :transformed_events_count
4978
+
4979
+ def initialize(**args)
4980
+ update!(**args)
4981
+ end
4982
+
4983
+ # Update properties of this object
4984
+ def update!(**args)
4985
+ @source_events_count = args[:source_events_count] if args.key?(:source_events_count)
4986
+ @transformed_events_count = args[:transformed_events_count] if args.key?(:transformed_events_count)
4987
+ end
4988
+ end
4989
+
4598
4990
  # Metadata associated with a tune operation.
4599
4991
  class GoogleCloudRetailV2alphaTuneModelMetadata
4600
4992
  include Google::Apis::Core::Hashable
@@ -4715,6 +5107,31 @@ module Google
4715
5107
  end
4716
5108
  end
4717
5109
 
5110
+ # A BigQuery output result.
5111
+ class GoogleCloudRetailV2betaBigQueryOutputResult
5112
+ include Google::Apis::Core::Hashable
5113
+
5114
+ # The ID of a BigQuery Dataset.
5115
+ # Corresponds to the JSON property `datasetId`
5116
+ # @return [String]
5117
+ attr_accessor :dataset_id
5118
+
5119
+ # The ID of a BigQuery Table.
5120
+ # Corresponds to the JSON property `tableId`
5121
+ # @return [String]
5122
+ attr_accessor :table_id
5123
+
5124
+ def initialize(**args)
5125
+ update!(**args)
5126
+ end
5127
+
5128
+ # Update properties of this object
5129
+ def update!(**args)
5130
+ @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
5131
+ @table_id = args[:table_id] if args.key?(:table_id)
5132
+ end
5133
+ end
5134
+
4718
5135
  # Configuration of destination for Export related errors.
4719
5136
  class GoogleCloudRetailV2betaExportErrorsConfig
4720
5137
  include Google::Apis::Core::Hashable
@@ -4779,6 +5196,11 @@ module Google
4779
5196
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig]
4780
5197
  attr_accessor :errors_config
4781
5198
 
5199
+ # Output result.
5200
+ # Corresponds to the JSON property `outputResult`
5201
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult]
5202
+ attr_accessor :output_result
5203
+
4782
5204
  def initialize(**args)
4783
5205
  update!(**args)
4784
5206
  end
@@ -4787,6 +5209,7 @@ module Google
4787
5209
  def update!(**args)
4788
5210
  @error_samples = args[:error_samples] if args.key?(:error_samples)
4789
5211
  @errors_config = args[:errors_config] if args.key?(:errors_config)
5212
+ @output_result = args[:output_result] if args.key?(:output_result)
4790
5213
  end
4791
5214
  end
4792
5215
 
@@ -4806,6 +5229,11 @@ module Google
4806
5229
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig]
4807
5230
  attr_accessor :errors_config
4808
5231
 
5232
+ # Output result.
5233
+ # Corresponds to the JSON property `outputResult`
5234
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult]
5235
+ attr_accessor :output_result
5236
+
4809
5237
  def initialize(**args)
4810
5238
  update!(**args)
4811
5239
  end
@@ -4814,6 +5242,7 @@ module Google
4814
5242
  def update!(**args)
4815
5243
  @error_samples = args[:error_samples] if args.key?(:error_samples)
4816
5244
  @errors_config = args[:errors_config] if args.key?(:errors_config)
5245
+ @output_result = args[:output_result] if args.key?(:output_result)
4817
5246
  end
4818
5247
  end
4819
5248
 
@@ -4974,6 +5403,25 @@ module Google
4974
5403
  end
4975
5404
  end
4976
5405
 
5406
+ # Output result.
5407
+ class GoogleCloudRetailV2betaOutputResult
5408
+ include Google::Apis::Core::Hashable
5409
+
5410
+ # Export result in BigQuery.
5411
+ # Corresponds to the JSON property `bigqueryResult`
5412
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2betaBigQueryOutputResult>]
5413
+ attr_accessor :bigquery_result
5414
+
5415
+ def initialize(**args)
5416
+ update!(**args)
5417
+ end
5418
+
5419
+ # Update properties of this object
5420
+ def update!(**args)
5421
+ @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
5422
+ end
5423
+ end
5424
+
4977
5425
  # Metadata related to the progress of the Purge operation. This will be returned
4978
5426
  # by the google.longrunning.Operation.metadata field.
4979
5427
  class GoogleCloudRetailV2betaPurgeMetadata