Method: guaranteedOrders.list

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

顺序由 orderBy 参数定义。如果未指定 filter（按 entityStatus），则实体状态为ENTITY_STATUS_ARCHIVED的有保证订单不会包含在结果中。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

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

string

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

string

用于对列表进行排序的字段。可接受的值包括：

  • displayName（默认）

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

string

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

  • 过滤表达式由一个或多个限制条件组成。
  • 限制条件可以通过 AND 或 OR 逻辑运算符进行组合。一系列限制会隐式使用 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 请求指南。

必填。

标识发出请求的 DV360 实体。LIST 请求只会返回 accessor 中标识的 DV360 实体可访问的有保证订单实体。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
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 Overview。