Method: projects.locations.dataStores.siteSearchEngine.targetSites.list

获取 TargetSite 的列表。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父级站内搜索引擎资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine。

如果调用者无权列出相应站内搜索引擎下的 TargetSite，无论此分支是否存在，系统都会返回 PERMISSION_DENIED 错误。

查询参数

参数
pageSize

integer

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。

如果此字段为负数，系统会返回 INVALID_ARGUMENT 错误。
pageToken

string

从之前的 targetSites.list 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 targetSites.list 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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

IAM 权限

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

  • discoveryengine.targetSites.list

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