1// Copyright 2021 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.retail.v2; 18 19import "google/api/annotations.proto"; 20import "google/api/client.proto"; 21import "google/api/field_behavior.proto"; 22import "google/api/resource.proto"; 23import "google/cloud/retail/v2/export_config.proto"; 24import "google/longrunning/operations.proto"; 25 26option csharp_namespace = "Google.Cloud.Retail.V2"; 27option go_package = "cloud.google.com/go/retail/apiv2/retailpb;retailpb"; 28option java_multiple_files = true; 29option java_outer_classname = "AnalyticsServiceProto"; 30option java_package = "com.google.cloud.retail.v2"; 31option objc_class_prefix = "RETAIL"; 32option php_namespace = "Google\\Cloud\\Retail\\V2"; 33option ruby_package = "Google::Cloud::Retail::V2"; 34 35// Service for managing & accessing retail search business metric. 36// Retail recommendation business metric is currently not available. 37service AnalyticsService { 38 option (google.api.default_host) = "retail.googleapis.com"; 39 option (google.api.oauth_scopes) = 40 "https://www.googleapis.com/auth/cloud-platform"; 41 42 // Exports analytics metrics. 43 // 44 // `Operation.response` is of type `ExportAnalyticsMetricsResponse`. 45 // `Operation.metadata` is of type `ExportMetadata`. 46 rpc ExportAnalyticsMetrics(ExportAnalyticsMetricsRequest) 47 returns (google.longrunning.Operation) { 48 option (google.api.http) = { 49 post: "/v2/{catalog=projects/*/locations/*/catalogs/*}:exportAnalyticsMetrics" 50 body: "*" 51 }; 52 option (google.longrunning.operation_info) = { 53 response_type: "google.cloud.retail.v2.ExportAnalyticsMetricsResponse" 54 metadata_type: "google.cloud.retail.v2.ExportMetadata" 55 }; 56 } 57} 58