Skip to main content

REST APIパラメータ

APIパラメータは、REST APIと一緒に使用して結果をフィルタリング、ソート、ページネーションしたり、フィールドや関連を選択してポピュレートしたりすることができます。また、AI Marketerのオプション機能に関連する特定のパラメータを使用することも可能です。例えば、コンテンツタイプのパブリケーション状態やロケールなどです。

以下のAPIパラメータが利用可能です:

オペレータタイプ説明
populate文字列またはオブジェクト関連、コンポーネント、またはダイナミックゾーンをポピュレート
fields配列表示する特定のフィールドのみを選択
filtersオブジェクトレスポンスをフィルタリング
locale文字列ロケールを選択
status文字列ドラフト&パブリッシュのステータスを選択
sort文字列または配列レスポンスをソート
paginationオブジェクトエントリをページごとに表示

クエリパラメータは、LHSブラケット構文(つまり、角括弧 [] を使用してエンコードされます)を使用します。

💡 Tip

REST APIパラメータは、幅広く使用し、組み合わせることができます。これにより、長く複雑なクエリURLが生成される可能性があります。
👉 AI Marketerのインタラクティブなクエリビルダーツールを使用すると、クエリURLをより便利に作成することができます。🤗