retailpb

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2024 License: Apache-2.0 Imports: 19 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
var (
	MerchantCenterAccountLink_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "ACTIVE",
		3: "FAILED",
	}
	MerchantCenterAccountLink_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"ACTIVE":            2,
		"FAILED":            3,
	}
)

Enum value maps for MerchantCenterAccountLink_State.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
var (
	Model_PageOptimizationConfig_Restriction_name = map[int32]string{
		0: "RESTRICTION_UNSPECIFIED",
		1: "NO_RESTRICTION",
		2: "UNIQUE_SERVING_CONFIG_RESTRICTION",
		3: "UNIQUE_MODEL_RESTRICTION",
		4: "UNIQUE_MODEL_TYPE_RESTRICTION",
	}
	Model_PageOptimizationConfig_Restriction_value = map[string]int32{
		"RESTRICTION_UNSPECIFIED":           0,
		"NO_RESTRICTION":                    1,
		"UNIQUE_SERVING_CONFIG_RESTRICTION": 2,
		"UNIQUE_MODEL_RESTRICTION":          3,
		"UNIQUE_MODEL_TYPE_RESTRICTION":     4,
	}
)

Enum value maps for Model_PageOptimizationConfig_Restriction.

View Source
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.

View Source
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.

View Source
var (
	SearchRequest_RelevanceThreshold_name = map[int32]string{
		0: "RELEVANCE_THRESHOLD_UNSPECIFIED",
		1: "HIGH",
		2: "MEDIUM",
		3: "LOW",
		4: "LOWEST",
	}
	SearchRequest_RelevanceThreshold_value = map[string]int32{
		"RELEVANCE_THRESHOLD_UNSPECIFIED": 0,
		"HIGH":                            1,
		"MEDIUM":                          2,
		"LOW":                             3,
		"LOWEST":                          4,
	}
)

Enum value maps for SearchRequest_RelevanceThreshold.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
var File_google_cloud_retail_v2alpha_analytics_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_catalog_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_catalog_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_common_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_completion_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_control_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_control_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_export_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_import_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_merchant_center_account_link_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_merchant_center_account_link_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_model_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_model_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_prediction_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_product_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_product_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_promotion_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_purge_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_search_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_serving_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_serving_config_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_user_event_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterAnalyticsServiceServer added in v1.15.0

func RegisterAnalyticsServiceServer(s *grpc.Server, srv AnalyticsServiceServer)

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 RegisterMerchantCenterAccountLinkServiceServer added in v1.13.0

func RegisterMerchantCenterAccountLinkServiceServer(s *grpc.Server, srv MerchantCenterAccountLinkServiceServer)

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)

Types

type 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.v2alpha.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.v2alpha.CatalogService.AddCatalogAttribute] method.

func (*AddCatalogAttributeRequest) Descriptor deprecated

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 (*AddCatalogAttributeRequest) Reset

func (x *AddCatalogAttributeRequest) Reset()

func (*AddCatalogAttributeRequest) String

func (x *AddCatalogAttributeRequest) String() string

type 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 deprecated

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

type 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.v2alpha.ProductService.AddFulfillmentPlaces] method.

func (*AddFulfillmentPlacesMetadata) Descriptor deprecated

func (*AddFulfillmentPlacesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use AddFulfillmentPlacesMetadata.ProtoReflect.Descriptor instead.

func (*AddFulfillmentPlacesMetadata) ProtoMessage

func (*AddFulfillmentPlacesMetadata) ProtoMessage()

func (*AddFulfillmentPlacesMetadata) ProtoReflect

func (*AddFulfillmentPlacesMetadata) Reset

func (x *AddFulfillmentPlacesMetadata) Reset()

func (*AddFulfillmentPlacesMetadata) String

type AddFulfillmentPlacesRequest

type AddFulfillmentPlacesRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.FulfillmentInfo.type].
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Required. The IDs for this
	// [type][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.Product] is created. If set to false,
	// a NOT_FOUND error is returned if the
	// [Product][google.cloud.retail.v2alpha.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.v2alpha.ProductService.AddFulfillmentPlaces] method.

func (*AddFulfillmentPlacesRequest) Descriptor deprecated

func (*AddFulfillmentPlacesRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddFulfillmentPlacesRequest.ProtoReflect.Descriptor instead.

func (*AddFulfillmentPlacesRequest) GetAddTime

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 (*AddFulfillmentPlacesRequest) Reset

func (x *AddFulfillmentPlacesRequest) Reset()

func (*AddFulfillmentPlacesRequest) String

func (x *AddFulfillmentPlacesRequest) String() string

type 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.v2alpha.ProductService.AddFulfillmentPlaces] method.

func (*AddFulfillmentPlacesResponse) Descriptor deprecated

func (*AddFulfillmentPlacesResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddFulfillmentPlacesResponse.ProtoReflect.Descriptor instead.

func (*AddFulfillmentPlacesResponse) ProtoMessage

func (*AddFulfillmentPlacesResponse) ProtoMessage()

func (*AddFulfillmentPlacesResponse) ProtoReflect

func (*AddFulfillmentPlacesResponse) Reset

func (x *AddFulfillmentPlacesResponse) Reset()

func (*AddFulfillmentPlacesResponse) String

type 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.v2alpha.ProductService.AddLocalInventories] method.

func (*AddLocalInventoriesMetadata) Descriptor deprecated

func (*AddLocalInventoriesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use AddLocalInventoriesMetadata.ProtoReflect.Descriptor instead.

func (*AddLocalInventoriesMetadata) ProtoMessage

func (*AddLocalInventoriesMetadata) ProtoMessage()

func (*AddLocalInventoriesMetadata) ProtoReflect

func (*AddLocalInventoriesMetadata) Reset

func (x *AddLocalInventoriesMetadata) Reset()

func (*AddLocalInventoriesMetadata) String

func (x *AddLocalInventoriesMetadata) String() string

type AddLocalInventoriesRequest

type AddLocalInventoriesRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.Product] is created. If set to false,
	// a NOT_FOUND error is returned if the
	// [Product][google.cloud.retail.v2alpha.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.v2alpha.ProductService.AddLocalInventories] method.

func (*AddLocalInventoriesRequest) Descriptor deprecated

func (*AddLocalInventoriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddLocalInventoriesRequest.ProtoReflect.Descriptor instead.

func (*AddLocalInventoriesRequest) GetAddMask

func (*AddLocalInventoriesRequest) GetAddTime

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 (*AddLocalInventoriesRequest) Reset

func (x *AddLocalInventoriesRequest) Reset()

func (*AddLocalInventoriesRequest) String

func (x *AddLocalInventoriesRequest) String() string

type AddLocalInventoriesResponse

type AddLocalInventoriesResponse struct {
	// contains filtered or unexported fields
}

Response of the [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] method.

func (*AddLocalInventoriesResponse) Descriptor deprecated

func (*AddLocalInventoriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddLocalInventoriesResponse.ProtoReflect.Descriptor instead.

func (*AddLocalInventoriesResponse) ProtoMessage

func (*AddLocalInventoriesResponse) ProtoMessage()

func (*AddLocalInventoriesResponse) ProtoReflect

func (*AddLocalInventoriesResponse) Reset

func (x *AddLocalInventoriesResponse) Reset()

func (*AddLocalInventoriesResponse) String

func (x *AddLocalInventoriesResponse) String() string

type AnalyticsServiceClient added in v1.15.0

type AnalyticsServiceClient interface {
	// Exports analytics metrics.
	//
	// `Operation.response` is of type `ExportAnalyticsMetricsResponse`.
	// `Operation.metadata` is of type `ExportMetadata`.
	ExportAnalyticsMetrics(ctx context.Context, in *ExportAnalyticsMetricsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

AnalyticsServiceClient is the client API for AnalyticsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAnalyticsServiceClient added in v1.15.0

func NewAnalyticsServiceClient(cc grpc.ClientConnInterface) AnalyticsServiceClient

type AnalyticsServiceServer added in v1.15.0

type AnalyticsServiceServer interface {
	// Exports analytics metrics.
	//
	// `Operation.response` is of type `ExportAnalyticsMetricsResponse`.
	// `Operation.metadata` is of type `ExportMetadata`.
	ExportAnalyticsMetrics(context.Context, *ExportAnalyticsMetricsRequest) (*longrunningpb.Operation, error)
}

AnalyticsServiceServer is the server API for AnalyticsService service.

type AttributeConfigLevel

type AttributeConfigLevel int32

At which level we offer configuration for attributes.

const (
	// Value used when unset. In this case, server behavior defaults to
	// [CATALOG_LEVEL_ATTRIBUTE_CONFIG][google.cloud.retail.v2alpha.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.v2alpha.Product.attributes].
	AttributeConfigLevel_PRODUCT_LEVEL_ATTRIBUTE_CONFIG AttributeConfigLevel = 1
	// At this level, we honor the attribute configurations set in
	// [CatalogConfig.attribute_configs][google.cloud.retail.v2alpha.CatalogConfig.attribute_configs].
	AttributeConfigLevel_CATALOG_LEVEL_ATTRIBUTE_CONFIG AttributeConfigLevel = 2
)

func (AttributeConfigLevel) Descriptor

func (AttributeConfigLevel) Enum

func (AttributeConfigLevel) EnumDescriptor deprecated

func (AttributeConfigLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use AttributeConfigLevel.Descriptor instead.

func (AttributeConfigLevel) Number

func (AttributeConfigLevel) String

func (x AttributeConfigLevel) String() string

func (AttributeConfigLevel) Type

type AttributesConfig

type AttributesConfig struct {

	// Required. Immutable. The fully qualified resource name of the attribute
	// config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Enable attribute(s) config at catalog level.
	// For example, indexable, dynamic_facetable, or searchable for each
	// attribute.
	//
	// The key is catalog attribute's name.
	// For example: `color`, `brands`, `attributes.custom_attribute`, such as
	// `attributes.xyz`.
	//
	// The maximum number of catalog attributes allowed in a request is 1000.
	CatalogAttributes map[string]*CatalogAttribute `` /* 200-byte string literal not displayed */
	// Output only. The
	// [AttributeConfigLevel][google.cloud.retail.v2alpha.AttributeConfigLevel]
	// used for this catalog.
	AttributeConfigLevel AttributeConfigLevel `` /* 178-byte string literal not displayed */
	// contains filtered or unexported fields
}

Catalog level attribute config.

func (*AttributesConfig) Descriptor deprecated

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

type 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.v2alpha.Product] for whom it's sold.

func (*Audience) Descriptor deprecated

func (*Audience) Descriptor() ([]byte, []int)

Deprecated: Use Audience.ProtoReflect.Descriptor instead.

func (*Audience) GetAgeGroups

func (x *Audience) GetAgeGroups() []string

func (*Audience) GetGenders

func (x *Audience) GetGenders() []string

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

func (x *Audience) String() string

type BatchRemoveCatalogAttributesRequest added in v1.12.0

type BatchRemoveCatalogAttributesRequest struct {

	// Required. The attributes config resource shared by all catalog attributes
	// being deleted. 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 attribute name keys of the
	// [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s to
	// delete. A maximum of 1000 catalog attributes can be deleted in a batch.
	AttributeKeys []string `protobuf:"bytes,2,rep,name=attribute_keys,json=attributeKeys,proto3" json:"attribute_keys,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes] method.

func (*BatchRemoveCatalogAttributesRequest) Descriptor deprecated added in v1.12.0

func (*BatchRemoveCatalogAttributesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchRemoveCatalogAttributesRequest.ProtoReflect.Descriptor instead.

func (*BatchRemoveCatalogAttributesRequest) GetAttributeKeys added in v1.12.0

func (x *BatchRemoveCatalogAttributesRequest) GetAttributeKeys() []string

func (*BatchRemoveCatalogAttributesRequest) GetAttributesConfig added in v1.12.0

func (x *BatchRemoveCatalogAttributesRequest) GetAttributesConfig() string

func (*BatchRemoveCatalogAttributesRequest) ProtoMessage added in v1.12.0

func (*BatchRemoveCatalogAttributesRequest) ProtoMessage()

func (*BatchRemoveCatalogAttributesRequest) ProtoReflect added in v1.12.0

func (*BatchRemoveCatalogAttributesRequest) Reset added in v1.12.0

func (*BatchRemoveCatalogAttributesRequest) String added in v1.12.0

type BatchRemoveCatalogAttributesResponse added in v1.12.0

type BatchRemoveCatalogAttributesResponse struct {

	// Catalog attributes that were deleted. Only pre-loaded [catalog
	// attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are
	// neither [in
	// use][google.cloud.retail.v2alpha.CatalogAttribute.in_use] by
	// products nor predefined can be deleted.
	DeletedCatalogAttributes []string `` /* 135-byte string literal not displayed */
	// Catalog attributes that were reset. [Catalog
	// attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are either
	// [in use][google.cloud.retail.v2alpha.CatalogAttribute.in_use] by products
	// or are predefined attributes cannot be deleted; however, their
	// configuration properties will reset to default values upon removal request.
	ResetCatalogAttributes []string `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response of the [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes].

func (*BatchRemoveCatalogAttributesResponse) Descriptor deprecated added in v1.12.0

func (*BatchRemoveCatalogAttributesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchRemoveCatalogAttributesResponse.ProtoReflect.Descriptor instead.

func (*BatchRemoveCatalogAttributesResponse) GetDeletedCatalogAttributes added in v1.12.0

func (x *BatchRemoveCatalogAttributesResponse) GetDeletedCatalogAttributes() []string

func (*BatchRemoveCatalogAttributesResponse) GetResetCatalogAttributes added in v1.12.0

func (x *BatchRemoveCatalogAttributesResponse) GetResetCatalogAttributes() []string

func (*BatchRemoveCatalogAttributesResponse) ProtoMessage added in v1.12.0

func (*BatchRemoveCatalogAttributesResponse) ProtoMessage()

func (*BatchRemoveCatalogAttributesResponse) ProtoReflect added in v1.12.0

func (*BatchRemoveCatalogAttributesResponse)