分页

Ad Manager REST API 提供数据集合,最常以列表形式提供 方法。集合可以任意大小,并且可以在 API 中分页 响应。

基础知识

集合的请求消息定义了一个可选的整数 pageSize 字段, 指定要返回的结果数上限。

如果 pageSize 未设置或 0,则使用默认值 50。 如果 pageSize 超过了页面大小上限 (1000),API 会强制转换 将页面大小调整为 1000 负值会导致 INVALID_ARGUMENT 错误。

API 返回的结果数可能会少于请求的数量(包括零 结果),即使不是在集合的末尾。使用 nextPageToken 字段,用于确定在 。

集合的响应消息定义了一个字符串 nextPageToken 字段, 可用于检索下一页。 集合结束时,nextPageToken 字段为空 。这是确定您是否已经看完 。

集合的请求消息定义了可选的字符串 pageToken 字段 即可前进到集合中的下一页。 允许在后续页面的请求中对 pageSize 进行更改。 所有其他参数必须相同;如果任意参数不同,API 会返回 INVALID_ARGUMENT 错误。

示例

cURL

初始请求

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500

{
  "adUnits": [ ... ],
  "nextPageToken": "eCGwAcs6hUerggzd2DGv"
}

下一页请求

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv

{
  "adUnits": [ ... ]
}

总大小

集合的响应消息提供了一个整数 totalSize,它表示 应用过滤后的实体总数。只有 会在 字段掩码

GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize

订单结果

集合的请求消息定义要指定的字符串 orderBy 字段 排序。

值应该是以英文逗号分隔的字段列表。例如 foo,bar。 默认排序顺序为升序。要指定字段的降序顺序 附加 desc 后缀;例如 foo desc, bar。 系统会忽略语法中的冗余空格字符。orderByfoo, bar descfoo , bar descfoo,bar desc 都是等效的。 子字段使用 . 字符指定,例如 foo.baraddress.street

只有原始字段支持排序。

跳过结果

分页操作的方法定义要跳过的整数 skip 字段 结果。跳过值是指要跳过的单个资源的数量, 而不是页数

例如:

不含页面令牌且跳过值为 30 的请求会返回 从第 31 个结果开始计算结果。

带有与第 51 个结果相对应的页面令牌的请求(因为第一个 第一页返回 50 个结果),跳过值为 30 时返回 从第 81 个结果开始的一页结果。

如果提供的跳过值会导致光标超出 结果集合,则响应为 200 OK,且结果集为空且不包含 nextPageToken