google-apis-retail_v2 0.46.0 → 0.49.0

data/lib/google/apis/retail_v2/classes.rb

@@ -279,6 +279,26 @@ module Google
         end
       end
       
+      # Request for CatalogService.AddCatalogAttribute method.
+      class GoogleCloudRetailV2AddCatalogAttributeRequest
+        include Google::Apis::Core::Hashable
+      
+        # Catalog level attribute config for an attribute. For example, if customers
+        # want to enable/disable facet for a specific attribute.
+        # Corresponds to the JSON property `catalogAttribute`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute]
+        attr_accessor :catalog_attribute
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @catalog_attribute = args[:catalog_attribute] if args.key?(:catalog_attribute)
+        end
+      end
+      
       # Metadata related to the progress of the AddFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
       # ProductService.AddFulfillmentPlaces method.
@@ -446,6 +466,42 @@ module Google
         end
       end
       
+      # Catalog level attribute config.
+      class GoogleCloudRetailV2AttributesConfig
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The AttributeConfigLevel used for this catalog.
+        # Corresponds to the JSON property `attributeConfigLevel`
+        # @return [String]
+        attr_accessor :attribute_config_level
+      
+        # Enable attribute(s) config at catalog level. For example, indexable,
+        # dynamic_facetable, or searchable for each attribute. The key is catalog
+        # attribute's name. For example: `color`, `brands`, `attributes.custom_attribute`
+        # , such as `attributes.xyz`. The maximum number of catalog attributes allowed
+        # in a request is 1000.
+        # Corresponds to the JSON property `catalogAttributes`
+        # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute>]
+        attr_accessor :catalog_attributes
+      
+        # Required. Immutable. The fully qualified resource name of the attribute config.
+        # Format: `projects/*/locations/*/catalogs/*/attributesConfig`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @attribute_config_level = args[:attribute_config_level] if args.key?(:attribute_config_level)
+          @catalog_attributes = args[:catalog_attributes] if args.key?(:catalog_attributes)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
       # An intended audience of the Product for whom it's sold.
       class GoogleCloudRetailV2Audience
         include Google::Apis::Core::Hashable
@@ -495,12 +551,11 @@ module Google
         # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
         # imports: * `user_event` (default): One JSON UserEvent per line. * `
         # user_event_ga360`: The schema is available here: https://support.google.com/
-        # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
-        # preview. Please contact the support team for importing Google Analytics 4
-        # events. The schema is available here: https://support.google.com/analytics/
-        # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
-        # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
-        # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
+        # analytics/answer/3437719. * `user_event_ga4`: The schema is available here:
+        # https://support.google.com/analytics/answer/7029846. Supported values for auto-
+        # completion imports: * `suggestions` (default): One JSON completion suggestion
+        # per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One
+        # JSON allow suggestion per line.
         # Corresponds to the JSON property `dataSchema`
         # @return [String]
         attr_accessor :data_schema
@@ -592,6 +647,79 @@ module Google
         end
       end
       
+      # Catalog level attribute config for an attribute. For example, if customers
+      # want to enable/disable facet for a specific attribute.
+      class GoogleCloudRetailV2CatalogAttribute
+        include Google::Apis::Core::Hashable
+      
+        # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet.
+        # Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option
+        # is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
+        # Corresponds to the JSON property `dynamicFacetableOption`
+        # @return [String]
+        attr_accessor :dynamic_facetable_option
+      
+        # Output only. Indicates whether this attribute has been used by any products. `
+        # True` if at least one Product is using this attribute in Product.attributes.
+        # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
+        # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
+        # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
+        # loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither
+        # in use by products nor predefined can be deleted. CatalogAttributes that are
+        # either in use by products or are predefined cannot be deleted; however, their
+        # configuration properties will reset to default values upon removal request.
+        # After catalog changes, it takes about 10 minutes for this field to update.
+        # Corresponds to the JSON property `inUse`
+        # @return [Boolean]
+        attr_accessor :in_use
+        alias_method :in_use?, :in_use
+      
+        # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
+        # if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered,
+        # faceted, or boosted in SearchService.Search.
+        # Corresponds to the JSON property `indexableOption`
+        # @return [String]
+        attr_accessor :indexable_option
+      
+        # Required. Attribute name. For example: `color`, `brands`, `attributes.
+        # custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute
+        # name can contain only alpha-numeric characters and underscores. For example,
+        # an attribute named `attributes.abc_xyz` can be indexed, but an attribute named
+        # `attributes.abc-xyz` cannot be indexed.
+        # Corresponds to the JSON property `key`
+        # @return [String]
+        attr_accessor :key
+      
+        # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
+        # if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
+        # SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
+        # attribute values will not be searchable by text queries in SearchService.
+        # Search, as there are no text values associated to numerical attributes.
+        # Corresponds to the JSON property `searchableOption`
+        # @return [String]
+        attr_accessor :searchable_option
+      
+        # Output only. The type of this attribute. This is derived from the attribute in
+        # Product.attributes.
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
+          @in_use = args[:in_use] if args.key?(:in_use)
+          @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
+          @key = args[:key] if args.key?(:key)
+          @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
       # The color information of a Product.
       class GoogleCloudRetailV2ColorInfo
         include Google::Apis::Core::Hashable
@@ -680,9 +808,8 @@ module Google
       
         # Custom attributes for the suggestion term. * For "user-data", the attributes
         # are additional custom attributes ingested through BigQuery. * For "cloud-
-        # retail", the attributes are product attributes generated by Cloud Retail. This
-        # is an experimental feature. Contact Retail Search support team if you are
-        # interested in enabling it.
+        # retail", the attributes are product attributes generated by Cloud Retail. It
+        # requires UserEvent.product_details is imported properly.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
         attr_accessor :attributes
@@ -722,6 +849,105 @@ module Google
         end
       end
       
+      # Catalog level autocomplete config for customers to customize autocomplete
+      # feature's settings.
+      class GoogleCloudRetailV2CompletionConfig
+        include Google::Apis::Core::Hashable
+      
+        # The input config source for completion data.
+        # Corresponds to the JSON property `allowlistInputConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
+        attr_accessor :allowlist_input_config
+      
+        # If set to true, the auto learning function is enabled. Auto learning uses user
+        # data to generate suggestions using ML techniques. Default value is false. Only
+        # after enabling auto learning can users use `cloud-retail` data in
+        # CompleteQueryRequest.
+        # Corresponds to the JSON property `autoLearning`
+        # @return [Boolean]
+        attr_accessor :auto_learning
+        alias_method :auto_learning?, :auto_learning
+      
+        # The input config source for completion data.
+        # Corresponds to the JSON property `denylistInputConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
+        attr_accessor :denylist_input_config
+      
+        # Output only. Name of the LRO corresponding to the latest allowlist import. Can
+        # use GetOperation API to retrieve the latest state of the Long Running
+        # Operation.
+        # Corresponds to the JSON property `lastAllowlistImportOperation`
+        # @return [String]
+        attr_accessor :last_allowlist_import_operation
+      
+        # Output only. Name of the LRO corresponding to the latest denylist import. Can
+        # use GetOperation API to retrieve the latest state of the Long Running
+        # Operation.
+        # Corresponds to the JSON property `lastDenylistImportOperation`
+        # @return [String]
+        attr_accessor :last_denylist_import_operation
+      
+        # Output only. Name of the LRO corresponding to the latest suggestion terms list
+        # import. Can use GetOperation API to retrieve the latest state of the Long
+        # Running Operation.
+        # Corresponds to the JSON property `lastSuggestionsImportOperation`
+        # @return [String]
+        attr_accessor :last_suggestions_import_operation
+      
+        # Specifies the matching order for autocomplete suggestions, e.g., a query
+        # consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes",
+        # whereas a query of 'red s' with 'exact-prefix' specified would suggest "red
+        # shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default
+        # value: 'exact-prefix'.
+        # Corresponds to the JSON property `matchingOrder`
+        # @return [String]
+        attr_accessor :matching_order
+      
+        # The maximum number of autocomplete suggestions returned per term. Default
+        # value is 20. If left unset or set to 0, then will fallback to default value.
+        # Value range is 1 to 20.
+        # Corresponds to the JSON property `maxSuggestions`
+        # @return [Fixnum]
+        attr_accessor :max_suggestions
+      
+        # The minimum number of characters needed to be typed in order to get
+        # suggestions. Default value is 2. If left unset or set to 0, then will fallback
+        # to default value. Value range is 1 to 20.
+        # Corresponds to the JSON property `minPrefixLength`
+        # @return [Fixnum]
+        attr_accessor :min_prefix_length
+      
+        # Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/
+        # completionConfig`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # The input config source for completion data.
+        # Corresponds to the JSON property `suggestionsInputConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
+        attr_accessor :suggestions_input_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
+          @auto_learning = args[:auto_learning] if args.key?(:auto_learning)
+          @denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
+          @last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
+          @last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
+          @last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
+          @matching_order = args[:matching_order] if args.key?(:matching_order)
+          @max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
+          @min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
+          @name = args[:name] if args.key?(:name)
+          @suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
+        end
+      end
+      
       # The input config source for completion data.
       class GoogleCloudRetailV2CompletionDataInputConfig
         include Google::Apis::Core::Hashable
@@ -1121,11 +1347,9 @@ module Google
         # the import is finished, a notification will be sent to specified Pub/Sub topic.
         # The message data will be JSON string of a Operation. Format of the Pub/Sub
         # topic is `projects/`project`/topics/`topic``. It has to be within the same
-        # project as ImportProductsRequest.parent. Make sure that both `cloud-retail-
-        # customer-data-access@system.gserviceaccount.com` and `service-@gcp-sa-retail.
-        # iam.gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on
-        # the topic. Only supported when ImportProductsRequest.reconciliation_mode is
-        # set to `FULL`.
+        # project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-
+        # retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission
+        # on the topic.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic
@@ -1411,7 +1635,7 @@ module Google
         # in `PredictRequest.params` to receive empty results instead. Note that the API
         # will never return items with storageStatus of "EXPIRED" or "DELETED"
         # regardless of filter choices. If `filterSyntaxV2` is set to true under the `
-        # params` field, then attribute based expressions are expected instead of the
+        # params` field, then attribute-based expressions are expected instead of the
         # above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND
         # NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors:
         # ANY("Red") OR categories: ANY("Phones"))
@@ -1442,7 +1666,7 @@ module Google
         # @return [Fixnum]
         attr_accessor :page_size
       
-        # This field is not used for now, please leave it unset.
+        # This field is not used for now, leave it unset.
         # Corresponds to the JSON property `pageToken`
         # @return [String]
         attr_accessor :page_token
@@ -1464,8 +1688,8 @@ module Google
         # it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
         # high-diversity', 'auto-diversity'`. This gives request-level control and
         # adjusts prediction results based on product category. * `filterSyntaxV2`:
-        # Boolean. False by default. If set to true, the `filter` field will be
-        # interpreteted according to the new, attribute-based syntax.
+        # Boolean. False by default. If set to true, the `filter` field is interpreteted
+        # according to the new, attribute-based syntax.
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
@@ -1749,7 +1973,7 @@ module Google
       
         # The id of the collection members when type is Type.COLLECTION. Non-existent
         # product ids are allowed. The type of the members must be either Type.PRIMARY
-        # or Type.VARIANT otherwise and INVALID_ARGUMENT error is thrown. Should not set
+        # or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set
         # it for other types. A maximum of 1000 values are allowed. Otherwise, an
         # INVALID_ARGUMENT error is return.
         # Corresponds to the JSON property `collectionMemberIds`
@@ -2401,6 +2625,25 @@ module Google
         end
       end
       
+      # Request for CatalogService.RemoveCatalogAttribute method.
+      class GoogleCloudRetailV2RemoveCatalogAttributeRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The attribute name key of the CatalogAttribute to remove.
+        # Corresponds to the JSON property `key`
+        # @return [String]
+        attr_accessor :key
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @key = args[:key] if args.key?(:key)
+        end
+      end
+      
       # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
       # ProductService.RemoveFulfillmentPlaces method.
@@ -3011,6 +3254,13 @@ module Google
         # @return [Array<String>]
         attr_accessor :restricted_values
       
+        # Returns the min and max value for each numerical facet intervals. Ignored for
+        # textual facets.
+        # Corresponds to the JSON property `returnMinMax`
+        # @return [Boolean]
+        attr_accessor :return_min_max
+        alias_method :return_min_max?, :return_min_max
+      
         def initialize(**args)
            update!(**args)
         end
@@ -3025,6 +3275,7 @@ module Google
           @prefixes = args[:prefixes] if args.key?(:prefixes)
           @query = args[:query] if args.key?(:query)
           @restricted_values = args[:restricted_values] if args.key?(:restricted_values)
+          @return_min_max = args[:return_min_max] if args.key?(:return_min_max)
         end
       end
       
@@ -3115,7 +3366,7 @@ module Google
       
         # Contains the spell corrected query, if found. If the spell correction type is
         # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
-        # original query will be used for search.
+        # original query is used for search.
         # Corresponds to the JSON property `correctedQuery`
         # @return [String]
         attr_accessor :corrected_query
@@ -3227,6 +3478,18 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Interval]
         attr_accessor :interval
       
+        # The maximum value in the FacetValue.interval. Only supported on numerical
+        # facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
+        # Corresponds to the JSON property `maxValue`
+        # @return [Float]
+        attr_accessor :max_value
+      
+        # The minimum value in the FacetValue.interval. Only supported on numerical
+        # facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
+        # Corresponds to the JSON property `minValue`
+        # @return [Float]
+        attr_accessor :min_value
+      
         # Text value of a facet, such as "Black" for facet "colorFamilies".
         # Corresponds to the JSON property `value`
         # @return [String]
@@ -3240,6 +3503,8 @@ module Google
         def update!(**args)
           @count = args[:count] if args.key?(:count)
           @interval = args[:interval] if args.key?(:interval)
+          @max_value = args[:max_value] if args.key?(:max_value)
+          @min_value = args[:min_value] if args.key?(:min_value)
           @value = args[:value] if args.key?(:value)
         end
       end
@@ -3295,6 +3560,15 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :matching_variant_fields
       
+        # Specifies previous events related to this product for this user based on
+        # UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set
+        # only when SearchRequest.PersonalizationSpec.mode is SearchRequest.
+        # PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that
+        # this product has been purchased before.
+        # Corresponds to the JSON property `personalLabels`
+        # @return [Array<String>]
+        attr_accessor :personal_labels
+      
         # Product captures all metadata information of items to be recommended or
         # searched.
         # Corresponds to the JSON property `product`
@@ -3327,6 +3601,7 @@ module Google
           @id = args[:id] if args.key?(:id)
           @matching_variant_count = args[:matching_variant_count] if args.key?(:matching_variant_count)
           @matching_variant_fields = args[:matching_variant_fields] if args.key?(:matching_variant_fields)
+          @personal_labels = args[:personal_labels] if args.key?(:personal_labels)
           @product = args[:product] if args.key?(:product)
           @variant_rollup_values = args[:variant_rollup_values] if args.key?(:variant_rollup_values)
         end
@@ -3868,6 +4143,51 @@ module Google
         end
       end
       
+      # A BigQuery output result.
+      class GoogleCloudRetailV2alphaBigQueryOutputResult
+        include Google::Apis::Core::Hashable
+      
+        # The ID of a BigQuery Dataset.
+        # Corresponds to the JSON property `datasetId`
+        # @return [String]
+        attr_accessor :dataset_id
+      
+        # The ID of a BigQuery Table.
+        # Corresponds to the JSON property `tableId`
+        # @return [String]
+        attr_accessor :table_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
+          @table_id = args[:table_id] if args.key?(:table_id)
+        end
+      end
+      
+      # Metadata associated with a create operation.
+      class GoogleCloudRetailV2alphaCreateModelMetadata
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the model that this create applies to. Format: projects/`
+        # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # Corresponds to the JSON property `model`
+        # @return [String]
+        attr_accessor :model
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @model = args[:model] if args.key?(:model)
+        end
+      end
+      
       # Configuration of destination for Export related errors.
       class GoogleCloudRetailV2alphaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -3932,6 +4252,11 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig]
         attr_accessor :errors_config
       
+        # Output result.
+        # Corresponds to the JSON property `outputResult`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult]
+        attr_accessor :output_result
+      
         def initialize(**args)
            update!(**args)
         end
@@ -3940,6 +4265,7 @@ module Google
         def update!(**args)
           @error_samples = args[:error_samples] if args.key?(:error_samples)
           @errors_config = args[:errors_config] if args.key?(:errors_config)
+          @output_result = args[:output_result] if args.key?(:output_result)
         end
       end
       
@@ -3959,6 +4285,11 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig]
         attr_accessor :errors_config
       
+        # Output result.
+        # Corresponds to the JSON property `outputResult`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult]
+        attr_accessor :output_result
+      
         def initialize(**args)
            update!(**args)
         end
@@ -3967,6 +4298,7 @@ module Google
         def update!(**args)
           @error_samples = args[:error_samples] if args.key?(:error_samples)
           @errors_config = args[:errors_config] if args.key?(:errors_config)
+          @output_result = args[:output_result] if args.key?(:output_result)
         end
       end
       
@@ -4045,6 +4377,11 @@ module Google
         # @return [Fixnum]
         attr_accessor :success_count
       
+        # Metadata related to transform user events operation.
+        # Corresponds to the JSON property `transformedUserEventsMetadata`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaTransformedUserEventsMetadata]
+        attr_accessor :transformed_user_events_metadata
+      
         # Operation last update time. If the operation is done, this is also the finish
         # time.
         # Corresponds to the JSON property `updateTime`
@@ -4062,6 +4399,7 @@ module Google
           @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
           @request_id = args[:request_id] if args.key?(:request_id)
           @success_count = args[:success_count] if args.key?(:success_count)
+          @transformed_user_events_metadata = args[:transformed_user_events_metadata] if args.key?(:transformed_user_events_metadata)
           @update_time = args[:update_time] if args.key?(:update_time)
         end
       end
@@ -4127,6 +4465,278 @@ module Google
         end
       end
       
+      # Metadata that describes the training and serving parameters of a Model. A
+      # Model can be associated with a ServingConfig and then queried through the
+      # Predict api.
+      class GoogleCloudRetailV2alphaModel
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Timestamp the Recommendation Model was created at.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Output only. The state of data requirements for this model: DATA_OK and
+        # DATA_ERROR. Recommendation model cannot be trained if the data is in
+        # DATA_ERROR state. Recommendation model can have DATA_ERROR state even if
+        # serving state is ACTIVE: models were trained successfully before, but cannot
+        # be refreshed because model no longer has sufficient data for training.
+        # Corresponds to the JSON property `dataState`
+        # @return [String]
+        attr_accessor :data_state
+      
+        # Required. The display name of the model. Should be human readable, used to
+        # display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8
+        # encoded string with limit of 1024 characters.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by
+        # attributes is enabled for the model.
+        # Corresponds to the JSON property `filteringOption`
+        # @return [String]
+        attr_accessor :filtering_option
+      
+        # Output only. The timestamp when the latest successful tune finished.
+        # Corresponds to the JSON property `lastTuneTime`
+        # @return [String]
+        attr_accessor :last_tune_time
+      
+        # Required. The fully qualified resource name of the model. Format: projects/`
+        # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Optional. The optimization objective e.g. `cvr`. Currently supported values: `
+        # ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
+        # model type. Default depends on type of recommendation: `recommended-for-you` =>
+        # `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
+        # revenue_per_order`
+        # Corresponds to the JSON property `optimizationObjective`
+        # @return [String]
+        attr_accessor :optimization_objective
+      
+        # The PageOptimizationConfig for model training. This determines how many panels
+        # to optimize for, and which serving configurations to consider for each panel.
+        # The purpose of this model is to optimize which ServingConfig to show on which
+        # panels in way that optimizes the visitors shopping journey.
+        # Corresponds to the JSON property `pageOptimizationConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig]
+        attr_accessor :page_optimization_config
+      
+        # Optional. The state of periodic tuning. The period we use is 3 months - to do
+        # a one-off tune earlier use the TuneModel method. Default value is
+        # PERIODIC_TUNING_ENABLED.
+        # Corresponds to the JSON property `periodicTuningState`
+        # @return [String]
+        attr_accessor :periodic_tuning_state
+      
+        # Output only. The list of valid serving configs associated with the
+        # PageOptimizationConfig.
+        # Corresponds to the JSON property `servingConfigLists`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelServingConfigList>]
+        attr_accessor :serving_config_lists
+      
+        # Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
+        # Corresponds to the JSON property `servingState`
+        # @return [String]
+        attr_accessor :serving_state
+      
+        # Optional. The training state that the model is in (e.g. TRAINING or PAUSED).
+        # Since part of the cost of running the service is frequency of training - this
+        # can be used to determine when to train model in order to control cost. If not
+        # specified: the default value for CreateModel method is TRAINING. the default
+        # value for UpdateModel method is to keep the state the same as before.
+        # Corresponds to the JSON property `trainingState`
+        # @return [String]
+        attr_accessor :training_state
+      
+        # Output only. The tune operation associated with the model. Can be used to
+        # determine if there is an ongoing tune for this recommendation. Empty field
+        # implies no tune is goig on.
+        # Corresponds to the JSON property `tuningOperation`
+        # @return [String]
+        attr_accessor :tuning_operation
+      
+        # Required. The type of model e.g. `home-page`. Currently supported values: `
+        # recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
+        # page-optimization`, 'similar-items', 'buy-it-again', `recently-viewed`(
+        # readonly value).
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        # Output only. Timestamp the Recommendation Model was last updated. E.g. if a
+        # Recommendation Model was paused - this would be the time the pause was
+        # initiated.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @data_state = args[:data_state] if args.key?(:data_state)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
+          @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
+          @name = args[:name] if args.key?(:name)
+          @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
+          @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
+          @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
+          @serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
+          @serving_state = args[:serving_state] if args.key?(:serving_state)
+          @training_state = args[:training_state] if args.key?(:training_state)
+          @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
+          @type = args[:type] if args.key?(:type)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # The PageOptimizationConfig for model training. This determines how many panels
+      # to optimize for, and which serving configurations to consider for each panel.
+      # The purpose of this model is to optimize which ServingConfig to show on which
+      # panels in way that optimizes the visitors shopping journey.
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfig
+        include Google::Apis::Core::Hashable
+      
+        # Required. The type of UserEvent this page optimization is shown for. Each page
+        # has an associated event type - this will be the corresponding event type for
+        # the page that the page optimization model is used on. Supported types: * `add-
+        # to-cart`: Products being added to cart. * `detail-page-view`: Products detail
+        # page viewed. * `home-page-view`: Homepage viewed * `category-page-view`:
+        # Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `
+        # home-page-view` only allows models with type `recommended-for-you`. All other
+        # page_optimization_event_type allow all Model.types.
+        # Corresponds to the JSON property `pageOptimizationEventType`
+        # @return [String]
+        attr_accessor :page_optimization_event_type
+      
+        # Required. A list of panel configurations. Limit = 5.
+        # Corresponds to the JSON property `panels`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel>]
+        attr_accessor :panels
+      
+        # Optional. How to restrict results across panels e.g. can the same
+        # ServingConfig be shown on multiple panels at once. If unspecified, default to `
+        # UNIQUE_MODEL_RESTRICTION`.
+        # Corresponds to the JSON property `restriction`
+        # @return [String]
+        attr_accessor :restriction
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @page_optimization_event_type = args[:page_optimization_event_type] if args.key?(:page_optimization_event_type)
+          @panels = args[:panels] if args.key?(:panels)
+          @restriction = args[:restriction] if args.key?(:restriction)
+        end
+      end
+      
+      # A candidate to consider for a given panel. Currently only ServingConfig are
+      # valid candidates.
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
+        include Google::Apis::Core::Hashable
+      
+        # This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with
+        # full name: `projects/*/locations/global/catalogs/default_catalog/
+        # servingConfigs/my_candidate_config` this would be 'my_candidate_config'
+        # Corresponds to the JSON property `servingConfigId`
+        # @return [String]
+        attr_accessor :serving_config_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @serving_config_id = args[:serving_config_id] if args.key?(:serving_config_id)
+        end
+      end
+      
+      # An individual panel with a list of ServingConfigs to consider for it.
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
+        include Google::Apis::Core::Hashable
+      
+        # Required. The candidates to consider on the panel. Limit = 10.
+        # Corresponds to the JSON property `candidates`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate>]
+        attr_accessor :candidates
+      
+        # A candidate to consider for a given panel. Currently only ServingConfig are
+        # valid candidates.
+        # Corresponds to the JSON property `defaultCandidate`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate]
+        attr_accessor :default_candidate
+      
+        # Optional. The name to display for the panel.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @candidates = args[:candidates] if args.key?(:candidates)
+          @default_candidate = args[:default_candidate] if args.key?(:default_candidate)
+          @display_name = args[:display_name] if args.key?(:display_name)
+        end
+      end
+      
+      # Represents an ordered combination of valid serving configs, which / may be
+      # used for PAGE_OPTIMIZATION recommendations.
+      class GoogleCloudRetailV2alphaModelServingConfigList
+        include Google::Apis::Core::Hashable
+      
+        # Optional. A set of valid serving configs that may be used for
+        # PAGE_OPTIMIZATION.
+        # Corresponds to the JSON property `servingConfigIds`
+        # @return [Array<String>]
+        attr_accessor :serving_config_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
+        end
+      end
+      
+      # Output result.
+      class GoogleCloudRetailV2alphaOutputResult
+        include Google::Apis::Core::Hashable
+      
+        # Export result in BigQuery.
+        # Corresponds to the JSON property `bigqueryResult`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaBigQueryOutputResult>]
+        attr_accessor :bigquery_result
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
+        end
+      end
+      
       # Metadata related to the progress of the Purge operation. This will be returned
       # by the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2alphaPurgeMetadata
@@ -4351,6 +4961,65 @@ module Google
         end
       end
       
+      # Metadata related to transform user events operation.
+      class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Count of entries in the source user events BigQuery table.
+        # Corresponds to the JSON property `sourceEventsCount`
+        # @return [Fixnum]
+        attr_accessor :source_events_count
+      
+        # Count of entries in the transformed user events BigQuery table, which could be
+        # different from the actually imported number of user events.
+        # Corresponds to the JSON property `transformedEventsCount`
+        # @return [Fixnum]
+        attr_accessor :transformed_events_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @source_events_count = args[:source_events_count] if args.key?(:source_events_count)
+          @transformed_events_count = args[:transformed_events_count] if args.key?(:transformed_events_count)
+        end
+      end
+      
+      # Metadata associated with a tune operation.
+      class GoogleCloudRetailV2alphaTuneModelMetadata
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the model that this tune applies to. Format: projects/`
+        # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # Corresponds to the JSON property `model`
+        # @return [String]
+        attr_accessor :model
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @model = args[:model] if args.key?(:model)
+        end
+      end
+      
+      # Response associated with a tune operation.
+      class GoogleCloudRetailV2alphaTuneModelResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # A summary of import result. The UserEventImportSummary summarizes the import
       # status for user events.
       class GoogleCloudRetailV2alphaUserEventImportSummary
@@ -4438,6 +5107,31 @@ module Google
         end
       end
       
+      # A BigQuery output result.
+      class GoogleCloudRetailV2betaBigQueryOutputResult
+        include Google::Apis::Core::Hashable
+      
+        # The ID of a BigQuery Dataset.
+        # Corresponds to the JSON property `datasetId`
+        # @return [String]
+        attr_accessor :dataset_id
+      
+        # The ID of a BigQuery Table.
+        # Corresponds to the JSON property `tableId`
+        # @return [String]
+        attr_accessor :table_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
+          @table_id = args[:table_id] if args.key?(:table_id)
+        end
+      end
+      
       # Configuration of destination for Export related errors.
       class GoogleCloudRetailV2betaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -4502,6 +5196,11 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig]
         attr_accessor :errors_config
       
+        # Output result.
+        # Corresponds to the JSON property `outputResult`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult]
+        attr_accessor :output_result
+      
         def initialize(**args)
            update!(**args)
         end
@@ -4510,6 +5209,7 @@ module Google
         def update!(**args)
           @error_samples = args[:error_samples] if args.key?(:error_samples)
           @errors_config = args[:errors_config] if args.key?(:errors_config)
+          @output_result = args[:output_result] if args.key?(:output_result)
         end
       end
       
@@ -4529,6 +5229,11 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig]
         attr_accessor :errors_config
       
+        # Output result.
+        # Corresponds to the JSON property `outputResult`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult]
+        attr_accessor :output_result
+      
         def initialize(**args)
            update!(**args)
         end
@@ -4537,6 +5242,7 @@ module Google
         def update!(**args)
           @error_samples = args[:error_samples] if args.key?(:error_samples)
           @errors_config = args[:errors_config] if args.key?(:errors_config)
+          @output_result = args[:output_result] if args.key?(:output_result)
         end
       end
       
@@ -4697,6 +5403,25 @@ module Google
         end
       end
       
+      # Output result.
+      class GoogleCloudRetailV2betaOutputResult
+        include Google::Apis::Core::Hashable
+      
+        # Export result in BigQuery.
+        # Corresponds to the JSON property `bigqueryResult`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2betaBigQueryOutputResult>]
+        attr_accessor :bigquery_result
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
+        end
+      end
+      
       # Metadata related to the progress of the Purge operation. This will be returned
       # by the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2betaPurgeMetadata