マーカーベースのページ割り
マーカーベースのページ割り
マーカーベースのページングを使用するAPIは、marker
およびlimit
クエリパラメータを使用してコレクション内の項目のページ割りを行います。
マーカーベースのページ割りがよく使用されるのは、項目の全セットの長さが頻繁に変更される場合や全体の長さが事前にわからない可能性がある場合です。
ページング
コレクション内のエントリの最初のページを取得するには、APIをmarker
パラメータを指定せずに呼び出すか、marker
を0
に設定して呼び出す必要があります。limit
パラメータは省略可能です。
curl https://api.box.com/2.0/folders/0/items?limit=100&usemarker=true \
-H "authorization: Bearer ACCESS_TOKEN"
エントリの次のページを取得するには、APIレスポンスで受け取ったnext_marker
値の値に等しいmarker
パラメータを指定して、APIを呼び出す必要があります。
curl https://api.box.com/2.0/folders/0/items?marker=34332423&limit=100&usemarker=true \
-H "authorization: Bearer ACCESS_TOKEN"
次のnext_marker
値がレスポンスオブジェクト内でnull
になっている場合、項目の最終ページはリクエスト済みです。この時点では、これ以上取得する項目がありません。
マーカーと制限
以下のクエリパラメータは、コレクションのページ割りに使用されます。
クエリパラメータ | 型 | デフォルト | |
---|---|---|---|
marker | String | コレクション内で最初に結果を返す位置。これは前のリクエストで返された値です。 | |
limit | Integer | APIによって異なる | 返される最大エントリ数。値が最大値を超える場合は、最大値が使用されます。 |
usemarker | Boolean | ページ割りのタイプを選択するために、両タイプのページ割りをサポートするAPIエンドポイントで使用可能なクエリパラメータ (省略可)。true に設定すると、マーカーベースのページ割りが適用されます。 |
コレクション
コレクションのページ割りを行うと、APIによって、結果のセットを配列として含むオブジェクトのほか、結果の現在のページに関する情報が返されます。
フィールド | 型 | |
---|---|---|
entries | Array | このページの項目を含むページ。結果がない場合は空の配列になります。 |
next_marker | String | 結果の次のページを取得するためにmarker 値として使用できる値。この値がnull または空の文字列の場合は、これ以上取得する結果がありません。 |
limit | Integer | 結果の現在のページに使用される制限。この制限は、このAPIエンドポイントに許可されている最大値を超えない限り、limit クエリパラメータと同じになります。 |
エンドポイントの例
以下は、マーカーベースのページ割りをサポートするエンドポイントの例です。