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

获取 WidgetConfig。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{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 的选项。

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

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

  • discoveryengine.widgetConfigs.get

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