@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241122 → 0.0.20241123

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +63 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20241122
12
+ // Revision: 20241123
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -396,6 +396,8 @@ declare namespace gapi.client {
396
396
  filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
397
397
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
398
398
  name?: string;
399
+ /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
400
+ promoteAction?: GoogleCloudDiscoveryengineV1alphaControlPromoteAction;
399
401
  /** Defines a redirect-type control. */
400
402
  redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
401
403
  /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
@@ -419,6 +421,12 @@ declare namespace gapi.client {
419
421
  /** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
420
422
  filter?: string;
421
423
  }
424
+ interface GoogleCloudDiscoveryengineV1alphaControlPromoteAction {
425
+ /** Required. Data store with which this promotion is attached to. */
426
+ dataStore?: string;
427
+ /** Required. Promotion attached to this action. */
428
+ searchLinkPromotion?: GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion;
429
+ }
422
430
  interface GoogleCloudDiscoveryengineV1alphaControlRedirectAction {
423
431
  /** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
424
432
  redirectUri?: string;
@@ -1098,6 +1106,18 @@ declare namespace gapi.client {
1098
1106
  /** The structured representation of the schema. */
1099
1107
  structSchema?: {[P in string]: any};
1100
1108
  }
1109
+ interface GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion {
1110
+ /** Optional. The Promotion description. Maximum length: 200 characters. */
1111
+ description?: string;
1112
+ /** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
1113
+ enabled?: boolean;
1114
+ /** Optional. The promotion thumbnail image url. */
1115
+ imageUri?: string;
1116
+ /** Required. The title of the promotion. Maximum length: 160 characters. */
1117
+ title?: string;
1118
+ /** Required. The URL for the page the user wants to promote. */
1119
+ uri?: string;
1120
+ }
1101
1121
  interface GoogleCloudDiscoveryengineV1alphaSearchRequest {
1102
1122
  /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
1103
1123
  boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
@@ -1879,6 +1899,8 @@ declare namespace gapi.client {
1879
1899
  filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
1880
1900
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
1881
1901
  name?: string;
1902
+ /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
1903
+ promoteAction?: GoogleCloudDiscoveryengineV1betaControlPromoteAction;
1882
1904
  /** Defines a redirect-type control. */
1883
1905
  redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
1884
1906
  /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
@@ -1902,6 +1924,12 @@ declare namespace gapi.client {
1902
1924
  /** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
1903
1925
  filter?: string;
1904
1926
  }
1927
+ interface GoogleCloudDiscoveryengineV1betaControlPromoteAction {
1928
+ /** Required. Data store with which this promotion is attached to. */
1929
+ dataStore?: string;
1930
+ /** Required. Promotion attached to this action. */
1931
+ searchLinkPromotion?: GoogleCloudDiscoveryengineV1betaSearchLinkPromotion;
1932
+ }
1905
1933
  interface GoogleCloudDiscoveryengineV1betaControlRedirectAction {
1906
1934
  /** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
1907
1935
  redirectUri?: string;
@@ -2390,6 +2418,18 @@ declare namespace gapi.client {
2390
2418
  /** The structured representation of the schema. */
2391
2419
  structSchema?: {[P in string]: any};
2392
2420
  }
2421
+ interface GoogleCloudDiscoveryengineV1betaSearchLinkPromotion {
2422
+ /** Optional. The Promotion description. Maximum length: 200 characters. */
2423
+ description?: string;
2424
+ /** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
2425
+ enabled?: boolean;
2426
+ /** Optional. The promotion thumbnail image url. */
2427
+ imageUri?: string;
2428
+ /** Required. The title of the promotion. Maximum length: 160 characters. */
2429
+ title?: string;
2430
+ /** Required. The URL for the page the user wants to promote. */
2431
+ uri?: string;
2432
+ }
2393
2433
  interface GoogleCloudDiscoveryengineV1betaSearchRequest {
2394
2434
  /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
2395
2435
  boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
@@ -2948,6 +2988,8 @@ declare namespace gapi.client {
2948
2988
  filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
2949
2989
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
2950
2990
  name?: string;
2991
+ /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
2992
+ promoteAction?: GoogleCloudDiscoveryengineV1ControlPromoteAction;
2951
2993
  /** Defines a redirect-type control. */
2952
2994
  redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
2953
2995
  /** Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
@@ -2971,6 +3013,12 @@ declare namespace gapi.client {
2971
3013
  /** Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
2972
3014
  filter?: string;
2973
3015
  }
3016
+ interface GoogleCloudDiscoveryengineV1ControlPromoteAction {
3017
+ /** Required. Data store with which this promotion is attached to. */
3018
+ dataStore?: string;
3019
+ /** Required. Promotion attached to this action. */
3020
+ searchLinkPromotion?: GoogleCloudDiscoveryengineV1SearchLinkPromotion;
3021
+ }
2974
3022
  interface GoogleCloudDiscoveryengineV1ControlRedirectAction {
2975
3023
  /** Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */
2976
3024
  redirectUri?: string;
@@ -3800,6 +3848,18 @@ declare namespace gapi.client {
3800
3848
  /** 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. */
3801
3849
  searchQuery?: string;
3802
3850
  }
3851
+ interface GoogleCloudDiscoveryengineV1SearchLinkPromotion {
3852
+ /** Optional. The Promotion description. Maximum length: 200 characters. */
3853
+ description?: string;
3854
+ /** Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. */
3855
+ enabled?: boolean;
3856
+ /** Optional. The promotion thumbnail image url. */
3857
+ imageUri?: string;
3858
+ /** Required. The title of the promotion. Maximum length: 160 characters. */
3859
+ title?: string;
3860
+ /** Required. The URL for the page the user wants to promote. */
3861
+ uri?: string;
3862
+ }
3803
3863
  interface GoogleCloudDiscoveryengineV1SearchRequest {
3804
3864
  /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
3805
3865
  boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
@@ -4019,6 +4079,8 @@ declare namespace gapi.client {
4019
4079
  redirectUri?: string;
4020
4080
  /** A list of matched documents. The order represents the ranking. */
4021
4081
  results?: GoogleCloudDiscoveryengineV1SearchResponseSearchResult[];
4082
+ /** Promotions for site search. */
4083
+ searchLinkPromotions?: GoogleCloudDiscoveryengineV1SearchLinkPromotion[];
4022
4084
  /** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
4023
4085
  sessionInfo?: GoogleCloudDiscoveryengineV1SearchResponseSessionInfo;
4024
4086
  /** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
3
- "version": "0.0.20241122",
3
+ "version": "0.0.20241123",
4
4
  "description": "TypeScript typings for Discovery Engine API v1",
5
5
  "repository": {
6
6
  "type": "git",