AEM Assets HTTP API での コンテンツフラグメントのサポート content-fragments-support-in-aem-assets-http-api

概要 overview

AEM ヘッドレス配信機能の重要な部分である、Assets HTTP API でのコンテンツフラグメントのサポートについて学びます。

Assets REST API を使用すると、Adobe Experience Manager as a Cloud Service の開発者は、HTTP API 経由で CRUD 操作（作成、読み取り、更新、削除）を介して、（AEM に保存された）コンテンツに直接アクセスできます。

この API では、コンテンツサービスを JavaScript フロントエンドアプリケーションに提供することで、Adobe Experience Manager as a Cloud Service をヘッドレス CMS（コンテンツ管理システム）として動作させることができます。または、HTTP リクエストを実行して JSON 応答を処理できるその他のアプリケーション。

例えば、単一ページアプリケーション（SPA）では、フレームワークベースかカスタムかを問わず、HTTP API 経由で提供されるコンテンツ（多くの場合 JSON 形式）が必要です。

While AEMコアコンポーネント この目的で必要な読み取り操作と、JSON 出力をカスタマイズできる API には、実装にAEM WCM(Web Content Management) のノウハウが必要です。 これは、専用のAEMテンプレートに基づくページでホストする必要があるからです。 すべての SPA 開発組織が、こうした知識にアクセスできるわけではありません。

これが可能なのは、Assets REST API が使用できる場合です。この場合は、アセット（画像やコンテンツフラグメントなど）に直接アクセスでき、その際に、ページにアセットを埋め込んでからコンテンツをシリアル化 JSON 形式で配信する必要はありません

また、Assets REST API を使用すると、アセット、コンテンツフラグメント、フォルダーの新規作成、更新、削除のいずれかの操作でコンテンツを変更することもできます。

Assets REST API は、

前提条件 prerequisites

Assets REST API は、最新の Adobe Experience Manager as a Cloud Service バージョンの標準インストールで利用できます。

主要な概念 key-concepts

Assets REST API を使用すると、AEM インスタンス内に格納されたアセットに REST 形式でアクセスすることができます。

/api/assets エンドポイントを使用しており、アクセスするにはアセットのパス（先頭の /content/dam を除く）が必要です。

例えば、/content/dam/wknd/en/adventures/cycling-tuscany にアクセスするには、/api/assets/wknd/en/adventures/cycling-tuscany.json をリクエストします。

実行する操作は HTTP メソッドで決まります。

サポートされているリクエストの正確な形式は、API リファレンスドキュメントで定義されています。

トランザクション動作 transactional-behavior

すべてのリクエストはアトミックです。

つまり、後続の（write）リクエストを結合して、単一のエンティティとして成功または失敗する単一のトランザクションにすることはできません。

AEM（Assets）REST API と AEM コンポーネントの比較 aem-assets-rest-api-versus-aem-components

セキュリティ security

特定の認証要件がない環境で Assets REST API が使用される場合は、AEM の CORS フィルターを正しく設定する必要があります。

特定の認証要件がある環境では、OAuth を推奨します。

使用可能な機能 available-features

コンテンツフラグメントは特定のアセットタイプです。コンテンツフラグメントの操作を参照してください。

API を通じて使用できる機能について詳しくは、以下を参照してください。

ページング paging

Assets REST API では、URL パラメーターを介して（GET リクエストの）ページングをサポートしています。

応答には、SIREN 出力の properties セクションの一部としてページング情報が含まれます。この srn:paging プロパティには、リクエストで指定されている、（子）エンティティの総数（total）、オフセット（offset）および制限（limit）が含まれています。

例：ページング example-paging

GET /api/assets.json?offset=2&limit=3

...
"properties": {
    ...
    "srn:paging": {
        "total": 7,
        "offset": 2,
        "limit": 3
    }
    ...
}
...

エンティティタイプ entity-types

フォルダー folders

フォルダーは、アセットや他のフォルダーのコンテナとして機能します。 AEM コンテンツリポジトリーの構造を反映しています。

Assets REST API は、フォルダーのプロパティへのアクセスを公開します。 例えば、名前やタイトルなどです。 アセットは、フォルダーの子エンティティ、およびサブフォルダーとして公開されます。

Assets assets

アセットが要求されると、アセットのメタデータ（タイトルや名前など、それぞれのアセットスキーマで定義される情報）が応答で返されます。

アセットのバイナリデータは、content タイプの SIREN リンクとして公開されます。

アセットには複数のレンディションを含めることができます。通常、これらは子エンティティとして公開されます。ただし、サムネールレンディションは例外です。これは、thumbnail タイプ（rel="thumbnail"）のリンクとして公開されます。

コンテンツフラグメント content-fragments

コンテンツフラグメントは特殊なタイプのアセットです。テキスト、数値、日付などの構造化データにアクセスするために使用できます。

標準 ​アセット（画像やオーディオなど）との違いがいくつかあるので、それらの処理には追加のルールが適用されます。

表現 representation

コンテンツフラグメント：

コンテンツモデルとコンテンツフラグメント content-models-and-content-fragments

現在、コンテンツフラグメントの構造を定義するモデルは、HTTP API では公開されません。したがって、 消費者 は、フラグメントのモデルについて（少なくとも 1 つ）把握している必要があります。ほとんどの情報はペイロードから推論できますが、データタイプなどは定義の一部です。

新しいコンテンツフラグメントを作成するには、（内部リポジトリ）モデルのパスを指定する必要があります。

関連コンテンツ associated-content

関連コンテンツは現在公開されていません。

使用 using

使用方法は、特定の使用例以外にも、AEM オーサーを使用するかパブリッシュ環境を使用するかで異なることがあります。

制限事項 limitations

次のように、いくつかの制限があります。

ステータスコードとエラーメッセージ status-codes-and-error-messages

関連する状況で次のステータスコードが表示されることがあります。

API リファレンス api-reference

詳細な API リファレンスについては、こちらを参照してください。

その他のリソース additional-resources

詳しくは、次を参照してください。