Method: partners.list

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

顺序由 orderBy 形参定义。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

请求的页面大小。必须介于 1200 之间。如果未指定,则默认为 100

pageToken

string

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

orderBy

string

列表排序所依据的字段。可接受的值为:

  • displayName

默认排序顺序是升序。要为字段指定降序,应在字段名称中添加后缀“desc”。例如 displayName desc

filter

string

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

支持的语法:

  • 过滤表达式由一项或多项限制组成。
  • 限制可以使用 ANDOR 逻辑运算符合并。一系列限制隐式使用 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 概览