Ad Manager API 提供資料集合,最常見的是以List
方法的形式提供。集合的大小不限,且會在 API 回應中分頁顯示。
基本資訊
集合的要求訊息會定義選用的整數 pageSize 欄位,指定要傳回的結果數量上限。
將 pageSize 參數設為小於 1000 的正數。如果未設定任何值,或將參數設為零,API 會使用預設值 50。如果將參數設為負值,API 會傳回 INVALID_ARGUMENT 錯誤。
請參閱資源參考說明文件 (例如 AdBreaks),瞭解資源專屬的 pageSize 值。
即使未到達集合結尾,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。