アド マネージャー API は、通常 List メソッドでデータのコレクションを提供します。コレクションのサイズは任意に設定でき、API レスポンスでページングされます。
基本
コレクションのリクエスト メッセージは、返される結果の最大数を指定するオプションの整数 pageSize フィールドを定義します。
pageSize パラメータを 1000 より小さい正の数に設定します。値を設定しない場合、またはパラメータをゼロに設定した場合、API はデフォルト値の 50 を使用します。パラメータに負の値を設定すると、API から INVALID_ARGUMENT エラーが返されます。
リソース固有の pageSize 値については、リソース リファレンス ドキュメント（AdBreaks など）を参照してください。
コレクションの最後でなくても、リクエストされた数よりも少ない結果（ゼロの結果を含む）が返されることがあります。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 はありません。