@google-cloud/discoveryengine 0.7.0 → 1.0.0

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

@@ -66,7 +66,7 @@ message UserEvent {
   // quality.
   //
   // The field must be a UTF-8 encoded string with a length limit of 128
-  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  // characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   //
   // The field should not contain PII or user-data. We recommend to use Google
   // Analytics [Client
@@ -120,20 +120,20 @@ message UserEvent {
   //
   // The value must be one of:
   //
-  // * [PredictResponse.attribution_token][] for events that are the result of
+  // * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] for events that are the result of
   // [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
   // * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
   // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search].
-  // * [CompleteQueryResponse.attribution_token][] for events that are the
-  // result of
-  // [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery].
   //
   // This token enables us to accurately attribute page view or conversion
   // completion back to the event and the particular predict response containing
   // this clicked/purchased product. If user clicks on product K in the
-  // recommendation results, pass [PredictResponse.attribution_token][] as a URL
-  // parameter to product K's page. When recording events on product K's page,
-  // log the [PredictResponse.attribution_token][] to this field.
+  // recommendation results, pass
+  // [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token]
+  // as a URL parameter to product K's page. When recording events on product
+  // K's page, log the
+  // [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token]
+  // to this field.
   string attribution_token = 8;
 
   // The filter syntax consists of an expression language for constructing a
@@ -151,10 +151,11 @@ message UserEvent {
   // to https://google.aip.dev/160#filtering.
   //
   // The value must be a UTF-8 encoded string with a length limit of 1,000
-  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  // characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   string filter = 9;
 
-  // List of Documents associated with this user event.
+  // List of [Document][google.cloud.discoveryengine.v1beta.Document]s
+  // associated with this user event.
   //
   // This field is optional except for the following event types:
   //
@@ -176,12 +177,14 @@ message UserEvent {
   // Panel metadata associated with this user event.
   PanelInfo panel = 11;
 
-  // Search API details related to the event.
+  // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
+  // details related to the event.
   //
   // This field should be set for `search` event.
   SearchInfo search_info = 12;
 
-  // CompleteQuery API details related to the event.
+  // [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
+  // details related to the event.
   //
   // This field should be set for `search` event when autocomplete function is
   // enabled and the user clicks a suggestion for search.
@@ -221,7 +224,7 @@ message UserEvent {
   // * For number attributes, at most 400 values are allowed.
   //
   // For product recommendations, an example of extra user information is
-  // ` traffic_channel`, which is how a user arrives at the site. Users can
+  // `traffic_channel`, which is how a user arrives at the site. Users can
   // arrive
   // at the site by coming to the site directly, coming through Google
   // search, or in other ways.
@@ -237,7 +240,7 @@ message PageInfo {
   //
   // This should be kept the same for all user events triggered from the same
   // pageview. For example, an item detail page view could trigger multiple
-  // events as the user is browsing the page. The `pageViewId` property should
+  // events as the user is browsing the page. The `pageview_id` property should
   // be kept the same for all these events so that they can be grouped together
   // properly.
   //
@@ -253,10 +256,10 @@ message PageInfo {
   //
   // Category pages include special pages such as sales or promotions. For
   // instance, a special sale page may have the category hierarchy:
-  // "pageCategory" : "Sales > 2017 Black Friday Deals".
+  // `"pageCategory" : "Sales > 2017 Black Friday Deals"`.
   //
   // Required for `view-category-page` events. Other event types should not set
-  // this field. Otherwise, an INVALID_ARGUMENT error is returned.
+  // this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
   string page_category = 2;
 
   // Complete URL (window.location.href) of the user's current page.
@@ -283,14 +286,14 @@ message SearchInfo {
   // for definition.
   //
   // The value must be a UTF-8 encoded string with a length limit of 5,000
-  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  // characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   //
   // At least one of
   // [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
   // or
   // [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
   // is required for `search` events. Other event types should not set this
-  // field. Otherwise, an INVALID_ARGUMENT error is returned.
+  // field. Otherwise, an `INVALID_ARGUMENT` error is returned.
   string search_query = 1;
 
   // The order in which products are returned, if applicable.
@@ -300,10 +303,10 @@ message SearchInfo {
   // for definition and syntax.
   //
   // The value must be a UTF-8 encoded string with a length limit of 1,000
-  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  // characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   //
   // This can only be set for `search` events. Other event types should not set
-  // this field. Otherwise, an INVALID_ARGUMENT error is returned.
+  // this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
   string order_by = 2;
 
   // An integer that specifies the current offset for pagination (the 0-indexed
@@ -313,20 +316,22 @@ message SearchInfo {
   // [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset]
   // for definition.
   //
-  // If this field is negative, an INVALID_ARGUMENT is returned.
+  // If this field is negative, an `INVALID_ARGUMENT` is returned.
   //
   // This can only be set for `search` events. Other event types should not set
-  // this field. Otherwise, an INVALID_ARGUMENT error is returned.
+  // this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
   optional int32 offset = 3;
 }
 
 // Detailed completion information including completion attribution token and
 // clicked completion info.
 message CompletionInfo {
-  // End user selected [CompleteQueryResponse.CompletionResult.suggestion][].
+  // End user selected
+  // [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion.suggestion].
   string selected_suggestion = 1;
 
-  // End user selected [CompleteQueryResponse.CompletionResult.suggestion][]
+  // End user selected
+  // [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion.suggestion]
   // position, starting from 0.
   int32 selected_position = 2;
 }
@@ -396,17 +401,15 @@ message DocumentInfo {
   // `{location}`, `{collection_id}`, `{data_store_id}`, and
   // `{branch_id}` are used when annotating with the stored Document.
   oneof document_descriptor {
-    // Required. The Document resource ID.
-    string id = 1 [(google.api.field_behavior) = REQUIRED];
+    // The [Document][google.cloud.discoveryengine.v1beta.Document] resource ID.
+    string id = 1;
 
-    // Required. The Document resource full name, of the form:
+    // The [Document][google.cloud.discoveryengine.v1beta.Document] resource
+    // full name, of the form:
     // `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
-    string name = 2 [
-      (google.api.field_behavior) = REQUIRED,
-      (google.api.resource_reference) = {
-        type: "discoveryengine.googleapis.com/Document"
-      }
-    ];
+    string name = 2 [(google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Document"
+    }];
   }
 
   // Quantity of the Document associated with the user event. Defaults to 1.
@@ -450,11 +453,13 @@ message PanelInfo {
 message MediaInfo {
   // The media progress time in seconds, if applicable.
   // For example, if the end user has finished 90 seconds of a playback video,
-  // then [MediaInfo.media_progress_duration.seconds][Duration.seconds] should
-  // be set to 90.
+  // then
+  // [MediaInfo.media_progress_duration.seconds][google.protobuf.Duration.seconds]
+  // should be set to 90.
   google.protobuf.Duration media_progress_duration = 1;
 
-  // Media progress should be computed using only the media_progress_duration
+  // Media progress should be computed using only the
+  // [media_progress_duration][google.cloud.discoveryengine.v1beta.MediaInfo.media_progress_duration]
   // relative to the media total length.
   //
   // This value must be between `[0, 1.0]` inclusive.

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

@@ -53,7 +53,7 @@ service UserEventService {
   }
 
   // Writes a single user event from the browser. This uses a GET request to
-  // due to browser restriction of POST-ing to a 3rd party domain.
+  // due to browser restriction of POST-ing to a third-party domain.
   //
   // This method is used only by the Discovery Engine API JavaScript pixel and
   // Google Tag Manager. Users should not call this method directly.
@@ -122,7 +122,7 @@ message CollectUserEventRequest {
 
   // The URL including cgi-parameters but excluding the hash fragment with a
   // length limit of 5,000 characters. This is often more useful than the
-  // referer URL, because many browsers only send the domain for 3rd party
+  // referer URL, because many browsers only send the domain for third-party
   // requests.
   optional string uri = 3;