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

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

大量の結果を返す可能性がある多くの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

✕

AmazonリクエストID

一部のREST APIでは、Alexaからの応答ヘッダーにX-Amzn-RequestIdパラメーターが含まれます。問題が発生した場合、AmazonはこのリクエストIDをトラブルシューティングに使用します。たとえば、応答に次のようなヘッダーが含まれる場合があります。

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
パラメーター 説明 型

request-id

リクエストの一意のID。

文字列

このページは役に立ちましたか？

最終更新日: 2024 年 11 月 20 日