分頁

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。系統會忽略語法中的多餘空格字元。orderBy 值 foo, bar desc、foo , bar desc 和 foo,bar desc 都相同。子欄位是以 . 字元指定，例如 foo.bar 或 address.street。

排序功能僅適用於原始欄位。

略過搜尋結果

分頁作業的方法會定義要略過的整數 skip 欄位也就是預測結果略過值是指要略過的個別資源數量而非頁數

例如：

沒有網頁符記且略過值 30 的要求會傳回從第 31 筆結果起。

在這類要求中，網頁符記會對應至第 51 筆結果 (因為第一個第一頁傳回 50 個結果)，而略過值設為 30 則會傳回一個第一頁的結果，從第 81 筆結果開始。

如果提供的略過值會使遊標超出結果集合，回應為 200 OK，具有空白的結果集，但沒有 nextPageToken。