99 lines
3.5 KiB
Protocol Buffer
99 lines
3.5 KiB
Protocol Buffer
// Copyright 2020 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
syntax = "proto3";
|
|
|
|
package google.cloud.retail.v2alpha;
|
|
|
|
import "google/api/annotations.proto";
|
|
import "google/api/field_behavior.proto";
|
|
import "google/api/resource.proto";
|
|
|
|
option csharp_namespace = "Google.Cloud.Retail.V2Alpha";
|
|
option go_package = "google.golang.org/genproto/googleapis/cloud/retail/v2alpha;retail";
|
|
option java_multiple_files = true;
|
|
option java_outer_classname = "CatalogProto";
|
|
option java_package = "com.google.cloud.retail.v2alpha";
|
|
option objc_class_prefix = "RETAIL";
|
|
option php_namespace = "Google\\Cloud\\Retail\\V2alpha";
|
|
option ruby_package = "Google::Cloud::Retail::V2alpha";
|
|
|
|
// Configures what level the product should be uploaded with regards to
|
|
// how users will be send events and how predictions will be made.
|
|
message ProductLevelConfig {
|
|
// The level of a [Catalog][google.cloud.retail.v2alpha.Catalog] at which the
|
|
// [UserEvent][google.cloud.retail.v2alpha.UserEvent]s are uploaded.
|
|
// Acceptable values are:
|
|
// * `primary`
|
|
// * `variant`
|
|
//
|
|
// If this field is set to an invalid value other than these, an
|
|
// INVALID_ARGUMENT error is returned.
|
|
//
|
|
// If this field is `primary` and
|
|
// [predict_product_level][google.cloud.retail.v2alpha.ProductLevelConfig.predict_product_level]
|
|
// is `variant`, an INVALID_ARGUMENT error is returned.
|
|
//
|
|
// See
|
|
// https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels
|
|
// for more details.
|
|
string event_product_level = 1;
|
|
|
|
// The level of a [Catalog][google.cloud.retail.v2alpha.Catalog] at which the
|
|
// [PredictionService.Predict][google.cloud.retail.v2alpha.PredictionService.Predict]
|
|
// is called. Acceptable values are:
|
|
// * `primary`
|
|
// * `variant`
|
|
//
|
|
// If this field is set to an invalid value other than these, an
|
|
// INVALID_ARGUMENT error is returned.
|
|
//
|
|
// If this field is `variant` and
|
|
// [event_product_level][google.cloud.retail.v2alpha.ProductLevelConfig.event_product_level]
|
|
// is `primary`, an INVALID_ARGUMENT error is returned.
|
|
//
|
|
// See
|
|
// https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels
|
|
// for more details.
|
|
string predict_product_level = 2;
|
|
}
|
|
|
|
// The catalog configuration.
|
|
// Next ID: 5.
|
|
message Catalog {
|
|
option (google.api.resource) = {
|
|
type: "retail.googleapis.com/Catalog"
|
|
pattern: "projects/{project}/locations/{location}/catalogs/{catalog}"
|
|
};
|
|
|
|
// Required. Immutable. The fully qualified resource name of the catalog.
|
|
string name = 1 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.field_behavior) = IMMUTABLE
|
|
];
|
|
|
|
// 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.
|
|
string display_name = 2 [
|
|
(google.api.field_behavior) = REQUIRED,
|
|
(google.api.field_behavior) = IMMUTABLE
|
|
];
|
|
|
|
// Required. The product level configuration.
|
|
ProductLevelConfig product_level_config = 4
|
|
[(google.api.field_behavior) = REQUIRED];
|
|
}
|