@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20230620 → 0.0.20230629

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
-// Revision: 20230620
+// Revision: 20230629
 
 /// <reference types="gapi.client" />
 
@@ -133,7 +133,7 @@ declare namespace gapi.client {
         }
         interface GoogleCloudDiscoveryengineV1alphaImportErrorConfig {
             /**
-             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a
+             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a
              * JSON-encoded `google.rpc.Status` message.
              */
             gcsPrefix?:
@@ -224,9 +224,9 @@ declare namespace gapi.client {
         }
         interface GoogleCloudDiscoveryengineV1alphaTargetSite {
             /**
-             * Input only. If set to false, an uri_pattern will be generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern will be 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 will always be normalized to
-             * generate the uri pattern to be used by the search engine.
+             * 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.
              */
             exactMatch?:
                 boolean;
@@ -239,7 +239,7 @@ declare namespace gapi.client {
              */
             name?:
                 string;
-            /** Required. Input only. The user provided uri pattern from which the `generated_uri_pattern` is generated. */
+            /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
             providedUriPattern?:
                 string;
             /** The type of the target site, e.g. whether the site is to be included or excluded. */
@@ -253,7 +253,7 @@ declare namespace gapi.client {
             /**
              * The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document
              * imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One
-             * custom data per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
+             * custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.
              */
             dataSchema?:
                 string;
@@ -277,10 +277,10 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDiscoveryengineV1betaCompletionInfo {
-            /** End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0. */
+            /** End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. */
             selectedPosition?:
                 number;
-            /** End user selected CompleteQueryResponse.CompletionResult.suggestion. */
+            /** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
             selectedSuggestion?:
                 string;
         }
@@ -302,7 +302,7 @@ declare namespace gapi.client {
             /** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
             id?:
                 string;
-            /** The JSON string representation of the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown. */
+            /** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
             jsonData?:
                 string;
             /**
@@ -321,7 +321,7 @@ declare namespace gapi.client {
             /** The identifier of the schema located in the same data store. */
             schemaId?:
                 string;
-            /** The structured JSON data for the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown. */
+            /** The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
             structData?:
                 { [P in string]: any };
         }
@@ -344,17 +344,17 @@ declare namespace gapi.client {
              */
             quantity?:
                 number;
-            /** The Document url - only allowed for DataStores with content_config PUBLIC_WEBSITE. */
+            /** The Document URI - only allowed for website data stores. */
             uri?:
                 string;
         }
         interface GoogleCloudDiscoveryengineV1betaGcsSource {
             /**
              * The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid
-             * Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded
-             * as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store
-             * vertical. * `csv`: A CSV file with header conforming the defined Schema of the data store. Each entry after the header will be imported as a Document. This can only be used by the
-             * GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
+             * Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a
+             * hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A
+             * CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported
+             * values for user even imports: * `user_event` (default): One JSON UserEvent per line.
              */
             dataSchema?:
                 string;
@@ -384,7 +384,7 @@ declare namespace gapi.client {
             /**
              * Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be
              * consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be
-             * specified using id_field, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or
+             * specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or
              * BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
              */
             autoGenerateIds?:
@@ -400,9 +400,9 @@ declare namespace gapi.client {
                 GoogleCloudDiscoveryengineV1betaGcsSource;
             /**
              * The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON
-             * `{"my_id": "some_uuid"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column will be
+             * `{"my_id": "some_uuid"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column are
              * used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to
-             * [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs will fail to be imported. Only set this field when using GcsSource or
+             * [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when using GcsSource or
              * BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an
              * INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.
              */
@@ -430,7 +430,7 @@ declare namespace gapi.client {
         }
         interface GoogleCloudDiscoveryengineV1betaImportErrorConfig {
             /**
-             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a
+             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a
              * JSON-encoded `google.rpc.Status` message.
              */
             gcsPrefix?:
@@ -509,14 +509,14 @@ declare namespace gapi.client {
             /**
              * The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name,
              * please replace it with other character(s). 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". Required for `view-category-page` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
-             * returned.
+             * `"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.
              */
             pageCategory?:
                 string;
             /**
              * A unique ID of a web page view. 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 be kept the same for all these events so that they can be grouped together properly. When using the client
+             * 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. When using the client
              * side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
              */
             pageviewId?:
@@ -669,22 +669,22 @@ declare namespace gapi.client {
         interface GoogleCloudDiscoveryengineV1betaSearchInfo {
             /**
              * An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for
-             * definition. 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.
+             * definition. 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.
              */
             offset?:
                 number;
             /**
              * The order in which products are returned, if applicable. See SearchRequest.order_by 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. This can only be set for `search` events. Other event types should not set this field. 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.
              */
             orderBy?:
                 string;
             /**
-             * The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT
+             * The user's search query. See SearchRequest.query 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. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an
-             * INVALID_ARGUMENT error is returned.
+             * `INVALID_ARGUMENT` error is returned.
              */
             searchQuery?:
                 string;
@@ -723,22 +723,25 @@ declare namespace gapi.client {
              * consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving
              * predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8
              * encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded
-             * string with a length limit of 256 characters. * 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 arrive at the site by coming to the site directly, coming through Google search, or in other ways.
+             * string with a length limit of 256 characters. * 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 arrive at the site by coming to the site directly, coming through Google search, or in other ways.
              */
             attributes?:
                 { [P in string]: GoogleCloudDiscoveryengineV1betaCustomAttribute };
             /**
              * Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field
-             * enables accurate attribution of recommendation model performance. The value must be one of: * PredictResponse.attribution_token for events that are the result of
-             * RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. * CompleteQueryResponse.attribution_token for events that
-             * are the result of 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.
+             * enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of
+             * RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. 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 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 to this
+             * field.
              */
             attributionToken?:
                 string;
-            /** CompleteQuery API 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. */
+            /**
+             * 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.
+             */
             completionInfo?:
                 GoogleCloudDiscoveryengineV1betaCompletionInfo;
             /**
@@ -770,7 +773,7 @@ declare namespace gapi.client {
              * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the
              * associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are
              * generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming 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.
+             * 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.
              */
             filter?:
                 string;
@@ -786,7 +789,7 @@ declare namespace gapi.client {
             /** The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. */
             promotionIds?:
                 string[];
-            /** Search API details related to the event. This field should be set for `search` event. */
+            /** SearchService.Search details related to the event. This field should be set for `search` event. */
             searchInfo?:
                 GoogleCloudDiscoveryengineV1betaSearchInfo;
             /**
@@ -812,7 +815,7 @@ declare namespace gapi.client {
              * Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single
              * device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event
              * history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
-             * INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client
+             * `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client
              * ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
              */
             userPseudoId?:
@@ -820,9 +823,8 @@ declare namespace gapi.client {
         }
         interface GoogleCloudDiscoveryengineV1betaUserInfo {
             /**
-             * User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters.
-             * Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent
-             * or if UserEvent.direct_user_request is set.
+             * User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This
+             * should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
              */
             userAgent?:
                 string;
@@ -858,7 +860,7 @@ declare namespace gapi.client {
         }
         interface GoogleCloudDiscoveryengineV1ImportErrorConfig {
             /**
-             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a
+             * Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a
              * JSON-encoded `google.rpc.Status` message.
              */
             gcsPrefix?:
@@ -1302,7 +1304,7 @@ declare namespace gapi.client {
                     string;
                 /**
                  * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
-                 * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether
+                 * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether
                  * or not this branch exists, a `PERMISSION_DENIED` error is returned.
                  */
                 parent:
@@ -1962,7 +1964,7 @@ declare namespace gapi.client {
         }
         interface UserEventsResource {
             /**
-             * 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. This method is used only by the Discovery
+             * Writes a single user event from the browser. This uses a GET request to 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.
              */
             collect(request?: {
@@ -2007,7 +2009,7 @@ declare namespace gapi.client {
                     string;
                 /**
                  * 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 requests.
+                 * only send the domain for third-party requests.
                  */
                 uri?:
                     string;
@@ -2696,7 +2698,7 @@ declare namespace gapi.client {
                     string;
                 /**
                  * Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
-                 * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether
+                 * `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether
                  * or not this branch exists, a `PERMISSION_DENIED` error is returned.
                  */
                 parent:
@@ -3263,7 +3265,7 @@ declare namespace gapi.client {
         }
         interface UserEventsResource {
             /**
-             * 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. This method is used only by the Discovery
+             * Writes a single user event from the browser. This uses a GET request to 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.
              */
             collect(request?: {
@@ -3308,7 +3310,7 @@ declare namespace gapi.client {
                     string;
                 /**
                  * 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 requests.
+                 * only send the domain for third-party requests.
                  */
                 uri?:
                     string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
-  "version": "0.0.20230620",
+  "version": "0.0.20230629",
   "description": "TypeScript typings for Discovery Engine API v1beta",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230620
+// Revision: 20230629
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -260,7 +260,7 @@ gapi.load('client', async () => {
             validateOnly: true,
         });
         /**
-         * 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. This method is used only by the Discovery Engine
+         * Writes a single user event from the browser. This uses a GET request to 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.
          */
         await gapi.client.discoveryengine.projects.locations.collections.dataStores.userEvents.collect({
@@ -693,7 +693,7 @@ gapi.load('client', async () => {
             validateOnly: true,
         });
         /**
-         * 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. This method is used only by the Discovery Engine
+         * Writes a single user event from the browser. This uses a GET request to 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.
          */
         await gapi.client.discoveryengine.projects.locations.dataStores.userEvents.collect({