REST APIパラメータ
APIパラメータは、REST APIと一緒に使用して結果をフィルタリング、ソート、ページネーションしたり、フィールドや関連を選択してポピュレートしたりすることができます。また、AI Marketerのオプション機能に関連する特定のパラメータを使用することも可能です。例えば、コンテンツタイプのパブリケーション状態やロケールなどです。
以下のAPIパラメータが利用可能です:
| オペレータ | タイプ | 説明 |
|---|---|---|
populate | 文字列またはオブジェクト | 関連、コンポーネント、またはダイナミックゾーンをポピュレート |
fields | 配列 | 表示する特定のフィールドのみを選択 |
filters | オブジェクト | レスポンスをフィルタリング |
locale | 文字列 | ロケールを選択 |
status | 文字列 | ドラフト&パブリッシュのステータスを選択 |
sort | 文字列または配列 | レスポンスをソート |
pagination | オブジェクト | エントリをページごとに表示 |
クエリパラメータは、LHSブラケット構文(つまり、角括弧 [] を使用してエンコードされます)を使用します。
💡 Tip
REST APIパラメータは、幅広く使用し、組み合わせることができます。これにより、長く複雑なクエリURLが生成される可能性があります。
👉 AI Marketerのインタラクティブなクエリビルダーツールを使用すると、クエリURLをより便利に作成することができます。🤗