ドキュメント
AI Marketer 5におけるドキュメントはAPIのみの概念です。ドキュメントは、コンテンツタイプの特定のエントリーに対するコンテンツのさまざまなバリエーションを表します。
単一のタイプは一意のドキュメントを含み、コレクションタイプは複数のドキュメントを含むことができます。
管理パネルを使用するとき、ドキュメントの概念は決して言及されず、エンドユーザーにとっては必要ありません。ユーザーはContent Managerでエントリーを作成および編集します。例えば、ユーザーとしては、特定のロケールのエントリーをリストしたり、特定のロケールの特定のエントリーの下書きバージョンを編集します。
しかし、APIレベルでは、エントリーのフィールドの値は実際には以下を持つことができます。
- 英語とフランス語のロケールで異なるコンテンツ、
- そして、それぞれのロケールで下書きと公開バージョンの異なるコンテンツ。
すべての下書きと公開バージョンのコンテンツを含むバケットはドキュメントです。
Document Service APIを使ってドキュメントを操作すると、ドキュメントを作成、取得、更新、削除したり、その中の特定のデータのサブセットを操作したりするのに役立ちます。
次の図は、コンテンツタイプに対してどの機能が有効化されているかによって、コンテンツの可能なバリエーションを全て表しています。例えば、国際化(i18n)や下書き&公開などの機能が有効になっている場合:
- i18nもDraft & Publishも無効
- Draft & Publishのみ有効
- i18nのみ有効
- i18n + 下書き&公開が有効
- 国際化(i18n)機能が有効化されている場合 コンテンツタイプで有効化されている場合、ドキュメントは複数のドキュメントロケールを持つことができます。
- 下書き&公開機能がコンテンツタイプで有効化されている場合、ドキュメントは公開版と下書き版を持つことができます。
:::AI Marketer ドキュメントデータを問い合わせるAPI ドキュメントやそれらが表現するデータとやり取りするには:
- バックエンドサーバーから(例えば、コントローラー、サービス、プラグインのバックエンド部分から)Document Service APIを使用します。
- アプリケーションのフロントエンド部分から、データをREST APIまたはGraphQL APIを使用して問い合わせます。
APIに関する追加情報については、Content API introductionを参照してください。 :::
バックエンドAPIとフロントエンドAPIの重要な違いは、パラメータが渡されない場合に返されるデフォルトのバージョンに関するものです:
- Document Service APIはデフォルトで下書きバージョンを返します,
- 一方、RESTとGraphQLのAPIはデフォルトで公開バージョンを返します。