クエリ結果のページ分割を処理する

クエリ結果のページ分割を処理する

多くの結果を返す可能性がある多くのAlexa REST APIでは、ページ分割が行われます。これらは、結果のサブセット（つまり「ページ」）と、結果の次のページを取得する方法についての情報を持つpaginationContextオブジェクトを返します。以下は、一般的な形式のpaginationContextオブジェクトの例です。

{
   "paginationContext": {
      "nextToken": "{token}"
   },
   "results": [
      {
      ...
      }
   ]
}

以下の表に、paginationContextオブジェクトに含まれるフィールドを示します。

フィールド 説明 型 必須

nextToken

追加の結果を取得するためのトークン。これがなければ、もうほかの結果はないということです。

string

✕

ページサイズを制限する

ページサイズを制限するには、以下の例のようにmaxResultsクエリパラメーターをリクエストに追加します。

   GET /{resources}?maxResults=10

結果の次のページをリクエストする

結果のページをリクエストした後、次のページを取得するために新しいGETリクエストを送信する必要があります。新しいリクエストは前のリクエストと同じでなければなりません。そして、前のリクエストで受け取った応答内のnextToken値に設定したnextTokenクエリパラメーターを追加します。

応答にはこのトークンから始まる結果が含まれ、ほかにも結果がある場合にのみnextToken値が含まれます。

ページサイズを制限して結果の次のページをリクエストするためのリクエストクエリパラメーター

以下の表に、ページサイズを制限し、結果の次のページをリクエストするためのクエリパラメーターフィールドを示します。

フィールド 説明 型 必須

maxResults

応答本文で返される結果の最大数。10以下の正の値を指定してください。

number（整数）

◯

nextToken

ページ分割された結果から特定のページを取得するためのトークン。このトークンがない場合、応答には結果の先頭ページが含められます。

string

✕

最終更新日: 2023 年 03 月 06 日