Class GoogleCloudRetailV2SearchResponse

Response message for SearchService.Search method.

Inheritance

object

GoogleCloudRetailV2SearchResponse

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 GoogleCloudRetailV2SearchResponse : IDirectResponseSchema

Properties

AppliedControls

The fully qualified resource name of applied controls.

Declaration

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

Property Value

Type	Description
IList<string>

AttributionToken

A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.

Declaration

[JsonProperty("attributionToken")]
public virtual string AttributionToken { get; set; }

Property Value

Type	Description
string

ConversationalSearchResult

This field specifies all related information that is needed on client side for UI rendering of conversational retail search.

Declaration

[JsonProperty("conversationalSearchResult")]
public virtual GoogleCloudRetailV2SearchResponseConversationalSearchResult ConversationalSearchResult { get; set; }

Property Value

Type	Description
GoogleCloudRetailV2SearchResponseConversationalSearchResult

CorrectedQuery

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 is used for search.

Declaration

[JsonProperty("correctedQuery")]
public virtual string CorrectedQuery { 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

ExperimentInfo

Metadata related to A/B testing Experiment associated with this response. Only exists when an experiment is triggered.

Declaration

[JsonProperty("experimentInfo")]
public virtual IList<GoogleCloudRetailV2ExperimentInfo> ExperimentInfo { get; set; }

Property Value

Type	Description
IList<GoogleCloudRetailV2ExperimentInfo>

Facets

Results of facets requested by user.

Declaration

[JsonProperty("facets")]
public virtual IList<GoogleCloudRetailV2SearchResponseFacet> Facets { get; set; }

Property Value

Type	Description
IList<GoogleCloudRetailV2SearchResponseFacet>

InvalidConditionBoostSpecs

The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.

Declaration

[JsonProperty("invalidConditionBoostSpecs")]
public virtual IList<GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec> InvalidConditionBoostSpecs { get; set; }

Property Value

Type	Description
IList<GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec>

NextPageToken

A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Declaration

[JsonProperty("nextPageToken")]
public virtual string NextPageToken { get; set; }

Property Value

Type	Description
string

PinControlMetadata

Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.

Declaration

[JsonProperty("pinControlMetadata")]
public virtual GoogleCloudRetailV2PinControlMetadata PinControlMetadata { get; set; }

Property Value

Type	Description
GoogleCloudRetailV2PinControlMetadata

QueryExpansionInfo

Query expansion information for the returned results.

Declaration

[JsonProperty("queryExpansionInfo")]
public virtual GoogleCloudRetailV2SearchResponseQueryExpansionInfo QueryExpansionInfo { get; set; }

Property Value

Type	Description
GoogleCloudRetailV2SearchResponseQueryExpansionInfo

RedirectUri

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.

Declaration

[JsonProperty("redirectUri")]
public virtual string RedirectUri { get; set; }

Property Value

Type	Description
string

Results

A list of matched items. The order represents the ranking.

Declaration

[JsonProperty("results")]
public virtual IList<GoogleCloudRetailV2SearchResponseSearchResult> Results { get; set; }

Property Value

Type	Description
IList<GoogleCloudRetailV2SearchResponseSearchResult>

TileNavigationResult

This field specifies all related information for tile navigation that will be used in client side.

Declaration

[JsonProperty("tileNavigationResult")]
public virtual GoogleCloudRetailV2SearchResponseTileNavigationResult TileNavigationResult { get; set; }

Property Value

Type	Description
GoogleCloudRetailV2SearchResponseTileNavigationResult

TotalSize

The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.

Declaration

[JsonProperty("totalSize")]
public virtual int? TotalSize { get; set; }

Property Value

Type	Description
int?

Implements

IDirectResponseSchema