分页

Ad Manager API 提供数据集合,最常见的是通过 List 方法提供。集合的大小可以任意,并且会在 API 响应中分页。

基础知识

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

pageSize 参数设置为小于 1000 的正数。如果您未设置任何值或将参数设为零,则该 API 会使用默认值 50。如果您将此参数设置为负值,API 会返回 INVALID_ARGUMENT 错误。

如需了解特定于资源的 pageSize 值,请参阅资源参考文档(例如 AdBreaks)。

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 的空结果集。