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
欄位,用於略過結果。skip 值是指要略過的個別資源數量,而非頁面數量。
例如:
如果要求沒有分頁符記,且略過值為 30,則會傳回從第 31 個結果開始的單一頁結果。
如果要求的頁面符號對應到第 51 個結果 (因為前 50 個結果已在第一頁傳回),且略過值為 30,則會傳回從第 81 個結果開始的單一頁面結果。
如果提供的略過值會導致游標超出結果集結尾,回應會是 200 OK
,其中包含空白結果集,且沒有 nextPageToken
。