@google-cloud/discoveryengine 1.3.1 → 1.4.1

package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto

@@ -0,0 +1,265 @@
+// Copyright 2022 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.discoveryengine.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1beta/common.proto";
+import "google/cloud/discoveryengine/v1beta/search_service.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "ServingConfigProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Configures metadata that is used to generate serving time results (e.g.
+// search results or recommendation predictions).
+// The ServingConfig is passed in the search and predict request and generates
+// results.
+message ServingConfig {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/ServingConfig"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}"
+  };
+
+  // Specifies the configurations needed for Media Discovery. Currently we
+  // support:
+  //
+  // * `demote_content_watched`: Threshold for watched content demotion.
+  // Customers can specify if using watched content demotion or use viewed
+  // detail page. Using the content watched demotion, customers need to specify
+  // the watched minutes or percentage exceeds the threshold, the content will
+  // be demoted in the recommendation result.
+  // * `promote_fresh_content`: cutoff days for fresh content promotion.
+  // Customers can specify if using content freshness promotion. If the content
+  // was published within the cutoff days, the content will be promoted in the
+  // recommendation result.
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+  message MediaConfig {
+    // Specify the threshold for demoting watched content, the threshold can be
+    // either percentage or minutes value.
+    // This must be set for `media-complete` event type.
+    oneof demote_content_watched {
+      // Specifies the content watched percentage threshold for demotion.
+      // Threshold value must be between [0, 1.0] inclusive.
+      float content_watched_percentage_threshold = 2;
+
+      // Specifies the content watched minutes threshold for demotion.
+      float content_watched_seconds_threshold = 5;
+    }
+
+    // Specifies the event type used for demoting recommendation result.
+    // Currently supported values:
+    //
+    // * `view-item`: Item viewed.
+    // * `media-play`: Start/resume watching a video, playing a song, etc.
+    // * `media-complete`: Finished or stopped midway through a video, song,
+    // etc.
+    //
+    // If unset, watch history demotion will not be applied. Content freshness
+    // demotion will still be applied.
+    string demotion_event_type = 1;
+
+    // Specifies the content freshness used for recommendation result.
+    // Contents will be demoted if contents were published for more than content
+    // freshness cutoff days.
+    int32 content_freshness_cutoff_days = 4;
+  }
+
+  // Specifies the configurations needed for Generic Discovery.Currently we
+  // support:
+  //
+  // * `content_search_spec`: configuration for generic content search.
+  message GenericConfig {
+    // Specifies the expected behavior of content search.
+    // Only valid for content-search enabled data store.
+    SearchRequest.ContentSearchSpec content_search_spec = 1;
+  }
+
+  // Industry vertical specific config.
+  oneof vertical_config {
+    // The MediaConfig of the serving configuration.
+    MediaConfig media_config = 7;
+
+    // The GenericConfig of the serving configuration.
+    GenericConfig generic_config = 10;
+  }
+
+  // Immutable. Fully qualified name
+  // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Required. The human readable serving config display name. Used in Discovery
+  // UI.
+  //
+  // 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];
+
+  // Required. Immutable. Specifies the solution type that a serving config can
+  // be associated with.
+  SolutionType solution_type = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // The id of the model to use at serving time.
+  // Currently only RecommendationModels are supported.
+  // Can be changed but only to a compatible model (e.g.
+  // others-you-may-like CTR to others-you-may-like CVR).
+  //
+  // Required when
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+  string model_id = 4;
+
+  // How much diversity to use in recommendation model results e.g.
+  // `medium-diversity` or `high-diversity`. Currently supported values:
+  //
+  // * `no-diversity`
+  // * `low-diversity`
+  // * `medium-diversity`
+  // * `high-diversity`
+  // * `auto-diversity`
+  //
+  // If not specified, we choose default based on recommendation model
+  // type. Default value: `no-diversity`.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+  string diversity_level = 5;
+
+  // Bring your own embedding config. The config is used for search semantic
+  // retrieval. The retrieval is based on the dot product of
+  // [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
+  // and the document embeddings that are provided by this EmbeddingConfig. If
+  // [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
+  // is provided, it overrides this
+  // [ServingConfig.embedding_config][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
+  EmbeddingConfig embedding_config = 20;
+
+  // The ranking expression controls the customized ranking on retrieval
+  // documents. To leverage this, document embedding is required. The ranking
+  // expression setting in ServingConfig applies to all search requests served
+  // by the serving config. However, if
+  // [SearchRequest.ranking_expression][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression]
+  // is specified, it overrides the ServingConfig ranking expression.
+  //
+  // The ranking expression is a single function or multiple functions that are
+  // joined by "+".
+  //   * ranking_expression = function, { " + ", function };
+  // Supported functions:
+  //   * double * relevance_score
+  //   * double * dotProduct(embedding_field_path)
+  // Function variables:
+  //   relevance_score: pre-defined keywords, used for measure relevance between
+  //   query and document.
+  //   embedding_field_path: the document embedding field
+  //   used with query embedding vector.
+  //   dotProduct: embedding function between embedding_field_path and query
+  //   embedding vector.
+  //
+  //  Example ranking expression:
+  //    If document has an embedding field doc_embedding, the ranking expression
+  //    could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
+  string ranking_expression = 21;
+
+  // Output only. ServingConfig created timestamp.
+  google.protobuf.Timestamp create_time = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. ServingConfig updated timestamp.
+  google.protobuf.Timestamp update_time = 9
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Filter controls to use in serving path.
+  // All triggered filter controls will be applied.
+  // Filter controls must be in the same data store as the serving config.
+  // Maximum of 20 filter controls.
+  repeated string filter_control_ids = 11;
+
+  // Boost controls to use in serving path.
+  // All triggered boost controls will be applied.
+  // Boost controls must be in the same data store as the serving config.
+  // Maximum of 20 boost controls.
+  repeated string boost_control_ids = 12;
+
+  // IDs of the redirect controls. Only the first triggered redirect
+  // action is applied, even if multiple apply. Maximum number of
+  // specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string redirect_control_ids = 14;
+
+  // Condition synonyms specifications. If multiple synonyms conditions
+  // match, all matching synonyms controls in the list will execute.
+  // Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string synonyms_control_ids = 15;
+
+  // Condition oneway synonyms specifications. If multiple oneway synonyms
+  // conditions match, all matching oneway synonyms controls in the list
+  // will execute. Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string oneway_synonyms_control_ids = 16;
+
+  // Condition do not associate specifications. If multiple do not
+  // associate conditions match, all matching do not associate controls in
+  // the list will execute.
+  // Order does not matter.
+  // Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string dissociate_control_ids = 17;
+
+  // Condition replacement specifications.
+  // Applied according to the order in the list.
+  // A previously replaced term can not be re-replaced.
+  // Maximum number of specifications is 100.
+  //
+  // Can only be set if
+  // [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
+  repeated string replacement_control_ids = 18;
+
+  // Condition ignore specifications. If multiple ignore
+  // conditions match, all matching ignore controls in the list will
+  // execute.
+  // Order does not matter.
+  // Maximum number of specifications is 100.
+  repeated string ignore_control_ids = 19;
+}

package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto

@@ -0,0 +1,148 @@
+// Copyright 2022 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.discoveryengine.v1beta;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1beta/serving_config.proto";
+import "google/protobuf/field_mask.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "ServingConfigServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Service for operations related to
+// [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig].
+service ServingConfigService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Updates a ServingConfig.
+  //
+  // Returns a NOT_FOUND error if the ServingConfig does not exist.
+  rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig) {
+    option (google.api.http) = {
+      patch: "/v1beta/{serving_config.name=projects/*/locations/*/dataStores/*/servingConfigs/*}"
+      body: "serving_config"
+      additional_bindings {
+        patch: "/v1beta/{serving_config.name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}"
+        body: "serving_config"
+      }
+      additional_bindings {
+        patch: "/v1beta/{serving_config.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}"
+        body: "serving_config"
+      }
+    };
+    option (google.api.method_signature) = "serving_config,update_mask";
+  }
+
+  // Gets a ServingConfig.
+  //
+  // Returns a NotFound error if the ServingConfig does not exist.
+  rpc GetServingConfig(GetServingConfigRequest) returns (ServingConfig) {
+    option (google.api.http) = {
+      get: "/v1beta/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}"
+      additional_bindings {
+        get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}"
+      }
+      additional_bindings {
+        get: "/v1beta/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all ServingConfigs linked to this dataStore.
+  rpc ListServingConfigs(ListServingConfigsRequest)
+      returns (ListServingConfigsResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/servingConfigs"
+      additional_bindings {
+        get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigs"
+      }
+      additional_bindings {
+        get: "/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs"
+      }
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request for UpdateServingConfig method.
+message UpdateServingConfigRequest {
+  // Required. The ServingConfig to update.
+  ServingConfig serving_config = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Indicates which fields in the provided
+  // [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] to
+  // update. The following are NOT supported:
+  //
+  // * [ServingConfig.name][google.cloud.discoveryengine.v1beta.ServingConfig.name]
+  //
+  // If not set, all supported fields are updated.
+  google.protobuf.FieldMask update_mask = 2;
+}
+
+// Request for GetServingConfig method.
+message GetServingConfigRequest {
+  // Required. The resource name of the ServingConfig to get. Format:
+  // `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/ServingConfig"
+    }
+  ];
+}
+
+// Request for ListServingConfigs method.
+message ListServingConfigsRequest {
+  // Required. Full resource name of the parent resource. Format:
+  // `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "discoveryengine.googleapis.com/ServingConfig"
+    }
+  ];
+
+  // Optional. Maximum number of results to return. If unspecified, defaults
+  // to 100. If a value greater than 100 is provided, at most 100 results are
+  // returned.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A page token, received from a previous `ListServingConfigs` call.
+  // Provide this to retrieve the subsequent page.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response for ListServingConfigs method.
+message ListServingConfigsResponse {
+  // All the ServingConfigs for a given dataStore.
+  repeated ServingConfig serving_configs = 1;
+
+  // Pagination token, if not returned indicates the last page.
+  string next_page_token = 2;
+}

package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto

@@ -0,0 +1,170 @@
+// Copyright 2022 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.discoveryengine.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "SiteSearchEngineProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// SiteSearchEngine captures DataStore level site search persisting
+// configurations. It is a singleton value per data store.
+message SiteSearchEngine {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/SiteSearchEngine"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine"
+  };
+
+  // The fully qualified resource name of the site search engine.
+  // Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
+  string name = 1;
+}
+
+// A target site for the SiteSearchEngine.
+message TargetSite {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/TargetSite"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}"
+  };
+
+  // Site search indexing failure reasons.
+  message FailureReason {
+    // Failed due to insufficient quota.
+    message QuotaFailure {
+      // This number is an estimation on how much total quota this project needs
+      // to successfully complete indexing.
+      int64 total_required_quota = 1;
+    }
+
+    // Failure reason.
+    oneof failure {
+      // Failed due to insufficient quota.
+      QuotaFailure quota_failure = 1;
+    }
+  }
+
+  // Possible target site types.
+  enum Type {
+    // This value is unused. In this case, server behavior defaults to
+    // [Type.INCLUDE][google.cloud.discoveryengine.v1beta.TargetSite.Type.INCLUDE].
+    TYPE_UNSPECIFIED = 0;
+
+    // Include the target site.
+    INCLUDE = 1;
+
+    // Exclude the target site.
+    EXCLUDE = 2;
+  }
+
+  // Target site indexing status enumeration.
+  enum IndexingStatus {
+    // Defaults to SUCCEEDED.
+    INDEXING_STATUS_UNSPECIFIED = 0;
+
+    // The target site is in the update queue and will be picked up by indexing
+    // pipeline.
+    PENDING = 1;
+
+    // The target site fails to be indexed.
+    FAILED = 2;
+
+    // The target site has been indexed.
+    SUCCEEDED = 3;
+
+    // The previously indexed target site has been marked to be deleted. This is
+    // a transitioning state which will resulted in either:
+    // 1. target site deleted if unindexing is successful;
+    // 2. state reverts to SUCCEEDED if the unindexing fails.
+    DELETING = 4;
+  }
+
+  // Output only. The fully qualified resource name of the target site.
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
+  // The `target_site_id` is system-generated.
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. Input only. The user provided URI pattern from which the
+  // `generated_uri_pattern` is generated.
+  string provided_uri_pattern = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = INPUT_ONLY
+  ];
+
+  // The type of the target site, e.g., whether the site is to be included or
+  // excluded.
+  Type type = 3;
+
+  // Input only. If set to false, a uri_pattern is generated to include all
+  // pages whose address contains the provided_uri_pattern. If set to true, an
+  // uri_pattern is generated to try to be an exact match of the
+  // provided_uri_pattern or just the specific page if the provided_uri_pattern
+  // is a specific one. provided_uri_pattern is always normalized to
+  // generate the URI pattern to be used by the search engine.
+  bool exact_match = 6 [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Output only. This is system-generated based on the provided_uri_pattern.
+  string generated_uri_pattern = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Site ownership and validity verification status.
+  SiteVerificationInfo site_verification_info = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indexing status.
+  IndexingStatus indexing_status = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The target site's last updated time.
+  google.protobuf.Timestamp update_time = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Failure reason.
+  FailureReason failure_reason = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Verification information for target sites in advanced site search.
+message SiteVerificationInfo {
+  // Site verification state.
+  enum SiteVerificationState {
+    // Defaults to VERIFIED.
+    SITE_VERIFICATION_STATE_UNSPECIFIED = 0;
+
+    // Site ownership verified.
+    VERIFIED = 1;
+
+    // Site ownership pending verification or verification failed.
+    UNVERIFIED = 2;
+
+    // Site exempt from verification, e.g., a public website that opens to all.
+    EXEMPTED = 3;
+  }
+
+  // Site verification state indicating the ownership and validity.
+  SiteVerificationState site_verification_state = 1;
+
+  // Latest site verification time.
+  google.protobuf.Timestamp verify_time = 2;
+}