Pagination

Ad Manager REST API は、データコレクションを提供します。最も一般的なのは List（リスト）です。あります。コレクションのサイズは任意で設定でき、API でページ分けされます。できます。

基本

コレクションのリクエストメッセージでは、オプションの整数 pageSize フィールドを定義します。返される結果の最大数を指定します。

pageSize が未設定または 0 の場合、デフォルト値の 50 が使用されます。 pageSize が最大ページサイズの 1, 000 を超えると、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 のリクエストは、結果を返します。

51 番目の結果に対応するページトークンを含むリクエスト（最初の結果が最初のページで 50 件の結果が返され、スキップ値が 30 の場合 81 番目の結果から始まる 1 ページの結果のみです。

スキップ値が指定されているため、カーソルが結果のコレクションの場合、レスポンスは 200 OK で、結果セットは nextPageToken。