Method: projects.locations.collections.engines.widgetConfigs.get

获取 WidgetConfig。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/widgetConfigs/*}

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。完整的 WidgetConfig 资源名称。格式：projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

查询参数

参数
acceptCache

boolean

可选。指定是否允许从缓存加载 widget 配置。如果设置为 true，widget 配置的最新更改可能需要几分钟才能反映到最终用户的视图中。建议针对成熟开发的 widget 设置为 true，因为这样可以提高 widget 性能。如果 widget 正在开发中，请将其设置为 false，以便立即在生产环境中反映更改。
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

可选。GetWidgetConfigRequest 的选项。
languageCode

string

可选。BCP-47 语言标记（例如“en”“fr-CA”）。用于本地化响应中的直观易懂的字符串，例如 WidgetConfig.UiSettings.ModelConfigInfo 上的模型选择器 displayName / description。如果为空 / 未设置，则会回退到默认语言（英语）。
modelInfoView

enum (ModelInfoView)

可选。选择后端计算的 WidgetConfig.UiSettings.ModelConfigInfo 视图。MODEL_INFO_VIEW_ADMIN 由 Cloud 控制台管理员在“功能管理”页面 (screen/4Vn9gQKbN8tb7gm) 中设置，用于接收填充了 ResolvedModel.admin_view 的管理员公开模型集；未设置 / MODEL_INFO_VIEW_WEB 返回最终用户选择器。移动设备界面现在从 X-Goog-Gemini-Enterprise-Mobile 标头检测（请参阅 ModelInfoView）。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 WidgetConfig 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

  • discoveryengine.widgetConfigs.get

如需了解详情，请参阅 IAM 文档。