@google-cloud/discoveryengine 2.0.0 → 2.1.0

package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto

@@ -146,6 +146,52 @@ service SiteSearchEngineService {
     option (google.api.method_signature) = "parent";
   }
 
+  // Creates a [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
+  rpc CreateSitemap(CreateSitemapRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps"
+      body: "sitemap"
+      additional_bindings {
+        post: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps"
+        body: "sitemap"
+      }
+    };
+    option (google.api.method_signature) = "parent,sitemap";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1.Sitemap"
+      metadata_type: "google.cloud.discoveryengine.v1.CreateSitemapMetadata"
+    };
+  }
+
+  // Deletes a [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
+  rpc DeleteSitemap(DeleteSitemapRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/sitemaps/*}"
+      additional_bindings {
+        delete: "/v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "google.cloud.discoveryengine.v1.DeleteSitemapMetadata"
+    };
+  }
+
+  // Fetch [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in a
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore].
+  rpc FetchSitemaps(FetchSitemapsRequest) returns (FetchSitemapsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps:fetch"
+      additional_bindings {
+        get: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/sitemaps:fetch"
+      }
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
   // Upgrade from basic site search to advanced site search.
   rpc EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest)
       returns (google.longrunning.Operation) {
@@ -449,6 +495,125 @@ message BatchCreateTargetSitesResponse {
   repeated TargetSite target_sites = 1;
 }
 
+// Request message for
+// [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap]
+// method.
+message CreateSitemapRequest {
+  // Required. Parent resource name of the
+  // [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], such
+  // as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/SiteSearchEngine"
+    }
+  ];
+
+  // Required. The [Sitemap][google.cloud.discoveryengine.v1.Sitemap] to create.
+  Sitemap sitemap = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for
+// [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap]
+// method.
+message DeleteSitemapRequest {
+  // Required. Full resource name of
+  // [Sitemap][google.cloud.discoveryengine.v1.Sitemap], such as
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`.
+  //
+  // If the caller does not have permission to access the
+  // [Sitemap][google.cloud.discoveryengine.v1.Sitemap], regardless of whether
+  // or not it exists, a PERMISSION_DENIED error is returned.
+  //
+  // If the requested [Sitemap][google.cloud.discoveryengine.v1.Sitemap] does
+  // not exist, a NOT_FOUND error is returned.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Sitemap"
+    }
+  ];
+}
+
+// Request message for
+// [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps]
+// method.
+message FetchSitemapsRequest {
+  // Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s by
+  // their uris.
+  message UrisMatcher {
+    // The [Sitemap][google.cloud.discoveryengine.v1.Sitemap] uris.
+    repeated string uris = 1;
+  }
+
+  // Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s.
+  // Currently only supports uris matcher.
+  message Matcher {
+    // Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s.
+    oneof matcher {
+      // Matcher by sitemap URIs.
+      UrisMatcher uris_matcher = 1;
+    }
+  }
+
+  // Required. Parent resource name of the
+  // [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], such
+  // as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/SiteSearchEngine"
+    }
+  ];
+
+  // Optional. If specified, fetches the matching
+  // [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s. If not specified,
+  // fetches all [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in the
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore].
+  Matcher matcher = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Metadata related to the progress of the
+// [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message CreateSitemapMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}
+
+// Metadata related to the progress of the
+// [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message DeleteSitemapMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}
+
+// Response message for
+// [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps]
+// method.
+message FetchSitemapsResponse {
+  // Contains a [Sitemap][google.cloud.discoveryengine.v1.Sitemap] and its
+  // metadata.
+  message SitemapMetadata {
+    // The [Sitemap][google.cloud.discoveryengine.v1.Sitemap].
+    Sitemap sitemap = 1;
+  }
+
+  // List of [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s fetched.
+  repeated SitemapMetadata sitemaps_metadata = 1;
+}
+
 // Request message for
 // [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch]
 // method.
@@ -537,9 +702,7 @@ message RecrawlUrisRequest {
   // `site_search_engine`.
   repeated string uris = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // Optional. Full resource name of the [SiteCredential][], such as
-  // `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
-  // Only set to crawl private URIs.
+  // Optional. Credential id to use for crawling.
   string site_credential = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -598,10 +761,26 @@ message RecrawlUrisMetadata {
   // finish time.
   google.protobuf.Timestamp update_time = 2;
 
+  // Unique URIs in the request that have invalid format. Sample limited to
+  // 1000.
+  repeated string invalid_uris = 3;
+
+  // Total number of unique URIs in the request that have invalid format.
+  int32 invalid_uris_count = 8;
+
+  // URIs that have no index meta tag. Sample limited to 1000.
+  repeated string noindex_uris = 11;
+
+  // Total number of URIs that have no index meta tag.
+  int32 noindex_uris_count = 12;
+
   // Unique URIs in the request that don't match any TargetSite in the
   // DataStore, only match TargetSites that haven't been fully indexed, or match
-  // a TargetSite with type EXCLUDE.
-  repeated string invalid_uris = 3;
+  // a TargetSite with type EXCLUDE. Sample limited to 1000.
+  repeated string uris_not_matching_target_sites = 9;
+
+  // Total number of URIs that don't match any TargetSites.
+  int32 uris_not_matching_target_sites_count = 10;
 
   // Total number of unique URIs in the request that are not in invalid_uris.
   int32 valid_uris_count = 4;

package/build/protos/google/cloud/discoveryengine/v1/user_event.proto

@@ -43,6 +43,7 @@ message UserEvent {
   // * `view-item-list`: View of a panel or ordered list of Documents.
   // * `view-home-page`: View of the home page.
   // * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
+  // * `add-feedback`: Add a user feedback.
   //
   // Retail-related values:
   //
@@ -53,8 +54,25 @@ message UserEvent {
   //
   // * `media-play`: Start/resume watching a video, playing a song, etc.
   // * `media-complete`: Finished or stopped midway through a video, song, etc.
+  //
+  // Custom conversion value:
+  //
+  // * `conversion`: Customer defined conversion event.
   string event_type = 1 [(google.api.field_behavior) = REQUIRED];
 
+  // Optional. Conversion type.
+  //
+  // Required if
+  // [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type]
+  // is `conversion`. This is a customer-defined conversion name in lowercase
+  // letters or numbers separated by "-", such as "watch", "good-visit" etc.
+  //
+  // Do not set the field if
+  // [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type]
+  // is not `conversion`. This mixes the custom conversion event with predefined
+  // events like `search`, `view-item` etc.
+  string conversion_type = 21 [(google.api.field_behavior) = OPTIONAL];
+
   // Required. A unique identifier for tracking visitors.
   //
   // For example, this could be implemented with an HTTP cookie, which should be
@@ -258,6 +276,10 @@ message UserEvent {
 
   // Media-specific info.
   MediaInfo media_info = 18;
+
+  // Optional. List of panels associated with this event.
+  // Used for page-level impression data.
+  repeated PanelInfo panels = 22 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Detailed page information.
@@ -457,6 +479,15 @@ message DocumentInfo {
   // Output only. Whether the referenced Document can be found in the data
   // store.
   bool joined = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The conversion value associated with this Document.
+  // Must be set if
+  // [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type]
+  // is "conversion".
+  //
+  // For example, a value of 1000 signifies that 1000 seconds were spent viewing
+  // a Document for the `watch` conversion type.
+  optional float conversion_value = 7 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Detailed panel information associated with a user event.
@@ -478,6 +509,9 @@ message PanelInfo {
   // [panel_position][google.cloud.discoveryengine.v1.PanelInfo.panel_position]
   // is set.
   optional int32 total_panels = 5;
+
+  // Optional. The document IDs associated with this panel.
+  repeated DocumentInfo documents = 6 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Media-specific user event information.

package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto

@@ -110,6 +110,10 @@ service UserEventService {
         post: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import"
         body: "*"
       }
+      additional_bindings {
+        post: "/v1/{parent=projects/*/locations/*}/userEvents:import"
+        body: "*"
+      }
     };
     option (google.longrunning.operation_info) = {
       response_type: "google.cloud.discoveryengine.v1.ImportUserEventsResponse"
@@ -125,9 +129,9 @@ message WriteUserEventRequest {
   // [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
   // is:
   // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
-  // If the write user event action is applied in [Location][] level, for
-  // example, the event with
-  // [Document][google.cloud.discoveryengine.v1.Document] across multiple
+  // If the write user event action is applied in
+  // [Location][google.cloud.location.Location] level, for example, the event
+  // with [Document][google.cloud.discoveryengine.v1.Document] across multiple
   // [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
   // `projects/{project}/locations/{location}`.
   string parent = 1 [
@@ -147,8 +151,16 @@ message WriteUserEventRequest {
 
 // Request message for CollectUserEvent method.
 message CollectUserEventRequest {
-  // Required. The parent DataStore resource name, such as
+  // Required. The parent resource name.
+  // If the collect user event action is applied in
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
+  // is:
   // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+  // If the collect user event action is applied in
+  // [Location][google.cloud.location.Location] level, for example, the event
+  // with [Document][google.cloud.discoveryengine.v1.Document] across multiple
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
+  // `projects/{project}/locations/{location}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {