Method: projects.locations.privateOffers.documents.list

列出指定父级对应的 PrivateOfferDocuments。

HTTP 请求

GET https://commerceproducer.googleapis.com/v1beta/{parent=projects/*/locations/*/privateOffers/*}/documents

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。ListPrivateOfferDocumentsRequest 的父级值。

查询参数

参数
pageSize

integer

可选。要返回的结果数上限。服务返回的值可能小于此值。最大值为 500；大于 500 的值将被强制转换为 500。如果未指定，服务器将默认设置为最大值。
pageToken

string

可选。从之前的列表响应消息中收到的页面令牌。利用其进行后续页面检索。

进行分页时，列表请求的所有其他参数必须与返回页面令牌的请求相一致。

请求正文

请求正文必须为空。

响应正文

对列出 PrivateOfferDocument 的响应消息

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "privateOfferDocuments": [
    {
      object (PrivateOfferDocument)
    }
  ],
  "nextPageToken": string
}
字段
privateOfferDocuments[]

object (PrivateOfferDocument)

PrivateOfferDocuments 的列表。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围：

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

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

IAM 权限

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

  • commerceproducer.privateOfferDocuments.list

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