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。语法中的冗余空格字符会被忽略。orderBy 值 foo, bar desc、foo , bar desc 和 foo,bar desc 是等效的。子字段使用
. 字符指定,例如foo.bar 或address.street。
排序仅支持原始字段。
跳过结果
分页操作的方法定义了一个整数 skip 字段,用于跳过结果。跳过值是指要跳过的单个资源的数量,而不是页数。
例如:
如果请求没有页面令牌且跳过值为 30,则返回一个结果页面,从第 31 个结果开始。
如果请求的页面令牌对应于第 51 个结果(因为前 50 个结果已在第一页返回),且跳过值为 30,则返回一个结果页面,从第 81 个结果开始。
如果提供的跳过值导致光标移到结果集合末尾之后,响应将为 200 OK,且结果集为空,没有 nextPageToken。