Google Cloud Retail V2 Client - Class CompletionDetail (1.0.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class CompletionDetail.

Detailed completion information including completion attribution token and clicked completion info.

Generated from protobuf message google.cloud.retail.v2.CompletionDetail

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ completion_attribution_token string

Completion attribution token in CompleteQueryResponse.attribution_token.

↳ selected_suggestion string

End user selected CompleteQueryResponse.CompletionResult.suggestion.

↳ selected_position int

End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.

getCompletionAttributionToken

Completion attribution token in CompleteQueryResponse.attribution_token.

Generated from protobuf field string completion_attribution_token = 1;

Returns
TypeDescription
string

setCompletionAttributionToken

Completion attribution token in CompleteQueryResponse.attribution_token.

Generated from protobuf field string completion_attribution_token = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSelectedSuggestion

End user selected CompleteQueryResponse.CompletionResult.suggestion.

Generated from protobuf field string selected_suggestion = 2;

Returns
TypeDescription
string

setSelectedSuggestion

End user selected CompleteQueryResponse.CompletionResult.suggestion.

Generated from protobuf field string selected_suggestion = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSelectedPosition

End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.

Generated from protobuf field int32 selected_position = 3;

Returns
TypeDescription
int

setSelectedPosition

End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.

Generated from protobuf field int32 selected_position = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this