Class GoogleCloudRetailV2Control

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

Inheritance

object

GoogleCloudRetailV2Control

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudRetail.v2.Data

Assembly: Google.Apis.CloudRetail.v2.dll

Syntax

public class GoogleCloudRetailV2Control : IDirectResponseSchema

Properties

AssociatedServingConfigIds

Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

Declaration

[JsonProperty("associatedServingConfigIds")]
public virtual IList<string> AssociatedServingConfigIds { get; set; }

Property Value

Type	Description
IList<string>

DisplayName

Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Name

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Rule

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

Declaration

[JsonProperty("rule")]
public virtual GoogleCloudRetailV2Rule Rule { get; set; }

Property Value

Type	Description
GoogleCloudRetailV2Rule

SearchSolutionUseCase

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

Declaration

[JsonProperty("searchSolutionUseCase")]
public virtual IList<string> SearchSolutionUseCase { get; set; }

Property Value

Type	Description
IList<string>

SolutionTypes

Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

Declaration

[JsonProperty("solutionTypes")]
public virtual IList<string> SolutionTypes { get; set; }

Property Value

Type	Description
IList<string>

Implements

IDirectResponseSchema