Method: guaranteedOrders.list

列出当前用户可以访问的有保证订单。

顺序由 orderBy 参数定义。如果未指定 entityStatusfilter,实体状态为 ENTITY_STATUS_ARCHIVED 的有保证订单将不会包含在结果中。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName(默认)

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

filter

string

允许按有保证订单字段进行过滤。

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

支持的字段:* guaranteedOrderId * exchange * displayName * status.entityStatus

示例:

  • 所有有效的有保证订单:status.entityStatus="ENTITY_STATUS_ACTIVE"
  • 属于 Google Ad Manager 或 Rubicon 广告交易平台的有保证订单:exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

有关详情,请参阅我们的过滤器 LIST 请求指南。

联合参数 accessor。必填。

指明请求是在哪个 DV360 实体中发出的。LIST 请求将仅返回 accessor 中指明的 DV360 实体可访问的有保证订单实体。accessor 只能是下列其中一项:

partnerId

string (int64 format)

有权访问有保证订单的合作伙伴的 ID。

advertiserId

string (int64 format)

有权访问有保证订单的广告客户的 ID。

请求正文

请求正文必须为空。

响应正文

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

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

object (GuaranteedOrder)

有保证订单的列表。

如果为空,此列表将不存在。

nextPageToken

string

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 OAuth 2.0 概览