Method: partners.list

列出当前用户可以访问的合作伙伴。

顺序由 orderBy 参数定义。

HTTP 请求

GET https://displayvideo.googleapis.com/v3/partners

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

请求的页面大小。 必须介于 1 到 200 之间。如果未指定，则默认为 100。
pageToken

string

标识服务器应返回的结果页面的令牌。 通常，这是上次调用 partners.list 方法时返回的 nextPageToken 值。如果未指定，则返回第一页的结果。
orderBy

string

表示要按哪个字段对此列表进行排序。可接受的值包括：

  • displayName

默认排序顺序为升序。如需将字段指定为降序，应将后缀“desc”添加到字段名称中。例如 displayName desc。
filter

string

允许按合作伙伴字段进行过滤。

支持的语法：

  • 过滤条件表达式由一个或多个限制条件组成。
  • 限制条件可以通过 AND 或 OR 逻辑运算符组合使用。一系列限制会隐式使用 AND。
  • 限制的格式为 {field} {operator} {value}。
  • 所有字段都必须使用 EQUALS (=) 运算符。

支持的字段：

  • entityStatus

示例：

  • 所有活跃合作伙伴：entityStatus="ENTITY_STATUS_ACTIVE"

此字段的长度不得超过 500 个字符。

如需了解详情，请参阅我们的过滤 LIST 请求指南。

请求正文

请求正文必须为空。

响应正文

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

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

object (Partner)

合作伙伴列表。

如果为空，则不会显示此列表。
nextPageToken

string

用于检索下一页结果的令牌。在对 partners.list 方法的后续调用中，将此值传入 pageToken 字段，以检索下一页结果。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/display-video

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