Variables
CatalogAttribute_AttributeType_name, CatalogAttribute_AttributeType_value
var (
CatalogAttribute_AttributeType_name = map[int32]string{
0: "UNKNOWN",
1: "TEXTUAL",
2: "NUMERICAL",
}
CatalogAttribute_AttributeType_value = map[string]int32{
"UNKNOWN": 0,
"TEXTUAL": 1,
"NUMERICAL": 2,
}
)
Enum value maps for CatalogAttribute_AttributeType.
CatalogAttribute_IndexableOption_name, CatalogAttribute_IndexableOption_value
var (
CatalogAttribute_IndexableOption_name = map[int32]string{
0: "INDEXABLE_OPTION_UNSPECIFIED",
1: "INDEXABLE_ENABLED",
2: "INDEXABLE_DISABLED",
}
CatalogAttribute_IndexableOption_value = map[string]int32{
"INDEXABLE_OPTION_UNSPECIFIED": 0,
"INDEXABLE_ENABLED": 1,
"INDEXABLE_DISABLED": 2,
}
)
Enum value maps for CatalogAttribute_IndexableOption.
CatalogAttribute_DynamicFacetableOption_name, CatalogAttribute_DynamicFacetableOption_value
var (
CatalogAttribute_DynamicFacetableOption_name = map[int32]string{
0: "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED",
1: "DYNAMIC_FACETABLE_ENABLED",
2: "DYNAMIC_FACETABLE_DISABLED",
}
CatalogAttribute_DynamicFacetableOption_value = map[string]int32{
"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED": 0,
"DYNAMIC_FACETABLE_ENABLED": 1,
"DYNAMIC_FACETABLE_DISABLED": 2,
}
)
Enum value maps for CatalogAttribute_DynamicFacetableOption.
CatalogAttribute_SearchableOption_name, CatalogAttribute_SearchableOption_value
var (
CatalogAttribute_SearchableOption_name = map[int32]string{
0: "SEARCHABLE_OPTION_UNSPECIFIED",
1: "SEARCHABLE_ENABLED",
2: "SEARCHABLE_DISABLED",
}
CatalogAttribute_SearchableOption_value = map[string]int32{
"SEARCHABLE_OPTION_UNSPECIFIED": 0,
"SEARCHABLE_ENABLED": 1,
"SEARCHABLE_DISABLED": 2,
}
)
Enum value maps for CatalogAttribute_SearchableOption.
CatalogAttribute_ExactSearchableOption_name, CatalogAttribute_ExactSearchableOption_value
var (
CatalogAttribute_ExactSearchableOption_name = map[int32]string{
0: "EXACT_SEARCHABLE_OPTION_UNSPECIFIED",
1: "EXACT_SEARCHABLE_ENABLED",
2: "EXACT_SEARCHABLE_DISABLED",
}
CatalogAttribute_ExactSearchableOption_value = map[string]int32{
"EXACT_SEARCHABLE_OPTION_UNSPECIFIED": 0,
"EXACT_SEARCHABLE_ENABLED": 1,
"EXACT_SEARCHABLE_DISABLED": 2,
}
)
Enum value maps for CatalogAttribute_ExactSearchableOption.
CatalogAttribute_RetrievableOption_name, CatalogAttribute_RetrievableOption_value
var (
CatalogAttribute_RetrievableOption_name = map[int32]string{
0: "RETRIEVABLE_OPTION_UNSPECIFIED",
1: "RETRIEVABLE_ENABLED",
2: "RETRIEVABLE_DISABLED",
}
CatalogAttribute_RetrievableOption_value = map[string]int32{
"RETRIEVABLE_OPTION_UNSPECIFIED": 0,
"RETRIEVABLE_ENABLED": 1,
"RETRIEVABLE_DISABLED": 2,
}
)
Enum value maps for CatalogAttribute_RetrievableOption.
AttributeConfigLevel_name, AttributeConfigLevel_value
var (
AttributeConfigLevel_name = map[int32]string{
0: "ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED",
1: "PRODUCT_LEVEL_ATTRIBUTE_CONFIG",
2: "CATALOG_LEVEL_ATTRIBUTE_CONFIG",
}
AttributeConfigLevel_value = map[string]int32{
"ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED": 0,
"PRODUCT_LEVEL_ATTRIBUTE_CONFIG": 1,
"CATALOG_LEVEL_ATTRIBUTE_CONFIG": 2,
}
)
Enum value maps for AttributeConfigLevel.
SolutionType_name, SolutionType_value
var (
SolutionType_name = map[int32]string{
0: "SOLUTION_TYPE_UNSPECIFIED",
1: "SOLUTION_TYPE_RECOMMENDATION",
2: "SOLUTION_TYPE_SEARCH",
}
SolutionType_value = map[string]int32{
"SOLUTION_TYPE_UNSPECIFIED": 0,
"SOLUTION_TYPE_RECOMMENDATION": 1,
"SOLUTION_TYPE_SEARCH": 2,
}
)
Enum value maps for SolutionType.
RecommendationsFilteringOption_name, RecommendationsFilteringOption_value
var (
RecommendationsFilteringOption_name = map[int32]string{
0: "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED",
1: "RECOMMENDATIONS_FILTERING_DISABLED",
3: "RECOMMENDATIONS_FILTERING_ENABLED",
}
RecommendationsFilteringOption_value = map[string]int32{
"RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED": 0,
"RECOMMENDATIONS_FILTERING_DISABLED": 1,
"RECOMMENDATIONS_FILTERING_ENABLED": 3,
}
)
Enum value maps for RecommendationsFilteringOption.
SearchSolutionUseCase_name, SearchSolutionUseCase_value
var (
SearchSolutionUseCase_name = map[int32]string{
0: "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED",
1: "SEARCH_SOLUTION_USE_CASE_SEARCH",
2: "SEARCH_SOLUTION_USE_CASE_BROWSE",
}
SearchSolutionUseCase_value = map[string]int32{
"SEARCH_SOLUTION_USE_CASE_UNSPECIFIED": 0,
"SEARCH_SOLUTION_USE_CASE_SEARCH": 1,
"SEARCH_SOLUTION_USE_CASE_BROWSE": 2,
}
)
Enum value maps for SearchSolutionUseCase.
ImportProductsRequest_ReconciliationMode_name, ImportProductsRequest_ReconciliationMode_value
var (
ImportProductsRequest_ReconciliationMode_name = map[int32]string{
0: "RECONCILIATION_MODE_UNSPECIFIED",
1: "INCREMENTAL",
2: "FULL",
}
ImportProductsRequest_ReconciliationMode_value = map[string]int32{
"RECONCILIATION_MODE_UNSPECIFIED": 0,
"INCREMENTAL": 1,
"FULL": 2,
}
)
Enum value maps for ImportProductsRequest_ReconciliationMode.
Model_ServingState_name, Model_ServingState_value
var (
Model_ServingState_name = map[int32]string{
0: "SERVING_STATE_UNSPECIFIED",
1: "INACTIVE",
2: "ACTIVE",
3: "TUNED",
}
Model_ServingState_value = map[string]int32{
"SERVING_STATE_UNSPECIFIED": 0,
"INACTIVE": 1,
"ACTIVE": 2,
"TUNED": 3,
}
)
Enum value maps for Model_ServingState.
Model_TrainingState_name, Model_TrainingState_value
var (
Model_TrainingState_name = map[int32]string{
0: "TRAINING_STATE_UNSPECIFIED",
1: "PAUSED",
2: "TRAINING",
}
Model_TrainingState_value = map[string]int32{
"TRAINING_STATE_UNSPECIFIED": 0,
"PAUSED": 1,
"TRAINING": 2,
}
)
Enum value maps for Model_TrainingState.
Model_PeriodicTuningState_name, Model_PeriodicTuningState_value
var (
Model_PeriodicTuningState_name = map[int32]string{
0: "PERIODIC_TUNING_STATE_UNSPECIFIED",
1: "PERIODIC_TUNING_DISABLED",
3: "ALL_TUNING_DISABLED",
2: "PERIODIC_TUNING_ENABLED",
}
Model_PeriodicTuningState_value = map[string]int32{
"PERIODIC_TUNING_STATE_UNSPECIFIED": 0,
"PERIODIC_TUNING_DISABLED": 1,
"ALL_TUNING_DISABLED": 3,
"PERIODIC_TUNING_ENABLED": 2,
}
)
Enum value maps for Model_PeriodicTuningState.
Model_DataState_name, Model_DataState_value
var (
Model_DataState_name = map[int32]string{
0: "DATA_STATE_UNSPECIFIED",
1: "DATA_OK",
2: "DATA_ERROR",
}
Model_DataState_value = map[string]int32{
"DATA_STATE_UNSPECIFIED": 0,
"DATA_OK": 1,
"DATA_ERROR": 2,
}
)
Enum value maps for Model_DataState.
Product_Type_name, Product_Type_value
var (
Product_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "PRIMARY",
2: "VARIANT",
3: "COLLECTION",
}
Product_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"PRIMARY": 1,
"VARIANT": 2,
"COLLECTION": 3,
}
)
Enum value maps for Product_Type.
Product_Availability_name, Product_Availability_value
var (
Product_Availability_name = map[int32]string{
0: "AVAILABILITY_UNSPECIFIED",
1: "IN_STOCK",
2: "OUT_OF_STOCK",
3: "PREORDER",
4: "BACKORDER",
}
Product_Availability_value = map[string]int32{
"AVAILABILITY_UNSPECIFIED": 0,
"IN_STOCK": 1,
"OUT_OF_STOCK": 2,
"PREORDER": 3,
"BACKORDER": 4,
}
)
Enum value maps for Product_Availability.
SearchRequest_SearchMode_name, SearchRequest_SearchMode_value
var (
SearchRequest_SearchMode_name = map[int32]string{
0: "SEARCH_MODE_UNSPECIFIED",
1: "PRODUCT_SEARCH_ONLY",
2: "FACETED_SEARCH_ONLY",
}
SearchRequest_SearchMode_value = map[string]int32{
"SEARCH_MODE_UNSPECIFIED": 0,
"PRODUCT_SEARCH_ONLY": 1,
"FACETED_SEARCH_ONLY": 2,
}
)
Enum value maps for SearchRequest_SearchMode.
SearchRequest_DynamicFacetSpec_Mode_name, SearchRequest_DynamicFacetSpec_Mode_value
var (
SearchRequest_DynamicFacetSpec_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "DISABLED",
2: "ENABLED",
}
SearchRequest_DynamicFacetSpec_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"DISABLED": 1,
"ENABLED": 2,
}
)
Enum value maps for SearchRequest_DynamicFacetSpec_Mode.
SearchRequest_QueryExpansionSpec_Condition_name, SearchRequest_QueryExpansionSpec_Condition_value
var (
SearchRequest_QueryExpansionSpec_Condition_name = map[int32]string{
0: "CONDITION_UNSPECIFIED",
1: "DISABLED",
3: "AUTO",
}
SearchRequest_QueryExpansionSpec_Condition_value = map[string]int32{
"CONDITION_UNSPECIFIED": 0,
"DISABLED": 1,
"AUTO": 3,
}
)
Enum value maps for SearchRequest_QueryExpansionSpec_Condition.
SearchRequest_PersonalizationSpec_Mode_name, SearchRequest_PersonalizationSpec_Mode_value
var (
SearchRequest_PersonalizationSpec_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "AUTO",
2: "DISABLED",
}
SearchRequest_PersonalizationSpec_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"AUTO": 1,
"DISABLED": 2,
}
)
Enum value maps for SearchRequest_PersonalizationSpec_Mode.
SearchRequest_SpellCorrectionSpec_Mode_name, SearchRequest_SpellCorrectionSpec_Mode_value
var (
SearchRequest_SpellCorrectionSpec_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "SUGGESTION_ONLY",
2: "AUTO",
}
SearchRequest_SpellCorrectionSpec_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"SUGGESTION_ONLY": 1,
"AUTO": 2,
}
)
Enum value maps for SearchRequest_SpellCorrectionSpec_Mode.
ServingConfig_DiversityType_name, ServingConfig_DiversityType_value
var (
ServingConfig_DiversityType_name = map[int32]string{
0: "DIVERSITY_TYPE_UNSPECIFIED",
2: "RULE_BASED_DIVERSITY",
3: "DATA_DRIVEN_DIVERSITY",
}
ServingConfig_DiversityType_value = map[string]int32{
"DIVERSITY_TYPE_UNSPECIFIED": 0,
"RULE_BASED_DIVERSITY": 2,
"DATA_DRIVEN_DIVERSITY": 3,
}
)
Enum value maps for ServingConfig_DiversityType.
RejoinUserEventsRequest_UserEventRejoinScope_name, RejoinUserEventsRequest_UserEventRejoinScope_value
var (
RejoinUserEventsRequest_UserEventRejoinScope_name = map[int32]string{
0: "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED",
1: "JOINED_EVENTS",
2: "UNJOINED_EVENTS",
}
RejoinUserEventsRequest_UserEventRejoinScope_value = map[string]int32{
"USER_EVENT_REJOIN_SCOPE_UNSPECIFIED": 0,
"JOINED_EVENTS": 1,
"UNJOINED_EVENTS": 2,
}
)
Enum value maps for RejoinUserEventsRequest_UserEventRejoinScope.
File_google_cloud_retail_v2_catalog_proto
var File_google_cloud_retail_v2_catalog_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_catalog_service_proto
var File_google_cloud_retail_v2_catalog_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_common_proto
var File_google_cloud_retail_v2_common_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_completion_service_proto
var File_google_cloud_retail_v2_completion_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_control_proto
var File_google_cloud_retail_v2_control_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_control_service_proto
var File_google_cloud_retail_v2_control_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_import_config_proto
var File_google_cloud_retail_v2_import_config_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_model_proto
var File_google_cloud_retail_v2_model_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_model_service_proto
var File_google_cloud_retail_v2_model_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_prediction_service_proto
var File_google_cloud_retail_v2_prediction_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_product_proto
var File_google_cloud_retail_v2_product_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_product_service_proto
var File_google_cloud_retail_v2_product_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_promotion_proto
var File_google_cloud_retail_v2_promotion_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_purge_config_proto
var File_google_cloud_retail_v2_purge_config_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_search_service_proto
var File_google_cloud_retail_v2_search_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_serving_config_proto
var File_google_cloud_retail_v2_serving_config_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_serving_config_service_proto
var File_google_cloud_retail_v2_serving_config_service_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_user_event_proto
var File_google_cloud_retail_v2_user_event_proto protoreflect.FileDescriptor
File_google_cloud_retail_v2_user_event_service_proto
var File_google_cloud_retail_v2_user_event_service_proto protoreflect.FileDescriptor
Functions
func RegisterCatalogServiceServer
func RegisterCatalogServiceServer(s *grpc.Server, srv CatalogServiceServer)
func RegisterCompletionServiceServer
func RegisterCompletionServiceServer(s *grpc.Server, srv CompletionServiceServer)
func RegisterControlServiceServer
func RegisterControlServiceServer(s *grpc.Server, srv ControlServiceServer)
func RegisterModelServiceServer
func RegisterModelServiceServer(s *grpc.Server, srv ModelServiceServer)
func RegisterPredictionServiceServer
func RegisterPredictionServiceServer(s *grpc.Server, srv PredictionServiceServer)
func RegisterProductServiceServer
func RegisterProductServiceServer(s *grpc.Server, srv ProductServiceServer)
func RegisterSearchServiceServer
func RegisterSearchServiceServer(s *grpc.Server, srv SearchServiceServer)
func RegisterServingConfigServiceServer
func RegisterServingConfigServiceServer(s *grpc.Server, srv ServingConfigServiceServer)
func RegisterUserEventServiceServer
func RegisterUserEventServiceServer(s *grpc.Server, srv UserEventServiceServer)
AddCatalogAttributeRequest
type AddCatalogAttributeRequest struct {
// Required. Full AttributesConfig resource name. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
AttributesConfig string `protobuf:"bytes,1,opt,name=attributes_config,json=attributesConfig,proto3" json:"attributes_config,omitempty"`
// Required. The [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute]
// to add.
CatalogAttribute *CatalogAttribute `protobuf:"bytes,2,opt,name=catalog_attribute,json=catalogAttribute,proto3" json:"catalog_attribute,omitempty"`
// contains filtered or unexported fields
}
Request for [CatalogService.AddCatalogAttribute][google.cloud.retail.v2.CatalogService.AddCatalogAttribute] method.
func (*AddCatalogAttributeRequest) Descriptor
func (*AddCatalogAttributeRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddCatalogAttributeRequest.ProtoReflect.Descriptor instead.
func (*AddCatalogAttributeRequest) GetAttributesConfig
func (x *AddCatalogAttributeRequest) GetAttributesConfig() string
func (*AddCatalogAttributeRequest) GetCatalogAttribute
func (x *AddCatalogAttributeRequest) GetCatalogAttribute() *CatalogAttribute
func (*AddCatalogAttributeRequest) ProtoMessage
func (*AddCatalogAttributeRequest) ProtoMessage()
func (*AddCatalogAttributeRequest) ProtoReflect
func (x *AddCatalogAttributeRequest) ProtoReflect() protoreflect.Message
func (*AddCatalogAttributeRequest) Reset
func (x *AddCatalogAttributeRequest) Reset()
func (*AddCatalogAttributeRequest) String
func (x *AddCatalogAttributeRequest) String() string
AddControlRequest
type AddControlRequest struct {
// Required. The source ServingConfig resource name . Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// Required. The id of the control to apply. Assumed to be in the same catalog
// as the serving config - if id is not found a NOT_FOUND error is returned.
ControlId string `protobuf:"bytes,2,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
// contains filtered or unexported fields
}
Request for AddControl method.
func (*AddControlRequest) Descriptor
func (*AddControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddControlRequest.ProtoReflect.Descriptor instead.
func (*AddControlRequest) GetControlId
func (x *AddControlRequest) GetControlId() string
func (*AddControlRequest) GetServingConfig
func (x *AddControlRequest) GetServingConfig() string
func (*AddControlRequest) ProtoMessage
func (*AddControlRequest) ProtoMessage()
func (*AddControlRequest) ProtoReflect
func (x *AddControlRequest) ProtoReflect() protoreflect.Message
func (*AddControlRequest) Reset
func (x *AddControlRequest) Reset()
func (*AddControlRequest) String
func (x *AddControlRequest) String() string
AddFulfillmentPlacesMetadata
type AddFulfillmentPlacesMetadata struct {
// contains filtered or unexported fields
}
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces] method.
func (*AddFulfillmentPlacesMetadata) Descriptor
func (*AddFulfillmentPlacesMetadata) Descriptor() ([]byte, []int)
Deprecated: Use AddFulfillmentPlacesMetadata.ProtoReflect.Descriptor instead.
func (*AddFulfillmentPlacesMetadata) ProtoMessage
func (*AddFulfillmentPlacesMetadata) ProtoMessage()
func (*AddFulfillmentPlacesMetadata) ProtoReflect
func (x *AddFulfillmentPlacesMetadata) ProtoReflect() protoreflect.Message
func (*AddFulfillmentPlacesMetadata) Reset
func (x *AddFulfillmentPlacesMetadata) Reset()
func (*AddFulfillmentPlacesMetadata) String
func (x *AddFulfillmentPlacesMetadata) String() string
AddFulfillmentPlacesRequest
type AddFulfillmentPlacesRequest struct {
// Required. Full resource name of [Product][google.cloud.retail.v2.Product],
// such as
// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
//
// If the caller does not have permission to access the
// [Product][google.cloud.retail.v2.Product], regardless of whether or not it
// exists, a PERMISSION_DENIED error is returned.
Product string `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
// Required. The fulfillment type, including commonly used types (such as
// pickup in store and same day delivery), and custom types.
//
// Supported values:
//
// * "pickup-in-store"
// * "ship-to-store"
// * "same-day-delivery"
// * "next-day-delivery"
// * "custom-type-1"
// * "custom-type-2"
// * "custom-type-3"
// * "custom-type-4"
// * "custom-type-5"
//
// If this field is set to an invalid value other than these, an
// INVALID_ARGUMENT error is returned.
//
// This field directly corresponds to
// [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// Required. The IDs for this
// [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
// the store IDs for "pickup-in-store" or the region IDs for
// "same-day-delivery" to be added for this
// [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
// IDs will be automatically ignored.
//
// At least 1 value is required, and a maximum of 2000 values are allowed.
// Each value must be a string with a length limit of 10 characters, matching
// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
// INVALID_ARGUMENT error is returned.
//
// If the total number of place IDs exceeds 2000 for this
// [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
// adding, then the update will be rejected.
PlaceIds []string `protobuf:"bytes,3,rep,name=place_ids,json=placeIds,proto3" json:"place_ids,omitempty"`
// The time when the fulfillment updates are issued, used to prevent
// out-of-order updates on fulfillment information. If not provided, the
// internal system time will be used.
AddTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=add_time,json=addTime,proto3" json:"add_time,omitempty"`
// If set to true, and the [Product][google.cloud.retail.v2.Product] is not
// found, the fulfillment information will still be processed and retained for
// at most 1 day and processed once the
// [Product][google.cloud.retail.v2.Product] is created. If set to false, a
// NOT_FOUND error is returned if the
// [Product][google.cloud.retail.v2.Product] is not found.
AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
// contains filtered or unexported fields
}
Request message for [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces] method.
func (*AddFulfillmentPlacesRequest) Descriptor
func (*AddFulfillmentPlacesRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddFulfillmentPlacesRequest.ProtoReflect.Descriptor instead.
func (*AddFulfillmentPlacesRequest) GetAddTime
func (x *AddFulfillmentPlacesRequest) GetAddTime() *timestamppb.Timestamp
func (*AddFulfillmentPlacesRequest) GetAllowMissing
func (x *AddFulfillmentPlacesRequest) GetAllowMissing() bool
func (*AddFulfillmentPlacesRequest) GetPlaceIds
func (x *AddFulfillmentPlacesRequest) GetPlaceIds() []string
func (*AddFulfillmentPlacesRequest) GetProduct
func (x *AddFulfillmentPlacesRequest) GetProduct() string
func (*AddFulfillmentPlacesRequest) GetType
func (x *AddFulfillmentPlacesRequest) GetType() string
func (*AddFulfillmentPlacesRequest) ProtoMessage
func (*AddFulfillmentPlacesRequest) ProtoMessage()
func (*AddFulfillmentPlacesRequest) ProtoReflect
func (x *AddFulfillmentPlacesRequest) ProtoReflect() protoreflect.Message
func (*AddFulfillmentPlacesRequest) Reset
func (x *AddFulfillmentPlacesRequest) Reset()
func (*AddFulfillmentPlacesRequest) String
func (x *AddFulfillmentPlacesRequest) String() string
AddFulfillmentPlacesResponse
type AddFulfillmentPlacesResponse struct {
// contains filtered or unexported fields
}
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces] method.
func (*AddFulfillmentPlacesResponse) Descriptor
func (*AddFulfillmentPlacesResponse) Descriptor() ([]byte, []int)
Deprecated: Use AddFulfillmentPlacesResponse.ProtoReflect.Descriptor instead.
func (*AddFulfillmentPlacesResponse) ProtoMessage
func (*AddFulfillmentPlacesResponse) ProtoMessage()
func (*AddFulfillmentPlacesResponse) ProtoReflect
func (x *AddFulfillmentPlacesResponse) ProtoReflect() protoreflect.Message
func (*AddFulfillmentPlacesResponse) Reset
func (x *AddFulfillmentPlacesResponse) Reset()
func (*AddFulfillmentPlacesResponse) String
func (x *AddFulfillmentPlacesResponse) String() string
AddLocalInventoriesMetadata
type AddLocalInventoriesMetadata struct {
// contains filtered or unexported fields
}
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.
func (*AddLocalInventoriesMetadata) Descriptor
func (*AddLocalInventoriesMetadata) Descriptor() ([]byte, []int)
Deprecated: Use AddLocalInventoriesMetadata.ProtoReflect.Descriptor instead.
func (*AddLocalInventoriesMetadata) ProtoMessage
func (*AddLocalInventoriesMetadata) ProtoMessage()
func (*AddLocalInventoriesMetadata) ProtoReflect
func (x *AddLocalInventoriesMetadata) ProtoReflect() protoreflect.Message
func (*AddLocalInventoriesMetadata) Reset
func (x *AddLocalInventoriesMetadata) Reset()
func (*AddLocalInventoriesMetadata) String
func (x *AddLocalInventoriesMetadata) String() string
AddLocalInventoriesRequest
type AddLocalInventoriesRequest struct {
// Required. Full resource name of [Product][google.cloud.retail.v2.Product],
// such as
// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
//
// If the caller does not have permission to access the
// [Product][google.cloud.retail.v2.Product], regardless of whether or not it
// exists, a PERMISSION_DENIED error is returned.
Product string `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
// Required. A list of inventory information at difference places. Each place
// is identified by its place ID. At most 3000 inventories are allowed per
// request.
LocalInventories []*LocalInventory `protobuf:"bytes,2,rep,name=local_inventories,json=localInventories,proto3" json:"local_inventories,omitempty"`
// Indicates which inventory fields in the provided list of
// [LocalInventory][google.cloud.retail.v2.LocalInventory] to update. The
// field is updated to the provided value.
//
// If a field is set while the place does not have a previous local inventory,
// the local inventory at that store is created.
//
// If a field is set while the value of that field is not provided, the
// original field value, if it exists, is deleted.
//
// If the mask is not set or set with empty paths, all inventory fields will
// be updated.
//
// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
// is returned and the entire update will be ignored.
AddMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=add_mask,json=addMask,proto3" json:"add_mask,omitempty"`
// The time when the inventory updates are issued. Used to prevent
// out-of-order updates on local inventory fields. If not provided, the
// internal system time will be used.
AddTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=add_time,json=addTime,proto3" json:"add_time,omitempty"`
// If set to true, and the [Product][google.cloud.retail.v2.Product] is not
// found, the local inventory will still be processed and retained for at most
// 1 day and processed once the [Product][google.cloud.retail.v2.Product] is
// created. If set to false, a NOT_FOUND error is returned if the
// [Product][google.cloud.retail.v2.Product] is not found.
AllowMissing bool `protobuf:"varint,6,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
// contains filtered or unexported fields
}
Request message for [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.
func (*AddLocalInventoriesRequest) Descriptor
func (*AddLocalInventoriesRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddLocalInventoriesRequest.ProtoReflect.Descriptor instead.
func (*AddLocalInventoriesRequest) GetAddMask
func (x *AddLocalInventoriesRequest) GetAddMask() *fieldmaskpb.FieldMask
func (*AddLocalInventoriesRequest) GetAddTime
func (x *AddLocalInventoriesRequest) GetAddTime() *timestamppb.Timestamp
func (*AddLocalInventoriesRequest) GetAllowMissing
func (x *AddLocalInventoriesRequest) GetAllowMissing() bool
func (*AddLocalInventoriesRequest) GetLocalInventories
func (x *AddLocalInventoriesRequest) GetLocalInventories() []*LocalInventory
func (*AddLocalInventoriesRequest) GetProduct
func (x *AddLocalInventoriesRequest) GetProduct() string
func (*AddLocalInventoriesRequest) ProtoMessage
func (*AddLocalInventoriesRequest) ProtoMessage()
func (*AddLocalInventoriesRequest) ProtoReflect
func (x *AddLocalInventoriesRequest) ProtoReflect() protoreflect.Message
func (*AddLocalInventoriesRequest) Reset
func (x *AddLocalInventoriesRequest) Reset()
func (*AddLocalInventoriesRequest) String
func (x *AddLocalInventoriesRequest) String() string
AddLocalInventoriesResponse
type AddLocalInventoriesResponse struct {
// contains filtered or unexported fields
}
Response of the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.
func (*AddLocalInventoriesResponse) Descriptor
func (*AddLocalInventoriesResponse) Descriptor() ([]byte, []int)
Deprecated: Use AddLocalInventoriesResponse.ProtoReflect.Descriptor instead.
func (*AddLocalInventoriesResponse) ProtoMessage
func (*AddLocalInventoriesResponse) ProtoMessage()
func (*AddLocalInventoriesResponse) ProtoReflect
func (x *AddLocalInventoriesResponse) ProtoReflect() protoreflect.Message
func (*AddLocalInventoriesResponse) Reset
func (x *AddLocalInventoriesResponse) Reset()
func (*AddLocalInventoriesResponse) String
func (x *AddLocalInventoriesResponse) String() string
AttributeConfigLevel
type AttributeConfigLevel int32
At which level we offer configuration for attributes.
AttributeConfigLevel_ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED, AttributeConfigLevel_PRODUCT_LEVEL_ATTRIBUTE_CONFIG, AttributeConfigLevel_CATALOG_LEVEL_ATTRIBUTE_CONFIG
const (
// Value used when unset. In this case, server behavior defaults to
// [CATALOG_LEVEL_ATTRIBUTE_CONFIG][google.cloud.retail.v2.AttributeConfigLevel.CATALOG_LEVEL_ATTRIBUTE_CONFIG].
AttributeConfigLevel_ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED AttributeConfigLevel = 0
// At this level, we honor the attribute configurations set in
// [Product.attributes][google.cloud.retail.v2.Product.attributes].
AttributeConfigLevel_PRODUCT_LEVEL_ATTRIBUTE_CONFIG AttributeConfigLevel = 1
// At this level, we honor the attribute configurations set in
// [CatalogConfig.attribute_configs][].
AttributeConfigLevel_CATALOG_LEVEL_ATTRIBUTE_CONFIG AttributeConfigLevel = 2
)
func (AttributeConfigLevel) Descriptor
func (AttributeConfigLevel) Descriptor() protoreflect.EnumDescriptor
func (AttributeConfigLevel) Enum
func (x AttributeConfigLevel) Enum() *AttributeConfigLevel
func (AttributeConfigLevel) EnumDescriptor
func (AttributeConfigLevel) EnumDescriptor() ([]byte, []int)
Deprecated: Use AttributeConfigLevel.Descriptor instead.
func (AttributeConfigLevel) Number
func (x AttributeConfigLevel) Number() protoreflect.EnumNumber
func (AttributeConfigLevel) String
func (x AttributeConfigLevel) String() string
func (AttributeConfigLevel) Type
func (AttributeConfigLevel) Type() protoreflect.EnumType
AttributesConfig
type AttributesConfig struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
CatalogAttributes map[string]*CatalogAttribute "" /* 200 byte string literal not displayed */
AttributeConfigLevel AttributeConfigLevel "" /* 173 byte string literal not displayed */
}
Catalog level attribute config.
func (*AttributesConfig) Descriptor
func (*AttributesConfig) Descriptor() ([]byte, []int)
Deprecated: Use AttributesConfig.ProtoReflect.Descriptor instead.
func (*AttributesConfig) GetAttributeConfigLevel
func (x *AttributesConfig) GetAttributeConfigLevel() AttributeConfigLevel
func (*AttributesConfig) GetCatalogAttributes
func (x *AttributesConfig) GetCatalogAttributes() map[string]*CatalogAttribute
func (*AttributesConfig) GetName
func (x *AttributesConfig) GetName() string
func (*AttributesConfig) ProtoMessage
func (*AttributesConfig) ProtoMessage()
func (*AttributesConfig) ProtoReflect
func (x *AttributesConfig) ProtoReflect() protoreflect.Message
func (*AttributesConfig) Reset
func (x *AttributesConfig) Reset()
func (*AttributesConfig) String
func (x *AttributesConfig) String() string
Audience
type Audience struct {
// The genders of the audience. Strongly encouraged to use the standard
// values: "male", "female", "unisex".
//
// At most 5 values are allowed. Each value must be a UTF-8 encoded string
// with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error
// is returned.
//
// Google Merchant Center property
// [gender](https://support.google.com/merchants/answer/6324479). Schema.org
// property
// [Product.audience.suggestedGender](https://schema.org/suggestedGender).
Genders []string `protobuf:"bytes,1,rep,name=genders,proto3" json:"genders,omitempty"`
// The age groups of the audience. Strongly encouraged to use the standard
// values: "newborn" (up to 3 months old), "infant" (3–12 months old),
// "toddler" (1–5 years old), "kids" (5–13 years old), "adult" (typically
// teens or older).
//
// At most 5 values are allowed. Each value must be a UTF-8 encoded string
// with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error
// is returned.
//
// Google Merchant Center property
// [age_group](https://support.google.com/merchants/answer/6324463).
// Schema.org property
// [Product.audience.suggestedMinAge](https://schema.org/suggestedMinAge) and
// [Product.audience.suggestedMaxAge](https://schema.org/suggestedMaxAge).
AgeGroups []string `protobuf:"bytes,2,rep,name=age_groups,json=ageGroups,proto3" json:"age_groups,omitempty"`
// contains filtered or unexported fields
}
An intended audience of the [Product][google.cloud.retail.v2.Product] for whom it's sold.
func (*Audience) Descriptor
Deprecated: Use Audience.ProtoReflect.Descriptor instead.
func (*Audience) GetAgeGroups
func (*Audience) GetGenders
func (*Audience) ProtoMessage
func (*Audience) ProtoMessage()
func (*Audience) ProtoReflect
func (x *Audience) ProtoReflect() protoreflect.Message
func (*Audience) Reset
func (x *Audience) Reset()
func (*Audience) String
BigQuerySource
type BigQuerySource struct {
// BigQuery table partition info. Leave this empty if the BigQuery table
// is not partitioned.
//
// Types that are assignable to Partition:
//
// *BigQuerySource_PartitionDate
Partition isBigQuerySource_Partition `protobuf_oneof:"partition"`
// The project ID (can be project # or ID) that the BigQuery source is in with
// a length limit of 128 characters. If not specified, inherits the project
// ID from the parent request.
ProjectId string `protobuf:"bytes,5,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The BigQuery data set to copy the data from with a length limit
// of 1,024 characters.
DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
// Required. The BigQuery table to copy the data from with a length limit of
// 1,024 characters.
TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// BigQuery export to a specific Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,3,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// The schema to use when parsing the data from the source.
//
// Supported values for product imports:
//
// * `product` (default): One JSON [Product][google.cloud.retail.v2.Product]
// per line. Each product must
//
// have a valid [Product.id][google.cloud.retail.v2.Product.id].
// - `product_merchant_center`: See [Importing catalog data from Merchant
// Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
//
// Supported values for user events imports:
//
// * `user_event` (default): One JSON
// [UserEvent][google.cloud.retail.v2.UserEvent] per line.
// - `user_event_ga360`:
// The schema is available here:
// https://support.google.com/analytics/answer/3437719.
// - `user_event_ga4`:
// The schema is available here:
// https://support.google.com/analytics/answer/7029846.
//
// Supported values for autocomplete imports:
//
// * `suggestions` (default): One JSON completion suggestion per line.
// * `denylist`: One JSON deny suggestion per line.
// * `allowlist`: One JSON allow suggestion per line.
DataSchema string `protobuf:"bytes,4,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
// contains filtered or unexported fields
}
BigQuery source import data from.
func (*BigQuerySource) Descriptor
func (*BigQuerySource) Descriptor() ([]byte, []int)
Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.
func (*BigQuerySource) GetDataSchema
func (x *BigQuerySource) GetDataSchema() string
func (*BigQuerySource) GetDatasetId
func (x *BigQuerySource) GetDatasetId() string
func (*BigQuerySource) GetGcsStagingDir
func (x *BigQuerySource) GetGcsStagingDir() string
func (*BigQuerySource) GetPartition
func (m *BigQuerySource) GetPartition() isBigQuerySource_Partition
func (*BigQuerySource) GetPartitionDate
func (x *BigQuerySource) GetPartitionDate() *date.Date
func (*BigQuerySource) GetProjectId
func (x *BigQuerySource) GetProjectId() string
func (*BigQuerySource) GetTableId
func (x *BigQuerySource) GetTableId() string
func (*BigQuerySource) ProtoMessage
func (*BigQuerySource) ProtoMessage()
func (*BigQuerySource) ProtoReflect
func (x *BigQuerySource) ProtoReflect() protoreflect.Message
func (*BigQuerySource) Reset
func (x *BigQuerySource) Reset()
func (*BigQuerySource) String
func (x *BigQuerySource) String() string
BigQuerySource_PartitionDate
type BigQuerySource_PartitionDate struct {
// BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
//
// Only supported in
// [ImportProductsRequest][google.cloud.retail.v2.ImportProductsRequest].
PartitionDate *date.Date `protobuf:"bytes,6,opt,name=partition_date,json=partitionDate,proto3,oneof"`
}
Catalog
type Catalog struct {
// Required. Immutable. The fully qualified resource name of the catalog.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. The catalog display name.
//
// This field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The product level configuration.
ProductLevelConfig *ProductLevelConfig `protobuf:"bytes,4,opt,name=product_level_config,json=productLevelConfig,proto3" json:"product_level_config,omitempty"`
// contains filtered or unexported fields
}
The catalog configuration.
func (*Catalog) Descriptor
Deprecated: Use Catalog.ProtoReflect.Descriptor instead.
func (*Catalog) GetDisplayName
func (*Catalog) GetName
func (*Catalog) GetProductLevelConfig
func (x *Catalog) GetProductLevelConfig() *ProductLevelConfig
func (*Catalog) ProtoMessage
func (*Catalog) ProtoMessage()
func (*Catalog) ProtoReflect
func (x *Catalog) ProtoReflect() protoreflect.Message
func (*Catalog) Reset
func (x *Catalog) Reset()
func (*Catalog) String
CatalogAttribute
type CatalogAttribute struct {
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
InUse bool `protobuf:"varint,9,opt,name=in_use,json=inUse,proto3" json:"in_use,omitempty"`
Type CatalogAttribute_AttributeType `protobuf:"varint,10,opt,name=type,proto3,enum=google.cloud.retail.v2.CatalogAttribute_AttributeType" json:"type,omitempty"`
IndexableOption CatalogAttribute_IndexableOption "" /* 168 byte string literal not displayed */
DynamicFacetableOption CatalogAttribute_DynamicFacetableOption "" /* 198 byte string literal not displayed */
SearchableOption CatalogAttribute_SearchableOption "" /* 172 byte string literal not displayed */
ExactSearchableOption CatalogAttribute_ExactSearchableOption "" /* 195 byte string literal not displayed */
RetrievableOption CatalogAttribute_RetrievableOption "" /* 177 byte string literal not displayed */
}
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
func (*CatalogAttribute) Descriptor
func (*CatalogAttribute) Descriptor() ([]byte, []int)
Deprecated: Use CatalogAttribute.ProtoReflect.Descriptor instead.
func (*CatalogAttribute) GetDynamicFacetableOption
func (x *CatalogAttribute) GetDynamicFacetableOption() CatalogAttribute_DynamicFacetableOption
func (*CatalogAttribute) GetExactSearchableOption
func (x *CatalogAttribute) GetExactSearchableOption() CatalogAttribute_ExactSearchableOption
func (*CatalogAttribute) GetInUse
func (x *CatalogAttribute) GetInUse() bool
func (*CatalogAttribute) GetIndexableOption
func (x *CatalogAttribute) GetIndexableOption() CatalogAttribute_IndexableOption
func (*CatalogAttribute) GetKey
func (x *CatalogAttribute) GetKey() string
func (*CatalogAttribute) GetRetrievableOption
func (x *CatalogAttribute) GetRetrievableOption() CatalogAttribute_RetrievableOption
func (*CatalogAttribute) GetSearchableOption
func (x *CatalogAttribute) GetSearchableOption() CatalogAttribute_SearchableOption
func (*CatalogAttribute) GetType
func (x *CatalogAttribute) GetType() CatalogAttribute_AttributeType
func (*CatalogAttribute) ProtoMessage
func (*CatalogAttribute) ProtoMessage()
func (*CatalogAttribute) ProtoReflect
func (x *CatalogAttribute) ProtoReflect() protoreflect.Message
func (*CatalogAttribute) Reset
func (x *CatalogAttribute) Reset()
func (*CatalogAttribute) String
func (x *CatalogAttribute) String() string
CatalogAttribute_AttributeType
type CatalogAttribute_AttributeType int32
The type of an attribute.
CatalogAttribute_UNKNOWN, CatalogAttribute_TEXTUAL, CatalogAttribute_NUMERICAL
const (
// The type of the attribute is unknown.
//
// Used when type cannot be derived from attribute that is not
// [in_use][google.cloud.retail.v2.CatalogAttribute.in_use].
CatalogAttribute_UNKNOWN CatalogAttribute_AttributeType = 0
// Textual attribute.
CatalogAttribute_TEXTUAL CatalogAttribute_AttributeType = 1
// Numerical attribute.
CatalogAttribute_NUMERICAL CatalogAttribute_AttributeType = 2
)
func (CatalogAttribute_AttributeType) Descriptor
func (CatalogAttribute_AttributeType) Descriptor() protoreflect.EnumDescriptor
func (CatalogAttribute_AttributeType) Enum
func (x CatalogAttribute_AttributeType) Enum() *CatalogAttribute_AttributeType
func (CatalogAttribute_AttributeType) EnumDescriptor
func (CatalogAttribute_AttributeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use CatalogAttribute_AttributeType.Descriptor instead.
func (CatalogAttribute_AttributeType) Number
func (x CatalogAttribute_AttributeType) Number() protoreflect.EnumNumber
func (CatalogAttribute_AttributeType) String
func (x CatalogAttribute_AttributeType) String() string
func (CatalogAttribute_AttributeType) Type
func (CatalogAttribute_AttributeType) Type() protoreflect.EnumType
CatalogAttribute_DynamicFacetableOption
type CatalogAttribute_DynamicFacetableOption int32
The status of the dynamic facetable option of a catalog attribute.
CatalogAttribute_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED, CatalogAttribute_DYNAMIC_FACETABLE_ENABLED, CatalogAttribute_DYNAMIC_FACETABLE_DISABLED
const (
// Value used when unset.
CatalogAttribute_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED CatalogAttribute_DynamicFacetableOption = 0
// Dynamic facetable option enabled for an attribute.
CatalogAttribute_DYNAMIC_FACETABLE_ENABLED CatalogAttribute_DynamicFacetableOption = 1
// Dynamic facetable option disabled for an attribute.
CatalogAttribute_DYNAMIC_FACETABLE_DISABLED CatalogAttribute_DynamicFacetableOption = 2
)
func (CatalogAttribute_DynamicFacetableOption) Descriptor
func (CatalogAttribute_DynamicFacetableOption) Descriptor() protoreflect.EnumDescriptor
func (CatalogAttribute_DynamicFacetableOption) Enum
func (CatalogAttribute_DynamicFacetableOption) EnumDescriptor
func (CatalogAttribute_DynamicFacetableOption) EnumDescriptor() ([]byte, []int)
Deprecated: Use CatalogAttribute_DynamicFacetableOption.Descriptor instead.
func (CatalogAttribute_DynamicFacetableOption) Number
func (x CatalogAttribute_DynamicFacetableOption) Number() protoreflect.EnumNumber
func (CatalogAttribute_DynamicFacetableOption) String
func (x CatalogAttribute_DynamicFacetableOption) String() string
func (CatalogAttribute_DynamicFacetableOption) Type
func (CatalogAttribute_DynamicFacetableOption) Type() protoreflect.EnumType
CatalogAttribute_ExactSearchableOption
type CatalogAttribute_ExactSearchableOption int32
The status of the exact-searchable option of a catalog attribute.
CatalogAttribute_EXACT_SEARCHABLE_OPTION_UNSPECIFIED, CatalogAttribute_EXACT_SEARCHABLE_ENABLED, CatalogAttribute_EXACT_SEARCHABLE_DISABLED
const (
// Value used when unset.
CatalogAttribute_EXACT_SEARCHABLE_OPTION_UNSPECIFIED CatalogAttribute_ExactSearchableOption = 0
// Exact searchable option enabled for an attribute.
CatalogAttribute_EXACT_SEARCHABLE_ENABLED CatalogAttribute_ExactSearchableOption = 1
// Exact searchable option disabled for an attribute.
CatalogAttribute_EXACT_SEARCHABLE_DISABLED CatalogAttribute_ExactSearchableOption = 2
)
func (CatalogAttribute_ExactSearchableOption) Descriptor
func (CatalogAttribute_ExactSearchableOption) Descriptor() protoreflect.EnumDescriptor
func (CatalogAttribute_ExactSearchableOption) Enum
func (CatalogAttribute_ExactSearchableOption) EnumDescriptor
func (CatalogAttribute_ExactSearchableOption) EnumDescriptor() ([]byte, []int)
Deprecated: Use CatalogAttribute_ExactSearchableOption.Descriptor instead.
func (CatalogAttribute_ExactSearchableOption) Number
func (x CatalogAttribute_ExactSearchableOption) Number() protoreflect.EnumNumber
func (CatalogAttribute_ExactSearchableOption) String
func (x CatalogAttribute_ExactSearchableOption) String() string
func (CatalogAttribute_ExactSearchableOption) Type
func (CatalogAttribute_ExactSearchableOption) Type() protoreflect.EnumType
CatalogAttribute_IndexableOption
type CatalogAttribute_IndexableOption int32
The status of the indexable option of a catalog attribute.
CatalogAttribute_INDEXABLE_OPTION_UNSPECIFIED, CatalogAttribute_INDEXABLE_ENABLED, CatalogAttribute_INDEXABLE_DISABLED
const (
// Value used when unset.
CatalogAttribute_INDEXABLE_OPTION_UNSPECIFIED CatalogAttribute_IndexableOption = 0
// Indexable option enabled for an attribute.
CatalogAttribute_INDEXABLE_ENABLED CatalogAttribute_IndexableOption = 1
// Indexable option disabled for an attribute.
CatalogAttribute_INDEXABLE_DISABLED CatalogAttribute_IndexableOption = 2
)
func (CatalogAttribute_IndexableOption) Descriptor
func (CatalogAttribute_IndexableOption) Descriptor() protoreflect.EnumDescriptor
func (CatalogAttribute_IndexableOption) Enum
func (x CatalogAttribute_IndexableOption) Enum() *CatalogAttribute_IndexableOption
func (CatalogAttribute_IndexableOption) EnumDescriptor
func (CatalogAttribute_IndexableOption) EnumDescriptor() ([]byte, []int)
Deprecated: Use CatalogAttribute_IndexableOption.Descriptor instead.
func (CatalogAttribute_IndexableOption) Number
func (x CatalogAttribute_IndexableOption) Number() protoreflect.EnumNumber
func (CatalogAttribute_IndexableOption) String
func (x CatalogAttribute_IndexableOption) String() string
func (CatalogAttribute_IndexableOption) Type
func (CatalogAttribute_IndexableOption) Type() protoreflect.EnumType
CatalogAttribute_RetrievableOption
type CatalogAttribute_RetrievableOption int32
The status of the retrievable option of a catalog attribute.
CatalogAttribute_RETRIEVABLE_OPTION_UNSPECIFIED, CatalogAttribute_RETRIEVABLE_ENABLED, CatalogAttribute_RETRIEVABLE_DISABLED
const (
// Value used when unset.
CatalogAttribute_RETRIEVABLE_OPTION_UNSPECIFIED CatalogAttribute_RetrievableOption = 0
// Retrievable option enabled for an attribute.
CatalogAttribute_RETRIEVABLE_ENABLED CatalogAttribute_RetrievableOption = 1
// Retrievable option disabled for an attribute.
CatalogAttribute_RETRIEVABLE_DISABLED CatalogAttribute_RetrievableOption = 2
)
func (CatalogAttribute_RetrievableOption) Descriptor
func (CatalogAttribute_RetrievableOption) Descriptor() protoreflect.EnumDescriptor
func (CatalogAttribute_RetrievableOption) Enum
func (x CatalogAttribute_RetrievableOption) Enum() *CatalogAttribute_RetrievableOption
func (CatalogAttribute_RetrievableOption) EnumDescriptor
func (CatalogAttribute_RetrievableOption) EnumDescriptor() ([]byte, []int)
Deprecated: Use CatalogAttribute_RetrievableOption.Descriptor instead.
func (CatalogAttribute_RetrievableOption) Number
func (x CatalogAttribute_RetrievableOption) Number() protoreflect.EnumNumber
func (CatalogAttribute_RetrievableOption) String
func (x CatalogAttribute_RetrievableOption) String() string
func (CatalogAttribute_RetrievableOption) Type
func (CatalogAttribute_RetrievableOption) Type() protoreflect.EnumType
CatalogAttribute_SearchableOption
type CatalogAttribute_SearchableOption int32
The status of the searchable option of a catalog attribute.
CatalogAttribute_SEARCHABLE_OPTION_UNSPECIFIED, CatalogAttribute_SEARCHABLE_ENABLED, CatalogAttribute_SEARCHABLE_DISABLED
const (
// Value used when unset.
CatalogAttribute_SEARCHABLE_OPTION_UNSPECIFIED CatalogAttribute_SearchableOption = 0
// Searchable option enabled for an attribute.
CatalogAttribute_SEARCHABLE_ENABLED CatalogAttribute_SearchableOption = 1
// Searchable option disabled for an attribute.
CatalogAttribute_SEARCHABLE_DISABLED CatalogAttribute_SearchableOption = 2
)
func (CatalogAttribute_SearchableOption) Descriptor
func (CatalogAttribute_SearchableOption) Descriptor() protoreflect.EnumDescriptor
func (CatalogAttribute_SearchableOption) Enum
func (x CatalogAttribute_SearchableOption) Enum() *CatalogAttribute_SearchableOption
func (CatalogAttribute_SearchableOption) EnumDescriptor
func (CatalogAttribute_SearchableOption) EnumDescriptor() ([]byte, []int)
Deprecated: Use CatalogAttribute_SearchableOption.Descriptor instead.
func (CatalogAttribute_SearchableOption) Number
func (x CatalogAttribute_SearchableOption) Number() protoreflect.EnumNumber
func (CatalogAttribute_SearchableOption) String
func (x CatalogAttribute_SearchableOption) String() string
func (CatalogAttribute_SearchableOption) Type
func (CatalogAttribute_SearchableOption) Type() protoreflect.EnumType
CatalogServiceClient
type CatalogServiceClient interface {
// Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with
// the project.
ListCatalogs(ctx context.Context, in *ListCatalogsRequest, opts ...grpc.CallOption) (*ListCatalogsResponse, error)
// Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
UpdateCatalog(ctx context.Context, in *UpdateCatalogRequest, opts ...grpc.CallOption) (*Catalog, error)
// Set a specified branch id as default branch. API methods such as
// [SearchService.Search][google.cloud.retail.v2.SearchService.Search],
// [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct],
// [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
// will treat requests using "default_branch" to the actual branch id set as
// default.
//
// For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as
// default, setting
// [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
// `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent
// to setting
// [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
// `projects/*/locations/*/catalogs/*/branches/1`.
//
// Using multiple branches can be useful when developers would like
// to have a staging branch to test and verify for future usage. When it
// becomes ready, developers switch on the staging branch using this API while
// keeping using `projects/*/locations/*/catalogs/*/branches/default_branch`
// as [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
// route the traffic to this staging branch.
//
// CAUTION: If you have live predict/search traffic, switching the default
// branch could potentially cause outages if the ID space of the new branch is
// very different from the old one.
//
// More specifically:
//
// - PredictionService will only return product IDs from branch {newBranch}.
// - SearchService will only return product IDs from branch {newBranch}
// (if branch is not explicitly set).
// - UserEventService will only join events with products from branch
// {newBranch}.
SetDefaultBranch(ctx context.Context, in *SetDefaultBranchRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Get which branch is currently default branch set by
// [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
// method under a specified parent catalog.
GetDefaultBranch(ctx context.Context, in *GetDefaultBranchRequest, opts ...grpc.CallOption) (*GetDefaultBranchResponse, error)
// Gets a [CompletionConfig][google.cloud.retail.v2.CompletionConfig].
GetCompletionConfig(ctx context.Context, in *GetCompletionConfigRequest, opts ...grpc.CallOption) (*CompletionConfig, error)
// Updates the [CompletionConfig][google.cloud.retail.v2.CompletionConfig]s.
UpdateCompletionConfig(ctx context.Context, in *UpdateCompletionConfigRequest, opts ...grpc.CallOption) (*CompletionConfig, error)
// Gets an [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
GetAttributesConfig(ctx context.Context, in *GetAttributesConfigRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
// Updates the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
//
// The catalog attributes in the request will be updated in the catalog, or
// inserted if they do not exist. Existing catalog attributes not included in
// the request will remain unchanged. Attributes that are assigned to
// products, but do not exist at the catalog level, are always included in the
// response. The product attribute is assigned default values for missing
// catalog attribute fields, e.g., searchable and dynamic facetable options.
UpdateAttributesConfig(ctx context.Context, in *UpdateAttributesConfigRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
// Adds the specified
// [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to the
// [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
//
// If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to add
// already exists, an ALREADY_EXISTS error is returned.
AddCatalogAttribute(ctx context.Context, in *AddCatalogAttributeRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
// Removes the specified
// [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] from the
// [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
//
// If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
// remove does not exist, a NOT_FOUND error is returned.
RemoveCatalogAttribute(ctx context.Context, in *RemoveCatalogAttributeRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
// Replaces the specified
// [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] in the
// [AttributesConfig][google.cloud.retail.v2.AttributesConfig] by updating the
// catalog attribute with the same
// [CatalogAttribute.key][google.cloud.retail.v2.CatalogAttribute.key].
//
// If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
// replace does not exist, a NOT_FOUND error is returned.
ReplaceCatalogAttribute(ctx context.Context, in *ReplaceCatalogAttributeRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
}
CatalogServiceClient is the client API for CatalogService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewCatalogServiceClient
func NewCatalogServiceClient(cc grpc.ClientConnInterface) CatalogServiceClient
CatalogServiceServer
type CatalogServiceServer interface {
// Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with
// the project.
ListCatalogs(context.Context, *ListCatalogsRequest) (*ListCatalogsResponse, error)
// Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
UpdateCatalog(context.Context, *UpdateCatalogRequest) (*Catalog, error)
// Set a specified branch id as default branch. API methods such as
// [SearchService.Search][google.cloud.retail.v2.SearchService.Search],
// [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct],
// [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
// will treat requests using "default_branch" to the actual branch id set as
// default.
//
// For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as
// default, setting
// [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
// `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent
// to setting
// [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
// `projects/*/locations/*/catalogs/*/branches/1`.
//
// Using multiple branches can be useful when developers would like
// to have a staging branch to test and verify for future usage. When it
// becomes ready, developers switch on the staging branch using this API while
// keeping using `projects/*/locations/*/catalogs/*/branches/default_branch`
// as [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
// route the traffic to this staging branch.
//
// CAUTION: If you have live predict/search traffic, switching the default
// branch could potentially cause outages if the ID space of the new branch is
// very different from the old one.
//
// More specifically:
//
// - PredictionService will only return product IDs from branch {newBranch}.
// - SearchService will only return product IDs from branch {newBranch}
// (if branch is not explicitly set).
// - UserEventService will only join events with products from branch
// {newBranch}.
SetDefaultBranch(context.Context, *SetDefaultBranchRequest) (*emptypb.Empty, error)
// Get which branch is currently default branch set by
// [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
// method under a specified parent catalog.
GetDefaultBranch(context.Context, *GetDefaultBranchRequest) (*GetDefaultBranchResponse, error)
// Gets a [CompletionConfig][google.cloud.retail.v2.CompletionConfig].
GetCompletionConfig(context.Context, *GetCompletionConfigRequest) (*CompletionConfig, error)
// Updates the [CompletionConfig][google.cloud.retail.v2.CompletionConfig]s.
UpdateCompletionConfig(context.Context, *UpdateCompletionConfigRequest) (*CompletionConfig, error)
// Gets an [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
GetAttributesConfig(context.Context, *GetAttributesConfigRequest) (*AttributesConfig, error)
// Updates the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
//
// The catalog attributes in the request will be updated in the catalog, or
// inserted if they do not exist. Existing catalog attributes not included in
// the request will remain unchanged. Attributes that are assigned to
// products, but do not exist at the catalog level, are always included in the
// response. The product attribute is assigned default values for missing
// catalog attribute fields, e.g., searchable and dynamic facetable options.
UpdateAttributesConfig(context.Context, *UpdateAttributesConfigRequest) (*AttributesConfig, error)
// Adds the specified
// [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to the
// [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
//
// If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to add
// already exists, an ALREADY_EXISTS error is returned.
AddCatalogAttribute(context.Context, *AddCatalogAttributeRequest) (*AttributesConfig, error)
// Removes the specified
// [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] from the
// [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
//
// If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
// remove does not exist, a NOT_FOUND error is returned.
RemoveCatalogAttribute(context.Context, *RemoveCatalogAttributeRequest) (*AttributesConfig, error)
// Replaces the specified
// [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] in the
// [AttributesConfig][google.cloud.retail.v2.AttributesConfig] by updating the
// catalog attribute with the same
// [CatalogAttribute.key][google.cloud.retail.v2.CatalogAttribute.key].
//
// If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
// replace does not exist, a NOT_FOUND error is returned.
ReplaceCatalogAttribute(context.Context, *ReplaceCatalogAttributeRequest) (*AttributesConfig, error)
}
CatalogServiceServer is the server API for CatalogService service.
CollectUserEventRequest
type CollectUserEventRequest struct {
// The rule that can convert the raw_json to a user event. It is needed
// only when the raw_json is set.
//
// Types that are assignable to ConversionRule:
//
// *CollectUserEventRequest_PrebuiltRule
ConversionRule isCollectUserEventRequest_ConversionRule `protobuf_oneof:"conversion_rule"`
// Required. The parent catalog name, such as
// `projects/1234/locations/global/catalogs/default_catalog`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. URL encoded UserEvent proto with a length limit of 2,000,000
// characters.
UserEvent string `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
// The URL including cgi-parameters but excluding the hash fragment with a
// length limit of 5,000 characters. This is often more useful than the
// referer URL, because many browsers only send the domain for 3rd party
// requests.
Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
// The event timestamp in milliseconds. This prevents browser caching of
// otherwise identical get requests. The name is abbreviated to reduce the
// payload bytes.
Ets int64 `protobuf:"varint,4,opt,name=ets,proto3" json:"ets,omitempty"`
// An arbitrary serialized JSON string that contains necessary information
// that can comprise a user event. When this field is specified, the
// user_event field will be ignored. Note: line-delimited JSON is not
// supported, a single JSON only.
RawJson string `protobuf:"bytes,5,opt,name=raw_json,json=rawJson,proto3" json:"raw_json,omitempty"`
// contains filtered or unexported fields
}
Request message for CollectUserEvent method.
func (*CollectUserEventRequest) Descriptor
func (*CollectUserEventRequest) Descriptor() ([]byte, []int)
Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.
func (*CollectUserEventRequest) GetConversionRule
func (m *CollectUserEventRequest) GetConversionRule() isCollectUserEventRequest_ConversionRule
func (*CollectUserEventRequest) GetEts
func (x *CollectUserEventRequest) GetEts() int64
func (*CollectUserEventRequest) GetParent
func (x *CollectUserEventRequest) GetParent() string
func (*CollectUserEventRequest) GetPrebuiltRule
func (x *CollectUserEventRequest) GetPrebuiltRule() string
func (*CollectUserEventRequest) GetRawJson
func (x *CollectUserEventRequest) GetRawJson() string
func (*CollectUserEventRequest) GetUri
func (x *CollectUserEventRequest) GetUri() string
func (*CollectUserEventRequest) GetUserEvent
func (x *CollectUserEventRequest) GetUserEvent() string
func (*CollectUserEventRequest) ProtoMessage
func (*CollectUserEventRequest) ProtoMessage()
func (*CollectUserEventRequest) ProtoReflect
func (x *CollectUserEventRequest) ProtoReflect() protoreflect.Message
func (*CollectUserEventRequest) Reset
func (x *CollectUserEventRequest) Reset()
func (*CollectUserEventRequest) String
func (x *CollectUserEventRequest) String() string
CollectUserEventRequest_PrebuiltRule
type CollectUserEventRequest_PrebuiltRule struct {
// The prebuilt rule name that can convert a specific type of raw_json.
// For example: "ga4_bq" rule for the GA4 user event schema.
PrebuiltRule string `protobuf:"bytes,6,opt,name=prebuilt_rule,json=prebuiltRule,proto3,oneof"`
}
ColorInfo
type ColorInfo struct {
// The standard color families. Strongly recommended to use the following
// standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple",
// "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and
// "Mixed". Normally it is expected to have only 1 color family. May consider
// using single "Mixed" instead of multiple values.
//
// A maximum of 5 values are allowed. Each value must be a UTF-8 encoded
// string with a length limit of 128 characters. Otherwise, an
// INVALID_ARGUMENT error is returned.
//
// Google Merchant Center property
// [color](https://support.google.com/merchants/answer/6324487). Schema.org
// property [Product.color](https://schema.org/color).
ColorFamilies []string `protobuf:"bytes,1,rep,name=color_families,json=colorFamilies,proto3" json:"color_families,omitempty"`
// The color display names, which may be different from standard color family
// names, such as the color aliases used in the website frontend. Normally
// it is expected to have only 1 color. May consider using single "Mixed"
// instead of multiple values.
//
// A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded
// string with a length limit of 128 characters. Otherwise, an
// INVALID_ARGUMENT error is returned.
//
// Google Merchant Center property
// [color](https://support.google.com/merchants/answer/6324487). Schema.org
// property [Product.color](https://schema.org/color).
Colors []string `protobuf:"bytes,2,rep,name=colors,proto3" json:"colors,omitempty"`
// contains filtered or unexported fields
}
The color information of a [Product][google.cloud.retail.v2.Product].
func (*ColorInfo) Descriptor
Deprecated: Use ColorInfo.ProtoReflect.Descriptor instead.
func (*ColorInfo) GetColorFamilies
func (*ColorInfo) GetColors
func (*ColorInfo) ProtoMessage
func (*ColorInfo) ProtoMessage()
func (*ColorInfo) ProtoReflect
func (x *ColorInfo) ProtoReflect() protoreflect.Message
func (*ColorInfo) Reset
func (x *ColorInfo) Reset()
func (*ColorInfo) String
CompleteQueryRequest
type CompleteQueryRequest struct {
// Required. Catalog for which the completion is performed.
//
// Full resource name of catalog, such as
// `projects/*/locations/global/catalogs/default_catalog`.
Catalog string `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
// Required. The query used to generate suggestions.
//
// The maximum number of allowed characters is 255.
Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// Required field. A unique identifier for tracking visitors. For example,
// this could be implemented with an HTTP cookie, which should be able to
// uniquely identify a visitor on a single device. This unique identifier
// should not change if the visitor logs in or out of the website.
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
VisitorId string `protobuf:"bytes,7,opt,name=visitor_id,json=visitorId,proto3" json:"visitor_id,omitempty"`
// Note that this field applies for `user-data` dataset only. For requests
// with `cloud-retail` dataset, setting this field has no effect.
//
// The language filters applied to the output suggestions. If set, it should
// contain the language of the query. If not set, suggestions are returned
// without considering language restrictions. This is the BCP-47 language
// code, such as "en-US" or "sr-Latn". For more information, see [Tags for
// Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
// number of language codes is 3.
LanguageCodes []string `protobuf:"bytes,3,rep,name=language_codes,json=languageCodes,proto3" json:"language_codes,omitempty"`
// The device type context for completion suggestions. We recommend that you
// leave this field empty.
//
// It can apply different suggestions on different device types, e.g.
// `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
// types.
//
// Supported formats:
//
// * `UNKNOWN_DEVICE_TYPE`
//
// * `DESKTOP`
//
// * `MOBILE`
//
// * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
DeviceType string `protobuf:"bytes,4,opt,name=device_type,json=deviceType,proto3" json:"device_type,omitempty"`
// Determines which dataset to use for fetching completion. "user-data" will
// use the imported dataset through
// [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
// "cloud-retail" will use the dataset generated by cloud retail based on user
// events. If leave empty, it will use the "user-data".
//
// Current supported values:
//
// * user-data
//
// - cloud-retail:
// This option requires enabling auto-learning function first. See
// [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
Dataset string `protobuf:"bytes,6,opt,name=dataset,proto3" json:"dataset,omitempty"`
// Completion max suggestions. If left unset or set to 0, then will fallback
// to the configured value
// [CompletionConfig.max_suggestions][google.cloud.retail.v2.CompletionConfig.max_suggestions].
//
// The maximum allowed max suggestions is 20. If it is set higher, it will be
// capped by 20.
MaxSuggestions int32 `protobuf:"varint,5,opt,name=max_suggestions,json=maxSuggestions,proto3" json:"max_suggestions,omitempty"`
// The entity for customers that may run multiple different entities, domains,
// sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
// `google.com`, `youtube.com`, etc.
// If this is set, it should be exactly matched with
// [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get
// per-entity autocomplete results.
Entity string `protobuf:"bytes,10,opt,name=entity,proto3" json:"entity,omitempty"`
// contains filtered or unexported fields
}
Autocomplete parameters.
func (*CompleteQueryRequest) Descriptor
func (*CompleteQueryRequest) Descriptor() ([]byte, []int)
Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.
func (*CompleteQueryRequest) GetCatalog
func (x *CompleteQueryRequest) GetCatalog() string
func (*CompleteQueryRequest) GetDataset
func (x *CompleteQueryRequest) GetDataset() string
func (*CompleteQueryRequest) GetDeviceType
func (x *CompleteQueryRequest) GetDeviceType() string
func (*CompleteQueryRequest) GetEntity
func (x *CompleteQueryRequest) GetEntity() string
func (*CompleteQueryRequest) GetLanguageCodes
func (x *CompleteQueryRequest) GetLanguageCodes() []string
func (*CompleteQueryRequest) GetMaxSuggestions
func (x *CompleteQueryRequest) GetMaxSuggestions() int32
func (*CompleteQueryRequest) GetQuery
func (x *CompleteQueryRequest) GetQuery() string
func (*CompleteQueryRequest) GetVisitorId
func (x *CompleteQueryRequest) GetVisitorId() string
func (*CompleteQueryRequest) ProtoMessage
func (*CompleteQueryRequest) ProtoMessage()
func (*CompleteQueryRequest) ProtoReflect
func (x *CompleteQueryRequest) ProtoReflect() protoreflect.Message
func (*CompleteQueryRequest) Reset
func (x *CompleteQueryRequest) Reset()
func (*CompleteQueryRequest) String
func (x *CompleteQueryRequest) String() string
CompleteQueryResponse
type CompleteQueryResponse struct {
// Results of the matching suggestions. The result list is ordered and the
// first result is top suggestion.
CompletionResults []*CompleteQueryResponse_CompletionResult `protobuf:"bytes,1,rep,name=completion_results,json=completionResults,proto3" json:"completion_results,omitempty"`
// A unique complete token. This should be included in the
// [UserEvent.completion_detail][google.cloud.retail.v2.UserEvent.completion_detail]
// for search events resulting from this completion, which enables accurate
// attribution of complete model performance.
AttributionToken string `protobuf:"bytes,2,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
// Matched recent searches of this user. The maximum number of recent searches
// is 10. This field is a restricted feature. Contact Retail Search support
// team if you are interested in enabling it.
//
// This feature is only available when
// [CompleteQueryRequest.visitor_id][google.cloud.retail.v2.CompleteQueryRequest.visitor_id]
// field is set and [UserEvent][google.cloud.retail.v2.UserEvent] is imported.
// The recent searches satisfy the follow rules:
//
// - They are ordered from latest to oldest.
//
// - They are matched with
// [CompleteQueryRequest.query][google.cloud.retail.v2.CompleteQueryRequest.query]
// case insensitively.
//
// - They are transformed to lower case.
//
// - They are UTF-8 safe.
//
// Recent searches are deduplicated. More recent searches will be reserved
// when duplication happens.
RecentSearchResults []*CompleteQueryResponse_RecentSearchResult `protobuf:"bytes,3,rep,name=recent_search_results,json=recentSearchResults,proto3" json:"recent_search_results,omitempty"`
// contains filtered or unexported fields
}
Response of the autocomplete query.
func (*CompleteQueryResponse) Descriptor
func (*CompleteQueryResponse) Descriptor() ([]byte, []int)
Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.
func (*CompleteQueryResponse) GetAttributionToken
func (x *CompleteQueryResponse) GetAttributionToken() string
func (*CompleteQueryResponse) GetCompletionResults
func (x *CompleteQueryResponse) GetCompletionResults() []*CompleteQueryResponse_CompletionResult
func (*CompleteQueryResponse) GetRecentSearchResults
func (x *CompleteQueryResponse) GetRecentSearchResults() []*CompleteQueryResponse_RecentSearchResult
func (*CompleteQueryResponse) ProtoMessage
func (*CompleteQueryResponse) ProtoMessage()
func (*CompleteQueryResponse) ProtoReflect
func (x *CompleteQueryResponse) ProtoReflect() protoreflect.Message
func (*CompleteQueryResponse) Reset
func (x *CompleteQueryResponse) Reset()
func (*CompleteQueryResponse) String
func (x *CompleteQueryResponse) String() string
CompleteQueryResponse_CompletionResult
type CompleteQueryResponse_CompletionResult struct {
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
Attributes map[string]*CustomAttribute "" /* 161 byte string literal not displayed */
}
Resource that represents completion results.
func (*CompleteQueryResponse_CompletionResult) Descriptor
func (*CompleteQueryResponse_CompletionResult) Descriptor() ([]byte, []int)
Deprecated: Use CompleteQueryResponse_CompletionResult.ProtoReflect.Descriptor instead.
func (*CompleteQueryResponse_CompletionResult) GetAttributes
func (x *CompleteQueryResponse_CompletionResult) GetAttributes() map[string]*CustomAttribute
func (*CompleteQueryResponse_CompletionResult) GetSuggestion
func (x *CompleteQueryResponse_CompletionResult) GetSuggestion() string
func (*CompleteQueryResponse_CompletionResult) ProtoMessage
func (*CompleteQueryResponse_CompletionResult) ProtoMessage()
func (*CompleteQueryResponse_CompletionResult) ProtoReflect
func (x *CompleteQueryResponse_CompletionResult) ProtoReflect() protoreflect.Message
func (*CompleteQueryResponse_CompletionResult) Reset
func (x *CompleteQueryResponse_CompletionResult) Reset()
func (*CompleteQueryResponse_CompletionResult) String
func (x *CompleteQueryResponse_CompletionResult) String() string
CompleteQueryResponse_RecentSearchResult
type CompleteQueryResponse_RecentSearchResult struct {
// The recent search query.
RecentSearch string `protobuf:"bytes,1,opt,name=recent_search,json=recentSearch,proto3" json:"recent_search,omitempty"`
// contains filtered or unexported fields
}
Recent search of this user.
func (*CompleteQueryResponse_RecentSearchResult) Descriptor
func (*CompleteQueryResponse_RecentSearchResult) Descriptor() ([]byte, []int)
Deprecated: Use CompleteQueryResponse_RecentSearchResult.ProtoReflect.Descriptor instead.
func (*CompleteQueryResponse_RecentSearchResult) GetRecentSearch
func (x *CompleteQueryResponse_RecentSearchResult) GetRecentSearch() string
func (*CompleteQueryResponse_RecentSearchResult) ProtoMessage
func (*CompleteQueryResponse_RecentSearchResult) ProtoMessage()
func (*CompleteQueryResponse_RecentSearchResult) ProtoReflect
func (x *CompleteQueryResponse_RecentSearchResult) ProtoReflect() protoreflect.Message
func (*CompleteQueryResponse_RecentSearchResult) Reset
func (x *CompleteQueryResponse_RecentSearchResult) Reset()
func (*CompleteQueryResponse_RecentSearchResult) String
func (x *CompleteQueryResponse_RecentSearchResult) String() string
CompletionConfig
type CompletionConfig struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
MatchingOrder string `protobuf:"bytes,2,opt,name=matching_order,json=matchingOrder,proto3" json:"matching_order,omitempty"`
MaxSuggestions int32 `protobuf:"varint,3,opt,name=max_suggestions,json=maxSuggestions,proto3" json:"max_suggestions,omitempty"`
MinPrefixLength int32 `protobuf:"varint,4,opt,name=min_prefix_length,json=minPrefixLength,proto3" json:"min_prefix_length,omitempty"`
AutoLearning bool `protobuf:"varint,11,opt,name=auto_learning,json=autoLearning,proto3" json:"auto_learning,omitempty"`
SuggestionsInputConfig *CompletionDataInputConfig "" /* 129 byte string literal not displayed */
LastSuggestionsImportOperation string "" /* 155 byte string literal not displayed */
DenylistInputConfig *CompletionDataInputConfig `protobuf:"bytes,7,opt,name=denylist_input_config,json=denylistInputConfig,proto3" json:"denylist_input_config,omitempty"`
LastDenylistImportOperation string "" /* 146 byte string literal not displayed */
AllowlistInputConfig *CompletionDataInputConfig `protobuf:"bytes,9,opt,name=allowlist_input_config,json=allowlistInputConfig,proto3" json:"allowlist_input_config,omitempty"`
LastAllowlistImportOperation string "" /* 150 byte string literal not displayed */
}
Catalog level autocomplete config for customers to customize autocomplete feature's settings.
func (*CompletionConfig) Descriptor
func (*CompletionConfig) Descriptor() ([]byte, []int)
Deprecated: Use CompletionConfig.ProtoReflect.Descriptor instead.
func (*CompletionConfig) GetAllowlistInputConfig
func (x *CompletionConfig) GetAllowlistInputConfig() *CompletionDataInputConfig
func (*CompletionConfig) GetAutoLearning
func (x *CompletionConfig) GetAutoLearning() bool
func (*CompletionConfig) GetDenylistInputConfig
func (x *CompletionConfig) GetDenylistInputConfig() *CompletionDataInputConfig
func (*CompletionConfig) GetLastAllowlistImportOperation
func (x *CompletionConfig) GetLastAllowlistImportOperation() string
func (*CompletionConfig) GetLastDenylistImportOperation
func (x *CompletionConfig) GetLastDenylistImportOperation() string
func (*CompletionConfig) GetLastSuggestionsImportOperation
func (x *CompletionConfig) GetLastSuggestionsImportOperation() string
func (*CompletionConfig) GetMatchingOrder
func (x *CompletionConfig) GetMatchingOrder() string
func (*CompletionConfig) GetMaxSuggestions
func (x *CompletionConfig) GetMaxSuggestions() int32
func (*CompletionConfig) GetMinPrefixLength
func (x *CompletionConfig) GetMinPrefixLength() int32
func (*CompletionConfig) GetName
func (x *CompletionConfig) GetName() string
func (*CompletionConfig) GetSuggestionsInputConfig
func (x *CompletionConfig) GetSuggestionsInputConfig() *CompletionDataInputConfig
func (*CompletionConfig) ProtoMessage
func (*CompletionConfig) ProtoMessage()
func (*CompletionConfig) ProtoReflect
func (x *CompletionConfig) ProtoReflect() protoreflect.Message
func (*CompletionConfig) Reset
func (x *CompletionConfig) Reset()
func (*CompletionConfig) String
func (x *CompletionConfig) String() string
CompletionDataInputConfig
type CompletionDataInputConfig struct {
// The source of the input.
//
// Supported
// [BigQuerySource.data_schema][google.cloud.retail.v2.BigQuerySource.data_schema]
// values for suggestions imports:
//
// * `suggestions` (default): One JSON completion suggestion per line.
// * `denylist`: One JSON deny suggestion per line.
// * `allowlist`: One JSON allow suggestion per line.
//
// Types that are assignable to Source:
//
// *CompletionDataInputConfig_BigQuerySource
Source isCompletionDataInputConfig_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}
The input config source for completion data.
func (*CompletionDataInputConfig) Descriptor
func (*CompletionDataInputConfig) Descriptor() ([]byte, []int)
Deprecated: Use CompletionDataInputConfig.ProtoReflect.Descriptor instead.
func (*CompletionDataInputConfig) GetBigQuerySource
func (x *CompletionDataInputConfig) GetBigQuerySource() *BigQuerySource
func (*CompletionDataInputConfig) GetSource
func (m *CompletionDataInputConfig) GetSource() isCompletionDataInputConfig_Source
func (*CompletionDataInputConfig) ProtoMessage
func (*CompletionDataInputConfig) ProtoMessage()
func (*CompletionDataInputConfig) ProtoReflect
func (x *CompletionDataInputConfig) ProtoReflect() protoreflect.Message
func (*CompletionDataInputConfig) Reset
func (x *CompletionDataInputConfig) Reset()
func (*CompletionDataInputConfig) String
func (x *CompletionDataInputConfig) String() string
CompletionDataInputConfig_BigQuerySource
type CompletionDataInputConfig_BigQuerySource struct {
// Required. BigQuery input source.
//
// Add the IAM permission "BigQuery Data Viewer" for
// cloud-retail-customer-data-access@system.gserviceaccount.com before
// using this feature otherwise an error is thrown.
BigQuerySource *BigQuerySource `protobuf:"bytes,1,opt,name=big_query_source,json=bigQuerySource,proto3,oneof"`
}
CompletionDetail
type CompletionDetail struct {
CompletionAttributionToken string "" /* 141 byte string literal not displayed */
SelectedSuggestion string `protobuf:"bytes,2,opt,name=selected_suggestion,json=selectedSuggestion,proto3" json:"selected_suggestion,omitempty"`
SelectedPosition int32 `protobuf:"varint,3,opt,name=selected_position,json=selectedPosition,proto3" json:"selected_position,omitempty"`
}
Detailed completion information including completion attribution token and clicked completion info.
func (*CompletionDetail) Descriptor
func (*CompletionDetail) Descriptor() ([]byte, []int)
Deprecated: Use CompletionDetail.ProtoReflect.Descriptor instead.
func (*CompletionDetail) GetCompletionAttributionToken
func (x *CompletionDetail) GetCompletionAttributionToken() string
func (*CompletionDetail) GetSelectedPosition
func (x *CompletionDetail) GetSelectedPosition() int32
func (*CompletionDetail) GetSelectedSuggestion
func (x *CompletionDetail) GetSelectedSuggestion() string
func (*CompletionDetail) ProtoMessage
func (*CompletionDetail) ProtoMessage()
func (*CompletionDetail) ProtoReflect
func (x *CompletionDetail) ProtoReflect() protoreflect.Message
func (*CompletionDetail) Reset
func (x *CompletionDetail) Reset()
func (*CompletionDetail) String
func (x *CompletionDetail) String() string
CompletionServiceClient
type CompletionServiceClient interface {
// Completes the specified prefix with keyword suggestions.
//
// This feature is only available for users who have Retail Search enabled.
// Enable Retail Search on Cloud Console before using this feature.
CompleteQuery(ctx context.Context, in *CompleteQueryRequest, opts ...grpc.CallOption) (*CompleteQueryResponse, error)
// Bulk import of processed completion dataset.
//
// Request processing is asynchronous. Partial updating is not supported.
//
// The operation is successfully finished only after the imported suggestions
// are indexed successfully and ready for serving. The process takes hours.
//
// This feature is only available for users who have Retail Search enabled.
// Enable Retail Search on Cloud Console before using this feature.
ImportCompletionData(ctx context.Context, in *ImportCompletionDataRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}
CompletionServiceClient is the client API for CompletionService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewCompletionServiceClient
func NewCompletionServiceClient(cc grpc.ClientConnInterface) CompletionServiceClient
CompletionServiceServer
type CompletionServiceServer interface {
// Completes the specified prefix with keyword suggestions.
//
// This feature is only available for users who have Retail Search enabled.
// Enable Retail Search on Cloud Console before using this feature.
CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
// Bulk import of processed completion dataset.
//
// Request processing is asynchronous. Partial updating is not supported.
//
// The operation is successfully finished only after the imported suggestions
// are indexed successfully and ready for serving. The process takes hours.
//
// This feature is only available for users who have Retail Search enabled.
// Enable Retail Search on Cloud Console before using this feature.
ImportCompletionData(context.Context, *ImportCompletionDataRequest) (*longrunningpb.Operation, error)
}
CompletionServiceServer is the server API for CompletionService service.
Condition
type Condition struct {
// A list (up to 10 entries) of terms to match the query on. If not
// specified, match all queries.
// If many query terms are specified, the condition
// is matched if any of the terms is a match (i.e. using the OR operator).
QueryTerms []*Condition_QueryTerm `protobuf:"bytes,1,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
// Range of time(s) specifying when Condition is active.
// Condition true if any time range matches.
ActiveTimeRange []*Condition_TimeRange `protobuf:"bytes,3,rep,name=active_time_range,json=activeTimeRange,proto3" json:"active_time_range,omitempty"`
// contains filtered or unexported fields
}
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
func (*Condition) Descriptor
Deprecated: Use Condition.ProtoReflect.Descriptor instead.
func (*Condition) GetActiveTimeRange
func (x *Condition) GetActiveTimeRange() []*Condition_TimeRange
func (*Condition) GetQueryTerms
func (x *Condition) GetQueryTerms() []*Condition_QueryTerm
func (*Condition) ProtoMessage
func (*Condition) ProtoMessage()
func (*Condition) ProtoReflect
func (x *Condition) ProtoReflect() protoreflect.Message
func (*Condition) Reset
func (x *Condition) Reset()
func (*Condition) String
Condition_QueryTerm
type Condition_QueryTerm struct {
// The value of the term to match on.
// Value cannot be empty.
// Value can have at most 3 terms if specified as a partial match. Each
// space separated string is considered as one term.
// For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms
// and not allowed for a partial match.
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
// Whether this is supposed to be a full or partial match.
FullMatch bool `protobuf:"varint,2,opt,name=full_match,json=fullMatch,proto3" json:"full_match,omitempty"`
// contains filtered or unexported fields
}
Query terms that we want to match on.
func (*Condition_QueryTerm) Descriptor
func (*Condition_QueryTerm) Descriptor() ([]byte, []int)
Deprecated: Use Condition_QueryTerm.ProtoReflect.Descriptor instead.
func (*Condition_QueryTerm) GetFullMatch
func (x *Condition_QueryTerm) GetFullMatch() bool
func (*Condition_QueryTerm) GetValue
func (x *Condition_QueryTerm) GetValue() string
func (*Condition_QueryTerm) ProtoMessage
func (*Condition_QueryTerm) ProtoMessage()
func (*Condition_QueryTerm) ProtoReflect
func (x *Condition_QueryTerm) ProtoReflect() protoreflect.Message
func (*Condition_QueryTerm) Reset
func (x *Condition_QueryTerm) Reset()
func (*Condition_QueryTerm) String
func (x *Condition_QueryTerm) String() string
Condition_TimeRange
type Condition_TimeRange struct {
// Start of time range. Range is inclusive.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// End of time range. Range is inclusive.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
func (*Condition_TimeRange) Descriptor
func (*Condition_TimeRange) Descriptor() ([]byte, []int)
Deprecated: Use Condition_TimeRange.ProtoReflect.Descriptor instead.
func (*Condition_TimeRange) GetEndTime
func (x *Condition_TimeRange) GetEndTime() *timestamppb.Timestamp
func (*Condition_TimeRange) GetStartTime
func (x *Condition_TimeRange) GetStartTime() *timestamppb.Timestamp
func (*Condition_TimeRange) ProtoMessage
func (*Condition_TimeRange) ProtoMessage()
func (*Condition_TimeRange) ProtoReflect
func (x *Condition_TimeRange) ProtoReflect() protoreflect.Message
func (*Condition_TimeRange) Reset
func (x *Condition_TimeRange) Reset()
func (*Condition_TimeRange) String
func (x *Condition_TimeRange) String() string
Control
type Control struct {
Control isControl_Control `protobuf_oneof:"control"`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
AssociatedServingConfigIds []string "" /* 143 byte string literal not displayed */
SolutionTypes []SolutionType "" /* 149 byte string literal not displayed */
SearchSolutionUseCase []SearchSolutionUseCase "" /* 186 byte string literal not displayed */
}
Configures dynamic metadata that can be linked to a [ServingConfig][google.cloud.retail.v2.ServingConfig] and affect search or recommendation results at serving time.
func (*Control) Descriptor
Deprecated: Use Control.ProtoReflect.Descriptor instead.
func (*Control) GetAssociatedServingConfigIds
func (*Control) GetControl
func (m *Control) GetControl() isControl_Control
func (*Control) GetDisplayName
func (*Control) GetName
func (*Control) GetRule
func (*Control) GetSearchSolutionUseCase
func (x *Control) GetSearchSolutionUseCase() []SearchSolutionUseCase
func (*Control) GetSolutionTypes
func (x *Control) GetSolutionTypes() []SolutionType
func (*Control) ProtoMessage
func (*Control) ProtoMessage()
func (*Control) ProtoReflect
func (x *Control) ProtoReflect() protoreflect.Message
func (*Control) Reset
func (x *Control) Reset()
func (*Control) String
ControlServiceClient
type ControlServiceClient interface {
// Creates a Control.
//
// If the [Control][google.cloud.retail.v2.Control] to create already exists,
// an ALREADY_EXISTS error is returned.
CreateControl(ctx context.Context, in *CreateControlRequest, opts ...grpc.CallOption) (*Control, error)
// Deletes a Control.
//
// If the [Control][google.cloud.retail.v2.Control] to delete does not exist,
// a NOT_FOUND error is returned.
DeleteControl(ctx context.Context, in *DeleteControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Control.
//
// [Control][google.cloud.retail.v2.Control] cannot be set to a different
// oneof field, if so an INVALID_ARGUMENT is returned. If the
// [Control][google.cloud.retail.v2.Control] to update does not exist, a
// NOT_FOUND error is returned.
UpdateControl(ctx context.Context, in *UpdateControlRequest, opts ...grpc.CallOption) (*Control, error)
// Gets a Control.
GetControl(ctx context.Context, in *GetControlRequest, opts ...grpc.CallOption) (*Control, error)
// Lists all Controls by their parent
// [Catalog][google.cloud.retail.v2.Catalog].
ListControls(ctx context.Context, in *ListControlsRequest, opts ...grpc.CallOption) (*ListControlsResponse, error)
}
ControlServiceClient is the client API for ControlService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewControlServiceClient
func NewControlServiceClient(cc grpc.ClientConnInterface) ControlServiceClient
ControlServiceServer
type ControlServiceServer interface {
// Creates a Control.
//
// If the [Control][google.cloud.retail.v2.Control] to create already exists,
// an ALREADY_EXISTS error is returned.
CreateControl(context.Context, *CreateControlRequest) (*Control, error)
// Deletes a Control.
//
// If the [Control][google.cloud.retail.v2.Control] to delete does not exist,
// a NOT_FOUND error is returned.
DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)
// Updates a Control.
//
// [Control][google.cloud.retail.v2.Control] cannot be set to a different
// oneof field, if so an INVALID_ARGUMENT is returned. If the
// [Control][google.cloud.retail.v2.Control] to update does not exist, a
// NOT_FOUND error is returned.
UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)
// Gets a Control.
GetControl(context.Context, *GetControlRequest) (*Control, error)
// Lists all Controls by their parent
// [Catalog][google.cloud.retail.v2.Catalog].
ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)
}
ControlServiceServer is the server API for ControlService service.
Control_Rule
type Control_Rule struct {
// 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".
Rule *Rule `protobuf:"bytes,4,opt,name=rule,proto3,oneof"`
}
CreateControlRequest
type CreateControlRequest struct {
// Required. Full resource name of parent catalog. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The Control to create.
Control *Control `protobuf:"bytes,2,opt,name=control,proto3" json:"control,omitempty"`
// Required. The ID to use for the Control, which will become the final
// component of the Control's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-_/.
ControlId string `protobuf:"bytes,3,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
// contains filtered or unexported fields
}
Request for CreateControl method.
func (*CreateControlRequest) Descriptor
func (*CreateControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateControlRequest.ProtoReflect.Descriptor instead.
func (*CreateControlRequest) GetControl
func (x *CreateControlRequest) GetControl() *Control
func (*CreateControlRequest) GetControlId
func (x *CreateControlRequest) GetControlId() string
func (*CreateControlRequest) GetParent
func (x *CreateControlRequest) GetParent() string
func (*CreateControlRequest) ProtoMessage
func (*CreateControlRequest) ProtoMessage()
func (*CreateControlRequest) ProtoReflect
func (x *CreateControlRequest) ProtoReflect() protoreflect.Message
func (*CreateControlRequest) Reset
func (x *CreateControlRequest) Reset()
func (*CreateControlRequest) String
func (x *CreateControlRequest) String() string
CreateModelMetadata
type CreateModelMetadata struct {
// The resource name of the model that this create applies to.
// Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
// contains filtered or unexported fields
}
Metadata associated with a create operation.
func (*CreateModelMetadata) Descriptor
func (*CreateModelMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateModelMetadata.ProtoReflect.Descriptor instead.
func (*CreateModelMetadata) GetModel
func (x *CreateModelMetadata) GetModel() string
func (*CreateModelMetadata) ProtoMessage
func (*CreateModelMetadata) ProtoMessage()
func (*CreateModelMetadata) ProtoReflect
func (x *CreateModelMetadata) ProtoReflect() protoreflect.Message
func (*CreateModelMetadata) Reset
func (x *CreateModelMetadata) Reset()
func (*CreateModelMetadata) String
func (x *CreateModelMetadata) String() string
CreateModelRequest
type CreateModelRequest struct {
// Required. The parent resource under which to create the model. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The payload of the [Model][google.cloud.retail.v2.Model] to
// create.
Model *Model `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
// Optional. Whether to run a dry run to validate the request (without
// actually creating the model).
DryRun bool `protobuf:"varint,3,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
// contains filtered or unexported fields
}
Request for creating a model.
func (*CreateModelRequest) Descriptor
func (*CreateModelRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateModelRequest.ProtoReflect.Descriptor instead.
func (*CreateModelRequest) GetDryRun
func (x *CreateModelRequest) GetDryRun() bool
func (*CreateModelRequest) GetModel
func (x *CreateModelRequest) GetModel() *Model
func (*CreateModelRequest) GetParent
func (x *CreateModelRequest) GetParent() string
func (*CreateModelRequest) ProtoMessage
func (*CreateModelRequest) ProtoMessage()
func (*CreateModelRequest) ProtoReflect
func (x *CreateModelRequest) ProtoReflect() protoreflect.Message
func (*CreateModelRequest) Reset
func (x *CreateModelRequest) Reset()
func (*CreateModelRequest) String
func (x *CreateModelRequest) String() string
CreateProductRequest
type CreateProductRequest struct {
// Required. The parent catalog resource name, such as
// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Product][google.cloud.retail.v2.Product] to create.
Product *Product `protobuf:"bytes,2,opt,name=product,proto3" json:"product,omitempty"`
// Required. The ID to use for the [Product][google.cloud.retail.v2.Product],
// which will become the final component of the
// [Product.name][google.cloud.retail.v2.Product.name].
//
// If the caller does not have permission to create the
// [Product][google.cloud.retail.v2.Product], regardless of whether or not it
// exists, a PERMISSION_DENIED error is returned.
//
// This field must be unique among all
// [Product][google.cloud.retail.v2.Product]s with the same
// [parent][google.cloud.retail.v2.CreateProductRequest.parent]. Otherwise, an
// ALREADY_EXISTS error is returned.
//
// This field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
ProductId string `protobuf:"bytes,3,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
// contains filtered or unexported fields
}
Request message for [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] method.
func (*CreateProductRequest) Descriptor
func (*CreateProductRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateProductRequest.ProtoReflect.Descriptor instead.
func (*CreateProductRequest) GetParent
func (x *CreateProductRequest) GetParent() string
func (*CreateProductRequest) GetProduct
func (x *CreateProductRequest) GetProduct() *Product
func (*CreateProductRequest) GetProductId
func (x *CreateProductRequest) GetProductId() string
func (*CreateProductRequest) ProtoMessage
func (*CreateProductRequest) ProtoMessage()
func (*CreateProductRequest) ProtoReflect
func (x *CreateProductRequest) ProtoReflect() protoreflect.Message
func (*CreateProductRequest) Reset
func (x *CreateProductRequest) Reset()
func (*CreateProductRequest) String
func (x *CreateProductRequest) String() string
CreateServingConfigRequest
type CreateServingConfigRequest struct {
// Required. Full resource name of parent. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ServingConfig to create.
ServingConfig *ServingConfig `protobuf:"bytes,2,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// Required. The ID to use for the ServingConfig, which will become the final
// component of the ServingConfig's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-_/.
ServingConfigId string `protobuf:"bytes,3,opt,name=serving_config_id,json=servingConfigId,proto3" json:"serving_config_id,omitempty"`
// contains filtered or unexported fields
}
Request for CreateServingConfig method.
func (*CreateServingConfigRequest) Descriptor
func (*CreateServingConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateServingConfigRequest.ProtoReflect.Descriptor instead.
func (*CreateServingConfigRequest) GetParent
func (x *CreateServingConfigRequest) GetParent() string
func (*CreateServingConfigRequest) GetServingConfig
func (x *CreateServingConfigRequest) GetServingConfig() *ServingConfig
func (*CreateServingConfigRequest) GetServingConfigId
func (x *CreateServingConfigRequest) GetServingConfigId() string
func (*CreateServingConfigRequest) ProtoMessage
func (*CreateServingConfigRequest) ProtoMessage()
func (*CreateServingConfigRequest) ProtoReflect
func (x *CreateServingConfigRequest) ProtoReflect() protoreflect.Message
func (*CreateServingConfigRequest) Reset
func (x *CreateServingConfigRequest) Reset()
func (*CreateServingConfigRequest) String
func (x *CreateServingConfigRequest) String() string
CustomAttribute
type CustomAttribute struct {
// The textual values of this custom attribute. For example, `["yellow",
// "green"]` when the key is "color".
//
// Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
// returned.
//
// Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
// [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
// Otherwise, an INVALID_ARGUMENT error is returned.
Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
// when the key is "lengths_cm".
//
// Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
// [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
// Otherwise, an INVALID_ARGUMENT error is returned.
Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
// This field is normally ignored unless
// [AttributesConfig.attribute_config_level][google.cloud.retail.v2.AttributesConfig.attribute_config_level]
// of the [Catalog][google.cloud.retail.v2.Catalog] is set to the deprecated
// 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
// attribute configuration, see [Configuration
// modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
// If true, custom attribute values are searchable by text queries in
// [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
//
// This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
//
// Only set if type [text][google.cloud.retail.v2.CustomAttribute.text] is
// set. Otherwise, a INVALID_ARGUMENT error is returned.
//
// Deprecated: Marked as deprecated in google/cloud/retail/v2/common.proto.
Searchable *bool `protobuf:"varint,3,opt,name=searchable,proto3,oneof" json:"searchable,omitempty"`
// This field is normally ignored unless
// [AttributesConfig.attribute_config_level][google.cloud.retail.v2.AttributesConfig.attribute_config_level]
// of the [Catalog][google.cloud.retail.v2.Catalog] is set to the deprecated
// 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
// attribute configuration, see [Configuration
// modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
// If true, custom attribute values are indexed, so that they can be filtered,
// faceted or boosted in
// [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
//
// This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
//
// See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter],
// [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
// and
// [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
// for more details.
//
// Deprecated: Marked as deprecated in google/cloud/retail/v2/common.proto.
Indexable *bool `protobuf:"varint,4,opt,name=indexable,proto3,oneof" json:"indexable,omitempty"`
// contains filtered or unexported fields
}
A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2.Product].
func (*CustomAttribute) Descriptor
func (*CustomAttribute) Descriptor() ([]byte, []int)
Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.
func (*CustomAttribute) GetIndexable
func (x *CustomAttribute) GetIndexable() bool
Deprecated: Marked as deprecated in google/cloud/retail/v2/common.proto.
func (*CustomAttribute) GetNumbers
func (x *CustomAttribute) GetNumbers() []float64
func (*CustomAttribute) GetSearchable
func (x *CustomAttribute) GetSearchable() bool
Deprecated: Marked as deprecated in google/cloud/retail/v2/common.proto.
func (*CustomAttribute) GetText
func (x *CustomAttribute) GetText() []string
func (*CustomAttribute) ProtoMessage
func (*CustomAttribute) ProtoMessage()
func (*CustomAttribute) ProtoReflect
func (x *CustomAttribute) ProtoReflect() protoreflect.Message
func (*CustomAttribute) Reset
func (x *CustomAttribute) Reset()
func (*CustomAttribute) String
func (x *CustomAttribute) String() string
DeleteControlRequest
type DeleteControlRequest struct {
// Required. The resource name of the Control to delete. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for DeleteControl method.
func (*DeleteControlRequest) Descriptor
func (*DeleteControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteControlRequest.ProtoReflect.Descriptor instead.
func (*DeleteControlRequest) GetName
func (x *DeleteControlRequest) GetName() string
func (*DeleteControlRequest) ProtoMessage
func (*DeleteControlRequest) ProtoMessage()
func (*DeleteControlRequest) ProtoReflect
func (x *DeleteControlRequest) ProtoReflect() protoreflect.Message
func (*DeleteControlRequest) Reset
func (x *DeleteControlRequest) Reset()
func (*DeleteControlRequest) String
func (x *DeleteControlRequest) String() string
DeleteModelRequest
type DeleteModelRequest struct {
// Required. The resource name of the [Model][google.cloud.retail.v2.Model] to
// delete. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for deleting a model.
func (*DeleteModelRequest) Descriptor
func (*DeleteModelRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteModelRequest.ProtoReflect.Descriptor instead.
func (*DeleteModelRequest) GetName
func (x *DeleteModelRequest) GetName() string
func (*DeleteModelRequest) ProtoMessage
func (*DeleteModelRequest) ProtoMessage()
func (*DeleteModelRequest) ProtoReflect
func (x *DeleteModelRequest) ProtoReflect() protoreflect.Message
func (*DeleteModelRequest) Reset
func (x *DeleteModelRequest) Reset()
func (*DeleteModelRequest) String
func (x *DeleteModelRequest) String() string
DeleteProductRequest
type DeleteProductRequest struct {
// Required. Full resource name of [Product][google.cloud.retail.v2.Product],
// such as
// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
//
// If the caller does not have permission to delete the
// [Product][google.cloud.retail.v2.Product], regardless of whether or not it
// exists, a PERMISSION_DENIED error is returned.
//
// If the [Product][google.cloud.retail.v2.Product] to delete does not exist,
// a NOT_FOUND error is returned.
//
// The [Product][google.cloud.retail.v2.Product] to delete can neither be a
// [Product.Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]
// [Product][google.cloud.retail.v2.Product] member nor a
// [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
// [Product][google.cloud.retail.v2.Product] with more than one
// [variants][google.cloud.retail.v2.Product.Type.VARIANT]. Otherwise, an
// INVALID_ARGUMENT error is returned.
//
// All inventory information for the named
// [Product][google.cloud.retail.v2.Product] will be deleted.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [ProductService.DeleteProduct][google.cloud.retail.v2.ProductService.DeleteProduct] method.
func (*DeleteProductRequest) Descriptor
func (*DeleteProductRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteProductRequest.ProtoReflect.Descriptor instead.
func (*DeleteProductRequest) GetName
func (x *DeleteProductRequest) GetName() string
func (*DeleteProductRequest) ProtoMessage
func (*DeleteProductRequest) ProtoMessage()
func (*DeleteProductRequest) ProtoReflect
func (x *DeleteProductRequest) ProtoReflect() protoreflect.Message
func (*DeleteProductRequest) Reset
func (x *DeleteProductRequest) Reset()
func (*DeleteProductRequest) String
func (x *DeleteProductRequest) String() string
DeleteServingConfigRequest
type DeleteServingConfigRequest struct {
// Required. The resource name of the ServingConfig to delete. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for DeleteServingConfig method.
func (*DeleteServingConfigRequest) Descriptor
func (*DeleteServingConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteServingConfigRequest.ProtoReflect.Descriptor instead.
func (*DeleteServingConfigRequest) GetName
func (x *DeleteServingConfigRequest) GetName() string
func (*DeleteServingConfigRequest) ProtoMessage
func (*DeleteServingConfigRequest) ProtoMessage()
func (*DeleteServingConfigRequest) ProtoReflect
func (x *DeleteServingConfigRequest) ProtoReflect() protoreflect.Message
func (*DeleteServingConfigRequest) Reset
func (x *DeleteServingConfigRequest) Reset()
func (*DeleteServingConfigRequest) String
func (x *DeleteServingConfigRequest) String() string
ExperimentInfo
type ExperimentInfo struct {
// Information associated with the specific experiment entity being recorded.
//
// Types that are assignable to ExperimentMetadata:
//
// *ExperimentInfo_ServingConfigExperiment_
ExperimentMetadata isExperimentInfo_ExperimentMetadata `protobuf_oneof:"experiment_metadata"`
// The fully qualified resource name of the experiment that provides the
// serving config under test, should an active experiment exist. For example:
// `projects/*/locations/global/catalogs/default_catalog/experiments/experiment_id`
Experiment string `protobuf:"bytes,1,opt,name=experiment,proto3" json:"experiment,omitempty"`
// contains filtered or unexported fields
}
Metadata for active A/B testing [Experiments][].
func (*ExperimentInfo) Descriptor
func (*ExperimentInfo) Descriptor() ([]byte, []int)
Deprecated: Use ExperimentInfo.ProtoReflect.Descriptor instead.
func (*ExperimentInfo) GetExperiment
func (x *ExperimentInfo) GetExperiment() string
func (*ExperimentInfo) GetExperimentMetadata
func (m *ExperimentInfo) GetExperimentMetadata() isExperimentInfo_ExperimentMetadata
func (*ExperimentInfo) GetServingConfigExperiment
func (x *ExperimentInfo) GetServingConfigExperiment() *ExperimentInfo_ServingConfigExperiment
func (*ExperimentInfo) ProtoMessage
func (*ExperimentInfo) ProtoMessage()
func (*ExperimentInfo) ProtoReflect
func (x *ExperimentInfo) ProtoReflect() protoreflect.Message
func (*ExperimentInfo) Reset
func (x *ExperimentInfo) Reset()
func (*ExperimentInfo) String
func (x *ExperimentInfo) String() string
ExperimentInfo_ServingConfigExperiment
type ExperimentInfo_ServingConfigExperiment struct {
OriginalServingConfig string `protobuf:"bytes,1,opt,name=original_serving_config,json=originalServingConfig,proto3" json:"original_serving_config,omitempty"`
ExperimentServingConfig string "" /* 132 byte string literal not displayed */
}
Metadata for active serving config A/B tests.
func (*ExperimentInfo_ServingConfigExperiment) Descriptor
func (*ExperimentInfo_ServingConfigExperiment) Descriptor() ([]byte, []int)
Deprecated: Use ExperimentInfo_ServingConfigExperiment.ProtoReflect.Descriptor instead.
func (*ExperimentInfo_ServingConfigExperiment) GetExperimentServingConfig
func (x *ExperimentInfo_ServingConfigExperiment) GetExperimentServingConfig() string
func (*ExperimentInfo_ServingConfigExperiment) GetOriginalServingConfig
func (x *ExperimentInfo_ServingConfigExperiment) GetOriginalServingConfig() string
func (*ExperimentInfo_ServingConfigExperiment) ProtoMessage
func (*ExperimentInfo_ServingConfigExperiment) ProtoMessage()
func (*ExperimentInfo_ServingConfigExperiment) ProtoReflect
func (x *ExperimentInfo_ServingConfigExperiment) ProtoReflect() protoreflect.Message
func (*ExperimentInfo_ServingConfigExperiment) Reset
func (x *ExperimentInfo_ServingConfigExperiment) Reset()
func (*ExperimentInfo_ServingConfigExperiment) String
func (x *ExperimentInfo_ServingConfigExperiment) String() string
ExperimentInfo_ServingConfigExperiment_
type ExperimentInfo_ServingConfigExperiment_ struct {
// A/B test between existing Cloud Retail Search
// [ServingConfig][google.cloud.retail.v2.ServingConfig]s.
ServingConfigExperiment *ExperimentInfo_ServingConfigExperiment `protobuf:"bytes,2,opt,name=serving_config_experiment,json=servingConfigExperiment,proto3,oneof"`
}
FulfillmentInfo
type FulfillmentInfo struct {
// The fulfillment type, including commonly used types (such as pickup in
// store and same day delivery), and custom types. Customers have to map
// custom types to their display names before rendering UI.
//
// Supported values:
//
// * "pickup-in-store"
// * "ship-to-store"
// * "same-day-delivery"
// * "next-day-delivery"
// * "custom-type-1"
// * "custom-type-2"
// * "custom-type-3"
// * "custom-type-4"
// * "custom-type-5"
//
// If this field is set to an invalid value other than these, an
// INVALID_ARGUMENT error is returned.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// The IDs for this [type][google.cloud.retail.v2.FulfillmentInfo.type], such
// as the store IDs for
// [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2.FulfillmentInfo.type]
// or the region IDs for
// [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2.FulfillmentInfo.type].
//
// A maximum of 3000 values are allowed. Each value must be a string with a
// length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
// as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
// returned.
PlaceIds []string `protobuf:"bytes,2,rep,name=place_ids,json=placeIds,proto3" json:"place_ids,omitempty"`
// contains filtered or unexported fields
}
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
func (*FulfillmentInfo) Descriptor
func (*FulfillmentInfo) Descriptor() ([]byte, []int)
Deprecated: Use FulfillmentInfo.ProtoReflect.Descriptor instead.
func (*FulfillmentInfo) GetPlaceIds
func (x *FulfillmentInfo) GetPlaceIds() []string
func (*FulfillmentInfo) GetType
func (x *FulfillmentInfo) GetType() string
func (*FulfillmentInfo) ProtoMessage
func (*FulfillmentInfo) ProtoMessage()