> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# マーカーベースのページネーション
export const Link = ({href, children, className, ...props}) => {
const localizedHref = localizeLink(href);
return
{children}
;
};
export const MultiRelatedLinks = ({sections = []}) => {
if (!sections || sections.length === 0) {
return null;
}
return
{sections.map((section, index) => )}
;
};
export const RelatedLinks = ({title, items = []}) => {
const getBadgeClass = badge => {
if (!badge) return "badge-default";
const badgeType = badge.toLowerCase().replace(/\s+/g, "-");
return `badge-${badge === "ガイド" ? "guide" : badgeType}`;
};
if (!items || items.length === 0) {
return null;
}
return ;
};
マーカーベースのページングを使用するAPIは、`marker`および`limit`クエリパラメータを使用してコレクション内の項目のページ割りを行います。
マーカーベースのページネーションがよく使用されるのは、項目の全セットの長さが頻繁に変更される場合や全体の長さが事前にわからない可能性がある場合です。
## ページング
コレクション内のエントリの最初のページを取得するには、APIを`marker`パラメータを指定せずに呼び出すか、`marker`を`0`に設定して呼び出す必要があります。`limit`パラメータは省略可能です。
```sh theme={null}
curl https://api.box.com/2.0/folders/0/items?limit=100&usemarker=true&marker= \
-H "authorization: Bearer ACCESS_TOKEN"
```
オフセットベースのページネーションとマーカーベースのページネーションの両方をサポートするAPIでは、マーカーベースのページネーションが使用されるように`usemarker`クエリパラメータを`true`に設定する必要があります。
エントリの次のページを取得するには、APIレスポンスで受け取った`next_marker`値の値に等しい`marker`パラメータを指定して、APIを呼び出す必要があります。
```sh theme={null}
curl https://api.box.com/2.0/folders/0/items?marker=34332423&limit=100&usemarker=true \
-H "authorization: Bearer ACCESS_TOKEN"
```
次の`next_marker`値がレスポンスオブジェクト内で`null`になっている場合、項目の最終ページはリクエスト済みです。この時点では、これ以上取得する項目がありません。
マーカーベースのページングを使用する場合、コレクション内のエントリの合計数を確認するには、エントリをすべて取得するしかありません。マーカーの内部実装は今後変更される可能性があるため、アプリケーションでは`next_marker`値を長期にわたって保持しないでください。
## マーカーと制限
以下のクエリパラメータは、コレクションのページネーションに使用されます。
| クエリパラメータ | 型 | デフォルト | |
| ----------- | ------- | ---------- | ------------------------------------------------------------------------------------------------------------- |
| `marker` | String | | コレクション内で最初に結果を返す位置。これは前のリクエストで返された値です。 |
| `limit` | Integer | APIによって異なる | 返される最大エントリ数。値が最大値を超える場合は、最大値が使用されます。 |
| `usemarker` | Boolean | | ページネーションのタイプを選択するために、両タイプのページネーションをサポートするAPIエンドポイントで使用可能なクエリパラメータ (省略可)。`true`に設定すると、マーカーベースのページネーションが適用されます。 |
## コレクション
コレクションのページネーションを行うと、APIによって、結果のセットを配列として含むオブジェクトのほか、結果の現在のページに関する情報が返されます。
| フィールド | 型 | |
| ------------- | ------- | ------------------------------------------------------------------------------- |
| `entries` | Array | このページの項目を含むページ。結果がない場合は空の配列になります。 |
| `next_marker` | String | 結果の次のページを取得するために`marker`値として使用できる値。この値が`null`または空の文字列の場合は、これ以上取得する結果がありません。 |
| `limit` | Integer | 結果の現在のページに使用される制限。この制限は、このAPIエンドポイントに許可されている最大値を超えない限り、`limit`クエリパラメータと同じになります。 |
## エンドポイントの例
以下は、マーカーベースのページネーションをサポートするエンドポイントの例です。
* フォルダ内の項目を取得
* ファイルのコラボレーションのリストを取得
* ユーザーのすべてのWebhookのリストを取得
* 社内のすべてのユーザーのリストを取得
* ごみ箱にあるすべての項目のリストを取得