REST Resource: projects.locations.collections.dataStores.widgetConfigs

リソース: WidgetConfig

WidgetConfig は、Widget レベルで構成をキャプチャします。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "enableAutocomplete": boolean,
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  },
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "dataStoreType": enum (DataStoreType),
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "enableSummarization": boolean,
  "enableSnippetResultSummary": boolean,
  "configId": string,
  "enableQualityFeedback": boolean,
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableSafeSearch": boolean,
  "enableConversationalSearch": boolean,
  "llmEnabled": boolean,
  "enableResultScore": boolean,
  "resultDisplayType": enum (ResultDisplayType),
  "minimumDataTermAccepted": boolean,
  "enableWebApp": boolean,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "collectionComponents": [
    {
      object (CollectionComponent)
    }
  ],
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
フィールド
name

string

変更不可。ウィジェット構成の完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
displayName

string

必須。人が読める形式のウィジェット構成の表示名。Discovery UI で使用されます。

このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
createTime

string (Timestamp format)

出力専用。WidgetConfig の作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。WidgetConfig の更新時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
enableAutocomplete
(deprecated)

boolean

予測入力を有効にするかどうか。
fieldsUiComponentsMap
(deprecated)

map (key: string, value: object (UIComponentField))

key は UI コンポーネントです。モック。現在は title、thumbnail、url、custom1、custom2、custom3 をサポートしています。

value は、フィールドの名前とそのデバイスの可視性です。

3 つのカスタム フィールドは省略可能で、追加または削除できます。title、thumbnail、url は必須の UI コンポーネントで、削除できません。
facetField[]
(deprecated)

object (FacetField)

エンドユーザー ビューでのファセットの構成と外観。
dataStoreType

enum (DataStoreType)

出力専用。親データストアのタイプ。
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

コンテンツ検索の望ましい動作を構成するコンテンツ検索仕様。
enableSummarization
(deprecated)

boolean

検索レスポンスの要約をオンまたはオフにします。
enableSnippetResultSummary
(deprecated)

boolean

各スニペット結果の要約をオンまたはオフにします。
configId

string

出力専用。WidgetConfig の難読化された一意の識別子。
enableQualityFeedback
(deprecated)

boolean

エンドユーザーからの検索結果の品質に関するフィードバックの収集をオンまたはオフにします。
solutionType

enum (SolutionType)

必須。変更不可。この WidgetConfig を使用できるソリューション タイプを指定します。
industryVertical

enum (IndustryVertical)

出力専用。WidgetConfig が登録する業種。WidgetConfig の業種は、関連付けられた Engine に基づきます。
allowPublicAccess
(deprecated)

boolean

ウィジェットとの認証なしの統合を許可するかどうか。true に設定すると、セルフホスト型のバックエンド サーバーから提供された認証トークンを使用せずに、ウィジェットから検索やその他のソリューションへの公開アクセスが許可されます。
allowlistedDomains[]
(deprecated)

string

このウィジェットを読み込むことができる許可リストに登録済みのドメイン。
llmEnabled

boolean

出力専用。対応するデータストアで LLM が有効になっているかどうか。
enableResultScore

boolean

結果のスコアを表示するかどうか。
resultDisplayType
(deprecated)

enum (ResultDisplayType)

UCS ウィジェットに表示するスニペットのタイプ。

  • RESULT_DISPLAY_TYPE_UNSPECIFIED: 既存のユーザーの場合。
  • SNIPPET: 新しい非エンタープライズ検索ユーザーの場合。
  • EXTRACTIVE_ANSWER: 新しいエンタープライズ検索ユーザーの場合。
minimumDataTermAccepted

boolean

出力専用。ユーザーがデータ使用条件に同意したかどうか。
enableWebApp
(deprecated)

boolean

スタンドアロン ウェブアプリを有効にするかどうか。
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

データストアごとに構成可能な UI 構成。
collectionComponents[]

object (CollectionComponent)

出力専用。ウィジェット構成に関連付けられているすべてのコレクションと子データストアを一覧表示するコレクション コンポーネント。これらのデータソースは、ウィジェット サービス API でのフィルタリングに使用できます。ユーザーが選択したデータソースから結果を返すことができます。

SaaS / ビジネス エンジンでは、view = WITH_AVAILABLE_CONNECTORS で LookupWidgetConfig が呼び出されると、このリストは、呼び出し元が接続する可能性はあるがまだ接続していないコネクタの合成プレースホルダ エントリでさらに拡張されます（プレースホルダ コントラクトについては CollectionComponent を参照）。そのため、フロントエンドは、この単一のフィールドを反復処理することで、すでに接続されているソースと接続可能なソースの統合リストをレンダリングできます。Enterprise エンジンとデフォルトの view の場合、すでに接続されているコネクタのみが返されます（現在の動作）。
enableSearchAsYouType
(deprecated)

boolean

検索ウィジェットの入力逐次検索動作を有効にするかどうか。
defaultSearchRequestOrderBy
(deprecated)

string

指定されている場合、検索結果のデフォルトの順序。

該当するリクエストで SearchRequest#orderBy を設定するために使用されます。https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
uiSettings

object (UiSettings)

Cloud コンソールのウィジェット構成ページに表示される一般的なウィジェット検索設定を定義します。非推奨の最上位プロパティを置き換えます。
accessSettings

object (AccessSettings)

Cloud コンソールの統合ページに表示されるすべてのウィジェット アクセス設定に使用されます。非推奨の最上位プロパティを置き換えます。
uiBranding

object (UiBrandingSettings)

検索ウィジェットの UI ブランディング設定（ウィジェットのタイトル、ロゴ、ファビコン、色など）を記述します。
homepageSetting

object (HomepageSetting)

省略可。ウィジェットのホームページ設定を記述します。
assistantSettings

object (AssistantSettings)

省略可。出力専用。ウィジェットのアシスタント設定を記述します。
customerProvidedConfig

object (CustomerProvidedConfig)

省略可。出力専用。お客様関連の構成を記述します。現在は政府機関のお客様にのみ使用されています。このフィールドは、プロジェクトのオンボーディング後に変更することはできません。
enablePrivateKnowledgeGraph

boolean

省略可。出力専用。非公開ナレッジグラフを有効にするかどうか。
geminiBundle

boolean

出力専用。サブスクリプションが Gemini バンドルかどうか。
batchAuthStatuses[]

object (BatchAuthStatus)

出力専用。ウィジェットのコネクタのバッチ認可ステータス。
nodes[]

object (Node)

出力専用。ウィジェット構成に関連付けられたノード。

UIComponentField

UI コンポーネントにマッピングされるファセット フィールド。

JSON 表現 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
フィールド
field

string

必須。登録されたフィールド名。形式は field.abc です。
deviceVisibility[]

enum (DeviceVisibility)

さまざまなタイプのデバイスでのフィールドの可視性。
displayTemplate

string

フィールドの表示方法をカスタマイズするためのテンプレート。値の例: Price: {value} のような文字列。

DeviceVisibility

さまざまなタイプのデバイスでのフィールドの表示設定。

列挙型
DEVICE_VISIBILITY_UNSPECIFIED 指定しない場合のデフォルト値。リクエストで使用された場合、サーバーは INVALID_ARGUMENT を返します。
MOBILE UI コンポーネントはモバイル デバイスで表示されます。
DESKTOP UI コンポーネントはブラウザベースのクライアントに表示されます。

FacetField

フィールドとエンドユーザー ウィジェットの表示のマッピングを保存するファセット フィールド。

JSON 表現 
{
  "field": string,
  "displayName": string
}
フィールド
field

string

必須。登録されたフィールド名。形式は field.abc です。
displayName

string

省略可。エンドユーザーに表示されるフィールド名。

DataStoreType

ウィジェットの親データストアのタイプ。

列挙型
DATA_STORE_TYPE_UNSPECIFIED 未指定のデータストア タイプ。
STRUCTURED 親データストアに構造化データの検索エンジンが含まれています。
UNSTRUCTURED 親データストアに非構造化データの検索エンジンが含まれています。
BLENDED 親データストアは、複数のデータストアを使用した統合検索に使用されます。

ResultDisplayType

ucs ウィジェットに表示する結果のタイプ。

列挙型
RESULT_DISPLAY_TYPE_UNSPECIFIED 表示タイプが指定されていません（デフォルトではスニペットが表示されます）。
SNIPPET スニペット フィールドの結果を表示します。
EXTRACTIVE_ANSWER 抽出回答フィールドの結果を表示します。

DataStoreUiConfig

データストアの UI コンポーネント構成。

JSON 表現 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
フィールド
name

string

データストアの名前。データストア リソース名にする必要があります。形式: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}。WidgetService.LookupWidgetConfig などの WidgetService の API の場合、このフィールドではプロジェクト番号とロケーションの部分が消去されます。
id

string

出力専用。ウィジェット サービスで使用されるデータストアの識別子。現時点では dataStoreId を参照していますが、今後、このフィールドは暗号化されたデータストア名の UUID に移行されます。
facetField[]

object (FacetField)

フィールドとエンドユーザー ウィジェットの表示のマッピングを保存するファセット フィールド。
fieldsUiComponentsMap

map (key: string, value: object (UIComponentField))

key は UI コンポーネントです。モック。現在は title、thumbnail、url、custom1、custom2、custom3 をサポートしています。

value は、フィールドの名前とそのデバイスの可視性です。

3 つのカスタム フィールドは省略可能で、追加または削除できます。title、thumbnail、url は必須の UI コンポーネントで、削除できません。

CollectionComponent

フィルタリングに使用できるデータストア コレクション フィールドを含む読み取り専用コレクション コンポーネント。

SaaS / ビジネス エンジンでは、view = WITH_AVAILABLE_CONNECTORS で LookupWidgetConfig が呼び出されると、このメッセージのインスタンスは、呼び出し元が接続する可能性はあるがまだ接続していないコネクタの合成プレースホルダ エントリを表すためにも使用されます。プレースホルダ エントリには、connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED（または NO_AUTH）、空の connectorAuthState.authorization_uri（ユーザーが [Connect] をクリックすると、ウィジェットが WidgetBuildAuthorizationUrl を呼び出す）、name / id の合成プレースホルダ値（フィールドのコメントを参照）があります。マテリアライズド コネクタ（dataStoreComponents、tenant、actionConnector）でのみ意味のあるフィールドは、プレースホルダ エントリでは設定されません。

JSON 表現 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceDisplayName": string,
  "connectorIconLink": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
フィールド
name

string

コレクションの名前。コレクション リソース名にする必要があります。形式: projects/{project}/locations/{location}/collections/{collectionId}。WidgetService.LookupWidgetConfig などの WidgetService の API の場合、このフィールドではプロジェクト番号とロケーションの部分が消去されます。

合成プレースホルダ エントリ（メッセージレベルのコメントを参照）の場合、これは実際のコレクションに対応しない合成プレースホルダ コレクション ID を運びます。ユーザーがコネクタを承認するまで、呼び出し元はこのリソースの解決 / GET を試みてはなりません。
id

string

出力専用。ウィジェット サービスで使用されるコレクションの ID。現時点では collectionId を参照していますが、今後、このフィールドは暗号化されたコレクション名 UUID に移行されます。

合成プレースホルダ エントリ（メッセージレベルのコメントを参照）の場合、これは実際の collectionId ではなく、合成プレースホルダ ID です。
displayName

string

コレクションの表示名。
dataStoreComponents[]

object (DataStoreComponent)

データストア コレクションの場合、子データストアのリスト。
dataSource

string

Collection.data_connector.data_source から取得したデータソースの名前。
dataSourceDisplayName

string

出力専用。データソースの表示名。
connectorAuthState

object (ConnectorAuthState)

出力専用。コネクタソースの認証 URI。

DataStoreComponent

フィルタリングに使用できるデータストア フィールドを含む読み取り専用データストア コンポーネント。CollectionComponent の子です。

JSON 表現 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "workspaceType": enum (Type),
  "contentConfig": enum (ContentConfig),
  "dataStoreConfigType": enum (DataStoreConfigType)
}
フィールド
name

string

データストアの名前。データストア リソース名にする必要があります。形式: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}。WidgetService.LookupWidgetConfig などの WidgetService の API の場合、このフィールドではプロジェクト番号とロケーションの部分が消去されます。
id

string

出力専用。ウィジェット サービスで使用されるデータストアの識別子。現時点では dataStoreId を参照していますが、今後、このフィールドは暗号化されたデータストア名の UUID に移行されます。
displayName

string

データストアの表示名。
entityName

string

Collection.data_connector.entities.entityName から取得されたエンティティの名前。
workspaceType

enum (Type)

出力専用。DataStore.workspace_config.type から取得された Workspace データの Workspace ソースタイプ。
contentConfig

enum (ContentConfig)

出力専用。データストアのコンテンツ構成。
dataStoreConfigType

enum (DataStoreConfigType)

出力専用。データストア構成のタイプ。

DataStoreConfigType

データストア構成のタイプ。

列挙型
DATA_STORE_CONFIG_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
ALLOW_DB_CONFIG データストアが AlloyDB に接続されています。
THIRD_PARTY_OAUTH_CONFIG データストアがサードパーティのデータソースに接続されています。
NOTEBOOKLM_CONFIG データストアが NotebookLM Enterprise に接続されています。

ConnectorAuthState

CollectionComponent 認証状態の読み取り専用コネクタ。

JSON 表現 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
フィールド
authState

enum (AuthState)

出力専用。データコネクタの認可状態。
authorizationUri

string

出力専用。データコネクタの認可 URI。

合成プレースホルダ CollectionComponent エントリ（SaaS / Business エンジンで view = WITH_AVAILABLE_CONNECTORS を使用して LookupWidgetConfig によって返される）の場合、このフィールドは空のままになります。ウィジェットは、ユーザーが [Connect] をクリックしたときに WidgetService.WidgetBuildAuthorizationUrl を呼び出して、新しく作成された認証 URL を取得する必要があります。
updateTime

string (Timestamp format)

出力専用。承認状態の更新タイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

AuthState

データコネクタの認可状態。

列挙型
AUTH_STATE_UNSPECIFIED デフォルト値。また、LookupWidgetConfig で view = WITH_AVAILABLE_CONNECTORS（SaaS / Business のみ）を使用して表示される合成プレースホルダ CollectionComponent エントリについても返されます。これらのエントリは、呼び出し元が接続できるがまだ接続していないコネクタを表します。
AUTHORIZED ユーザーがデータコネクタを承認している。
EXPIRED データコネクタのユーザー認証の有効期限が切れています。
ACTIONS_DISABLED ユーザーは検索リクエストを行うことはできますが、アクションを有効にする必要があります。
NO_AUTH データコネクタに承認は必要ありません。基盤となるコネクタでユーザー OAuth が不要なプレースホルダ エントリにも使用されます。

UiSettings

クラウド コンソールの UI 構成ページに表示される一般的なウィジェット（またはウェブアプリ）の UI 設定について記述します。

JSON 表現 
{
  "interactionType": enum (InteractionType),
  "generativeAnswerConfig": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "sourceAdminDisplayNameEnabled": boolean,
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
フィールド
interactionType

enum (InteractionType)

ウィジェット（またはウェブアプリ）のインタラクション タイプを説明します
generativeAnswerConfig

object (GenerativeAnswerConfig)

生成回答の構成について記述します。
resultDescriptionType

enum (ResultDisplayType)

結果の抽出を表示するかどうか、またその方法（スニペットまたは抽出回答）を制御します。指定しない場合は、デフォルトで結果なしになります。
enableAutocomplete

boolean

予測入力を有効にするかどうか。
enableQualityFeedback

boolean

エンドユーザーからの検索結果の品質に関するフィードバックの収集をオンまたはオフにします。
enableSearchAsYouType

boolean

検索ウィジェットの入力逐次検索動作を有効にするかどうか。
defaultSearchRequestOrderBy

string

指定されている場合、検索結果のデフォルトの順序。

該当するリクエストで SearchRequest#orderBy を設定するために使用されます。https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
dataStoreUiConfigs[]

object (DataStoreUiConfig)

データストア構成ごと。
disableUserEventsCollection

boolean

true に設定すると、ウィジェットはユーザー イベントを収集しません。
enableVisualContentSummary

boolean

true に設定すると、ウィジェットは該当する検索リクエストで視覚コンテンツの要約を有効にします。医療検索でのみ使用されます。
enableCreateAgentButton

boolean

省略可。true に設定すると、ウィジェットでエージェント作成ボタンが有効になります。
features

map (key: string, value: enum (FeatureState))

出力専用。エンジンが機能をオプトインまたはオプトアウトするための機能構成。サポートされているキー:

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • disable-skills
  • disable-projects
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
modelConfigs

map (key: string, value: enum (ModelState))

出力専用。モデル名をこのエンジンの特定の構成にマッピングします。これにより、管理者ユーザーは個々のモデルのオン/オフを切り替えることが可能です。こうして、管理者が状態をオーバーライドしたモデルのみが保存されます。

状態が指定されていない場合、またはこのモデルの modelConfigs が空の場合、システムはデフォルトの構成に基づいて、このモデルを使用可能にするかどうかを決定します。たとえば、管理者がプレビュー モデルを有効にしない場合、プレビュー モデルはデフォルトで無効になります。
searchAddonSpec

object (SearchAddonSpec)

省略可。SearchAddonSpec は、検索のアドオンを無効にするために使用されます。このフィールドは検索リクエストでのみサポートされています。
modelConfigInfo

object (ModelConfigInfo)

出力専用。モデル セレクタ構成の解決済みサーバーサイド ビュー。モデル セレクタのプルダウンに表示されるモデルの順序付きリストと、デフォルトで選択されるモデルの両方を保持します。

クライアントは、独自のフィルタリング、順序付け、ローカライズを適用せずに、これを直接レンダリングする必要があります。上記の以前の modelConfigs マップは、このフィールドを使用するようにまだ移行していないクライアントとの下位互換性を維持するために保持されています。
sourceAdminDisplayNameEnabled

boolean

省略可。ウィジェット ソースの UI で、データコネクタの（コネクタの種類ではなく）管理者が構成した表示名を表示するかどうか。オプトイン。デフォルトは false です。
onedrivePickerEnabled

boolean

出力専用。エンドユーザーが OneDrive ファイル選択ツールを利用できるかどうか。バックエンドで、管理者コネクタの有効化（Business エディション）または接続された OneDrive コネクタ（Enterprise エディション）と既存の disable-onedrive-upload 管理機能と組み合わせて計算されます。

明示的に計算された false がフィールドの存在とともにシリアル化されるように、optional を宣言しました。プレーン proto3 bool は、デフォルトの false をワイヤにドロップします。これにより、クライアントは「ピッカーが無効」（false）と「フィールドが入力されていない」（未設定）を区別できませんでした。
googleDrivePickerEnabled

boolean

出力専用。Google ドライブのファイル選択ツールをエンドユーザーが利用できるかどうか。上記の onedrivePickerEnabled と同じフィールド存在理由で optional を宣言しました。

InteractionType

インタラクション タイプを記述します。

列挙型
INTERACTION_TYPE_UNSPECIFIED 指定なし。デフォルトは SEARCH_ONLY です。
SEARCH_ONLY 生成回答なしで検索します。
SEARCH_WITH_ANSWER 生成回答を使用して検索します。
SEARCH_WITH_FOLLOW_UPS フォローアップの質問に対応した生成回答で検索します。マルチターン検索とも呼ばれます。

GenerativeAnswerConfig

生成回答の構成を記述します。

JSON 表現 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
フィールド
resultCount

integer

回答の生成に使用する上位の結果の数。最大 10。
modelVersion

string

回答の生成に使用されたモデル バージョン。
modelPromptPreamble

string

回答を生成するモデルに指示するプロンプトの冒頭のテキスト。
maxRephraseSteps

integer

リフレーザー ステップの最大数。最大ステップ数は 5 です。設定されていない場合、または 1 未満に設定されている場合は、デフォルトで 1 に設定されます。
languageCode

string

要約の言語コード。BCP47 で定義されている言語タグを使用します。注: これは試験運用版の機能です。
ignoreNonAnswerSeekingQuery

boolean

省略可。回答を求めていないクエリをフィルタで除外するかどうかを指定します。デフォルト値は false です。

検索クエリが回答を求めていないクエリに分類された場合、回答は返されません。このフィールドが true に設定されている場合、回答を求めていないクエリに対する回答の生成はスキップされ、代わりにフォールバック メッセージが返されます。
ignoreAdversarialQuery

boolean

省略可。敵対的なクエリをフィルタで除外するかどうかを指定します。
ignoreLowRelevantContent

boolean

省略可。コンテンツに関連しないクエリを除外するかどうかを指定します。
imageSource

enum (ImageSource)

省略可。回答に返される画像のソース。

ImageSource

回答に返される画像のソース。

列挙型
IMAGE_SOURCE_UNSPECIFIED 指定されていない画像ソース（マルチモーダル機能はデフォルトで無効になっています）。
ALL_AVAILABLE_SOURCES サービスが利用可能なすべてのソースから選択を決定する際の動作。
CORPUS_IMAGE_ONLY コーパスの画像を回答に含めます。
FIGURE_GENERATION_ONLY 回答で図の生成をトリガーします。

FeatureState

エンジンの機能の状態。

列挙型
FEATURE_STATE_UNSPECIFIED 機能の状態が指定されていません。
FEATURE_STATE_ON この機能は、アクセスできるようにオンになっています。
FEATURE_STATE_OFF この機能はオフになっており、アクセスできません。

ModelState

エンジンのモデルの状態。

列挙型
MODEL_STATE_UNSPECIFIED モデルの状態が指定されていません。
MODEL_ENABLED モデルは管理者によって有効になっています。
MODEL_DISABLED モデルは管理者によって無効になっています。

SearchAddonSpec

SearchAddonSpec は、検索のアドオンを無効にするために使用されます。デフォルトでは、このフィールドが指定されていない場合、アドオンは適用可能な場所で有効になります。

JSON 表現 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
フィールド
semanticAddOnDisabled

boolean

省略可。true の場合、セマンティック アドオンは無効になります。セマンティック アドオンには、エンベディングと jetstream が含まれます。
kpiPersonalizationAddOnDisabled

boolean

省略可。true の場合、イベントの再ランキングとパーソナライズを無効にして、KPI を最適化し、結果をパーソナライズします。
generativeAnswerAddOnDisabled

boolean

省略可。true の場合、生成回答アドオンは無効になります。生成回答アドオンには、自然言語からフィルタへの変換とシンプルな回答が含まれています。

ModelConfigInfo

エンドユーザー向けのモデル セレクタ構成の解決済みサーバーサイド ビュー。バックエンドは、リクエストごとに、Mendel フラグの評価、エンジンのロケーションに基づくリージョンの可用性ルール、modelConfigs の管理パネルのオーバーライドを順に適用して、これを計算します。

バックエンドはこの構成の唯一の信頼できる情報源です。クライアントは、独自のフィルタリング、順序付け、ローカライズを適用せずに、提供された順序でモデル選択ツリーに resolvedModels を直接レンダリングする必要があります。

JSON 表現 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string
}
フィールド
resolvedModels[]

object (ResolvedModel)

出力専用。モデル セレクタでエンドユーザーが利用できるモデルのリスト。表示順に並べられています。
defaultModelId

string

出力専用。エンドユーザーが明示的に選択していない場合に、モデル セレクタでデフォルトで選択されるモデルの modelId。値は常に resolvedModels に存在する modelId のいずれかです。

ResolvedModel

モデル セレクタでエンドユーザーが利用できるように解決された単一のモデルと、そのすべてのローカライズされた表示メタデータ。

JSON 表現 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "adminView": {
    object (AdminView)
  }
}
フィールド
modelId

string

出力専用。モデルの一意の識別子（gemini-2.5-flash、gemini-3.1-pro-preview など）。

これは、クライアントがこのモデルを選択するためにアシスタント サービスに渡す識別子と同じです。仮想モデルや「疑似」モデル（gemini-fast など）も有効な値です。これらはバックエンドで基盤となる具体的なモデルに解決されます。
displayName

string

出力専用。モデルのローカライズされた表示名（例: Gemini 3.1 Pro）。リクエストの LookupWidgetConfigRequest.language_code と LookupWidgetConfigRequest.region_code に基づいてサーバーサイドでローカライズされます。
icon

string

出力専用。モデルに関連付けられた GM3 互換のアイコン トークン（rocket_launch、bolt、graph_5 など）。
description

string

出力専用。ローカライズされた説明テキスト（例: state-of-the-art reasoning）。displayName と同じロケールを使用してローカライズされます。
isPreview

boolean

出力専用。モデルが現在プレビュー版かどうか。クライアントは、セレクタ UI の「プレビュー」バッジでこれを表示する必要があります。
adminView

object (AdminView)

出力専用。管理者向けサーフェスのメタデータ。コンソール管理者の [Feature Control] ページ（AdminView を参照）でのみ入力されます。エンドユーザー向けサーフェスでは設定されません。

AdminView

管理者向けサーフェスのメタデータ。リクエストが Cloud コンソールの管理者の [機能制御] ページから送信された場合にのみ入力されます。エンドユーザー サーフェス（ウェブ、モバイル）では設定されません。管理ページで、ハードコードされたクライアントサイド レジストリではなく、バックエンドから直接切り替えテーブルをレンダリングできるようにします。

JSON 表現 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
フィールド
adminOverridable

boolean

出力専用。管理者が UiSettings.model_configs を介してこのモデルの有効/無効の状態を切り替えることができるかどうか。MODEL_TAG_ADMIN_OVERRIDABLE から取得されます。false の場合、モデルは「強制」され、その状態は enabledByDefault に則って管理されます。
enabledByDefault

boolean

出力専用。管理者が UiSettings.model_configs で明示的なオーバーライドを設定していない場合に、モデルが有効になっているかどうか。MODEL_TAG_ENABLED_BY_DEFAULT から取得されます。
regions[]

string

出力専用。このモデルがリリースされるリージョン。

AccessSettings

ウィジェットのアクセス設定について記述します。

JSON 表現 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
フィールド
allowPublicAccess

boolean

公開未認証アクセスが許可されているかどうか。
allowlistedDomains[]

string

検索ウィジェットの統合が許可されているドメインのリスト。
enableWebApp

boolean

ウェブアプリへのアクセスが有効かどうか。
workforceIdentityPoolProvider

string

省略可。ウィジェットへのアクセスに使用される Workforce Identity プール プロバイダ。
languageCode

string

省略可。ユーザー インターフェースの言語コード。BCP47 で定義されている言語タグを使用します。設定されていない場合、デフォルトの言語コードは「en-US」です。

UiBrandingSettings

ウィジェットの UI ブランド設定について記述します。

JSON 表現 
{
  "logo": {
    object (Image)
  }
}
フィールド

画像

画像を保存するためのオプション。

JSON 表現 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
フィールド
共用体フィールド storage_method。画像を保存するさまざまな方法（URL や base64 エンコード文字列など）。storage_method は次のいずれかになります。
url

string

画像 URL。

HomepageSetting

ウィジェットのホームページ設定について記述します。ショートカットなど、ホームページに関連するすべての設定と構成が含まれます。

JSON 表現 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
フィールド
shortcuts[]

object (Shortcut)

省略可。ホームページに表示するショートカット。

ショートカット

ホームページのショートカット（ピン留めされたコンテンツ）のエンティティを記述します。ホームページには、API が返すのと同じ順序でこれらのショートカットが表示されます。ユーザーがショートカットの並べ替えや削除を希望する場合、UI は常にショートカットの新しい完全なリストを提供する必要があります。

JSON 表現 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
フィールド
title

string

省略可。ショートカットのタイトル。
icon

object (Image)

省略可。ショートカットのアイコン URL。
destinationUri

string

省略可。ショートカットのリンク先 URL。

AssistantSettings

ウィジェットのアシスタント設定を記述します。

JSON 表現 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
フィールド
googleSearchGroundingEnabled
(deprecated)

boolean

Google 検索のグラウンディング切り替えボタンが表示されるかどうか。非推奨。代わりに webGroundingType を使用してください。
webGroundingType

enum (WebGroundingType)

省略可。使用するウェブ グラウンディングのタイプ。
defaultWebGroundingToggleOff

boolean

出力専用。webGroundingType が WEB_GROUNDING_TYPE_GOOGLE_SEARCH または WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH に設定されている場合、このフィールドはエンドユーザーのデフォルトのウェブ グラウンディング切り替えを制御します。このフィールドはデフォルトで false に設定されています。webGroundingType が WEB_GROUNDING_TYPE_GOOGLE_SEARCH または WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH の場合、エンドユーザーは UI でウェブ グラウンディングがデフォルトで有効になります。true の場合、UI でグラウンディングの切り替えがデフォルトで無効になります。ウェブ グラウンディングが有効になっている場合、エンドユーザーは UI でウェブ グラウンディングを有効にできます。
disableLocationContext

boolean

省略可。出力専用。ユーザーの現在地のコンテキストを無効にするかどうか。

WebGroundingType

使用するウェブ グラウンディングのタイプ。

列挙型
WEB_GROUNDING_TYPE_UNSPECIFIED デフォルトの未指定の設定。これは無効と同じです。
WEB_GROUNDING_TYPE_DISABLED ウェブ グラウンディングが無効になっています。

CustomerProvidedConfig

ユーザーが提供した構成。

JSON 表現 
{
  "customerType": enum (CustomerType)
}
フィールド
customerType

enum (CustomerType)

顧客のタイプ。

CustomerType

顧客のタイプ。

列挙型
DEFAULT_CUSTOMER デフォルトの顧客タイプ。
GOVERNMENT_CUSTOMER 政府機関の顧客のタイプ。法的要件により、政府機関のお客様向けに一部の機能が無効になっています。

BatchAuthStatus

batchAuthorizationGroup のバッチ承認ステータスを記述します。

JSON 表現 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
フィールド
placeholder

string

出力専用。これは、バッチ認可グループのプレースホルダの完全なリソース名です。これは実際のデータコネクタではありません（spanner の DataConnector テーブルに存在しません）。ユーザー テーブルの connector_authorization にのみ存在するリソース名です。例: projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector。
batchAuthorizationGroup

string

出力専用。プレースホルダが属するバッチ認可グループ。
connectorAuthState

object (ConnectorAuthState)

出力専用。このコネクタの現在の認可状態。

ノード

再利用可能な単一の計算単位または論理単位を表します。

JSON 表現 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
フィールド
displayName

string

出力専用。人が読める形式のノード名。
iconUrl

string

出力専用。このノードタイプを表すアイコンを指す ID または URL。
description

string

出力専用。ノードの機能の詳細な説明。
parameterSchema

object (Struct format)

出力専用。ツールのパラメータ スキーマ。

このスキーマは、OpenAPI スキーマ標準（https://spec.openapis.org/oas/v3.0.3.html と AIP-146 を参照）に準拠している必要があります。このノードが受け入れるパラメータの想定される構造について説明します。
outputSchema

object (Struct format)

出力専用。ツールの出力スキーマ。

このスキーマは、OpenAPI スキーマ標準（https://spec.openapis.org/oas/v3.0.3.html/ と AIP-146 を参照）に準拠している必要があります。このノードによって生成される出力の構造を記述します。
type

enum (Type)

出力専用。ノードのタイプ。

タイプ

エージェント フロー内のノードのタイプを識別します。

列挙型
TYPE_UNSPECIFIED 未指定のタイプ。
TRIGGER トリガーのタイプ。
FLOW フロータイプ。
CONNECTOR コネクタのタイプ。

メソッド

get

 WidgetConfig を取得します。

patch

 WidgetConfig を更新します。