Adobe Experience Manager Assets デベロッパー向けの使用例、API、参考資料

このドキュメントは、Assets as a Cloud Service のデベロッパー向けリファレンス資料およびリソースが含まれています。新しいアップロードモジュール、API リファレンス、後処理ワークフローで提供されるサポートに関する情報が含まれています。

Experience Manager Assets API と操作

Assets as a Cloud Service には、デジタルアセットをプログラミングで操作するためのいくつかの API が用意されています。各 API は、以下の表に示すように、特定の使用例をサポートしています。Assets ユーザーインターフェイス、Experience Manager デスクトップアプリ、Adobe Asset Link は、すべての操作または一部の操作をサポートしています。

注意

一部の API は引き続き存在しますが、アクティブにサポートされていません(x で示されます)。可能な限り、これらの API は使用しないでください。

サポートレベル 説明
サポート対象
× サポートされていない。使用しないでください。
- 使用不可
使用例 aem-upload Experience Manager/Sling/JCR Java API Asset Compute Service Assets HTTP API Sling GETPOST サーブレット GraphQL
元のバイナリ
オリジナルを作成 × - × × -
オリジナルを読む - × -
オリジナルをアップデート × × × -
オリジナルを削除 - - -
オリジナルをコピー - - -
オリジナルを移動 - - -
メタデータ
メタデータを作成 - -
メタデータを読み取り - - -
メタデータを更新 - -
メタデータを削除 - -
メタデータをコピー - - -
メタデータを移動 - - -
コンテンツフラグメント(CF)
CF を作成 - - - -
CF を読み取り - - -
CF を更新 - - - -
CF を削除 - - - -
CF をコピー - - - -
CF を移動 - - - -
バージョン
バージョンを作成 - - - -
バージョンを読み取り - - - - -
バージョンを削除 - - - - -
フォルダー
フォルダーを作成 - - -
フォルダーを読み取り - - - -
フォルダーを削除 - - -
フォルダーをコピー - - -
フォルダーを移動 - - -

アセットのアップロード

Experience Manager as a Cloud Service では、HTTP API を使用して、アセットをクラウドストレージに直接アップロードできます。バイナリファイルをアップロードする手順は次のとおりです。これらの手順は、Experience Manager JVM 内ではなく、外部アプリケーションで実行します。

  1. HTTP リクエストを送信します。その結果、新しいバイナリをアップロードする意図が Experience Manager デプロイメントに通知されます。
  2. 開始リクエストで提供される 1 つ以上の URI にバイナリのコンテンツを PUT 送信します。
  3. HTTP リクエストを送信して、バイナリのコンテンツが正常にアップロードされたことをサーバーに通知します。

直接バイナリアップロードプロトコルの概要

重要

上記の手順は、Experience Manager JVM 内ではなく、外部アプリケーションで実行します。

このアプローチで、アセットのアップロードをスケーラブルかつより効率的に処理できます。Experience Manager 6.5 と比較した場合の違いは次のとおりです。

  • バイナリは Experience Manager を経由しません。AEM は、デプロイメント用に設定されたバイナリクラウドストレージを使用するアップロードプロセスを調整するだけです。
  • バイナリクラウドストレージは、コンテンツ配信ネットワーク(CDN)または Edge ネットワークと連携します。CDN は、クライアントに近いアップロードエンドポイントを選択します。特に地理的に分散したチームでは、データが近くのエンドポイントに転送される距離が短いほど、アップロードのパフォーマンスとユーザーエクスペリエンスが向上します。
メモ

この方法を実装するクライアントコードを確認するには、オープンソースの aem-upload ライブラリを参照してください。

アップロードの開始

HTTP POST リクエストを目的のフォルダーに送信します。このフォルダーでアセットが作成または更新されます。このリクエストがバイナリファイルのアップロードを開始するものであることを示すセレクター .initiateUpload.json を含めます。例えば、アセットが作成されるフォルダーのパスが /assets/folder の場合、POST リクエストは POST https://[aem_server]:[port]/content/dam/assets/folder.initiateUpload.json のようになります。

リクエスト本文のコンテンツタイプは、次のフィールドを含んだ application/x-www-form-urlencoded 形式のデータにする必要があります。

  • (string) fileName:必須。Adobe Experience Manager に表示されるアセットの名前
  • (number) fileSize:必須。アップロードされるアセットのファイルサイズ(バイト単位)

各バイナリに必須フィールドが含まれている限り、単一のリクエストを使用して複数のバイナリのアップロードを開始できます。成功した場合は、リクエストへの応答として、201 ステータスコードと、次の形式の JSON データを含んだ本文が返されます。

{
    "completeURI": "(string)",
    "folderPath": "(string)",
    "files": [
        {
            "fileName": "(string)",
            "mimeType": "(string)",
            "uploadToken": "(string)",
            "uploadURIs": [
                "(string)"
            ],
            "minPartSize": (number),
            "maxPartSize": (number)
        }
    ]
}
  • completeURI(文字列):バイナリのアップロードが完了したら、この URI を呼び出します。URI は絶対 URI でも相対 URI でも構いません。クライアントはどちらでも処理できるはずです。つまり、値は "https://[aem_server]:[port]/content/dam.completeUpload.json" または "/content/dam.completeUpload.json" でも構いません。アップロードの完了を参照してください。
  • folderPath(文字列):バイナリがアップロードされるフォルダーの完全なパス。
  • (files)(配列):開始リクエストで提供されるバイナリ情報のリストの長さと順序に一致する要素のリスト。
  • fileName(文字列):対応するバイナリの名前(開始リクエストで指定されたもの)。この値は、完了リクエストに含まれます。
  • mimeType(文字列):対応するバイナリの MIME タイプ(開始リクエストで指定されたもの)。この値は、完了リクエストに含まれます。
  • uploadToken(文字列):対応するバイナリのアップロードトークン。この値は、完了リクエストに含まれます。
  • uploadURIs(配列):バイナリコンテンツのアップロード先となる完全な URI を表す文字列のリストです(バイナリのアップロードを参照)。
  • minPartSize(数字):複数の URI がある場合にいずれかの uploadURIs に提供されるデータの最小長(バイト単位)。
  • maxPartSize(数字):複数の URI がある場合にいずれかの uploadURIs に提供されるデータの最大長(バイト単位)。

バイナリのアップロード

アップロードを開始した場合の出力には、1 つ以上のアップロード URI 値が含まれています。複数の URI を指定した場合、クライアントはバイナリを複数の部分に分割し、指定されたアップロード URI に対して、各部分のPUTリクエストを順におこなうことができます。 バイナリをパーツに分割する場合は、次のガイドラインに従ってください。

  • 各部品は、最後の部品を除き、以上のサイズである必要があります minPartSize.
  • 各パーツのサイズは以下でなければなりません maxPartSize.
  • バイナリのサイズがを超えた場合 maxPartSizeを使用する場合は、バイナリを複数の部分に分割してアップロードします。
  • すべての URI を使用する必要はありません。

バイナリのサイズが以下の場合 maxPartSizeの場合は、代わりに、バイナリ全体を単一のアップロード URI にアップロードできます。 複数のアップロード URI を指定する場合は、最初のアップロード URI を使用し、残りのアップロード URI は無視します。 すべての URI を使用する必要はありません。

CDN エッジノードを使用すると、要求されたバイナリアップロードを高速化できます。

これをおこなう最も簡単な方法は、 maxPartSize パーツサイズと同じにします。 API コントラクトでは、この値を部分サイズとして使用する場合、バイナリをアップロードするのに十分なアップロード URI があることを保証します。 これをおこなうには、バイナリをサイズの一部に分割します maxPartSize各パーツに対して 1 つの URI を順に使用します。 最後の部分は、以下の任意のサイズにすることができます maxPartSize. 例えば、バイナリの合計サイズが 20,000 バイトで、 minPartSize は 5,000 バイトです。 maxPartSize は 8,000 バイトで、アップロード URI の数は 5 です。 以下の手順を実行します。

  • 最初のアップロード URI を使用して、バイナリの最初の 8,000 バイトをアップロードします。
  • 2 番目のアップロード URI を使用して、バイナリの 2 番目の 8,000 バイトをアップロードします。
  • 3 番目のアップロード URI を使用して、バイナリの最後の 4,000 バイトをアップロードします。 これが最後の部分なので、以下の大きさにする必要はありません。 minPartSize.
  • 最後の 2 つのアップロード URI を使用する必要はありません。 無視してかまいません。

一般的なエラーは、API が提供するアップロード URI の数に基づいて部分のサイズを計算することです。 API 契約では、この方法が機能するとは保証されず、実際には、次の範囲外のパーツサイズになる場合があります。 minPartSize および maxPartSize. その結果、バイナリのアップロードに失敗する可能性があります。

繰り返しますが、最も簡単で安全な方法は、単にと同じサイズの部分を使用することです。 maxPartSize.

アップロードに成功した場合、サーバーは各リクエストへの応答として 201 ステータスコードを返します。

メモ

アップロードアルゴリズムについて詳しくは、 公式機能ドキュメント および API ドキュメント Apache Jackrabbit Oak プロジェクトの

アップロードの完了

バイナリファイルのすべての部分がアップロードされたら、開始データから提供される完全な URI に HTTP POST リクエストを送信します。リクエスト本文のコンテンツタイプは、次のフィールドを含んだ application/x-www-form-urlencoded 形式のデータにする必要があります。

フィールド 必須/未指定 説明
fileName 文字列 必須 アセットの名前(開始データで提供されたもの)。
mimeType 文字列 必須 バイナリの HTTP コンテンツタイプ(開始データで提供されたもの)。
uploadToken 文字列 必須 バイナリのアップロードトークン(開始データで提供されたもの)。
createVersion ブール値 オプション これが True で、指定した名前のアセットが存在する場合、Adobe Experience Manager はアセットの新しいバージョンを作成します。
versionLabel 文字列 オプション 新しいバージョンが作成される場合、アセットの新しいバージョンに関連付けられるラベル。
versionComment 文字列 オプション 新しいバージョンが作成される場合、そのバージョンに関連付けられたコメント。
replace ブール値 オプション これが True で指定した名前のアセットが存在する場合、Adobe Experience Manager はそのアセットを削除し、再作成します。
メモ

アセットが存在し、createVersionreplace も指定されていない場合、Adobe Experience Manager はアセットの現在のバージョンを新しいバイナリで更新します。

開始プロセスと同様に、完了リクエストデータには、複数のファイルに関する情報が含まれる場合があります。

バイナリのアップロードプロセスは、ファイルの完了 URL が呼び出されるまで実行されません。アセットは、アップロードプロセスの完了後に処理されます。アセットのバイナリファイルが完全にアップロードされても、アップロードプロセスが完了していなければ、処理は開始しません。アップロードが正常に完了した場合、サーバーは応答として 200 ステータスコードを返します。

オープンソースアップロードライブラリ

アップロードアルゴリズムの詳細を調べたり、独自のアップロードスクリプトやツールを作成する場合に役立つように、アドビでは、次のオープンソースライブラリおよびツールを提供しています。

非推奨(廃止予定)のアセットアップロード API

新しいアップロード方法は、Adobe Experience Manager as a Cloud Service の場合のみサポートされます。Adobe Experience Manager 6.5 の API は非推奨(廃止予定)となりました。アセットやレンディションのアップロードまたは更新(あらゆるバイナリアップロード)に関連するメソッドは、次の API で非推奨(廃止予定)となりました。

アセット処理ワークフローとアセット後処理ワークフロー

Experience Manager でのアセット処理は、アセットマイクロサービスを使用する​処理プロファイル​設定に基づいて行われます。処理には、開発者用の拡張機能は必要ありません。

後処理ワークフローの設定には、カスタム手順を指定した標準ワークフローを使用します。

後処理ワークフローでのワークフローステップのサポート

Adobe Experience Manager の以前のバージョンからアップグレードした場合は、アセットマイクロサービスを使用してアセットを処理できます。クラウドネイティブのアセットマイクロサービスは、設定と使用が簡単です。以前のバージョンの DAM アセットの更新ワークフローで使用されるワークフロー手順の一部はサポートされていません。サポートされているクラスについて詳しくは、Java API リファレンスか Javadoc を参照してください。

次の技術的ワークフローモデルは、アセットマイクロサービスに置き換わっているか、サポートされていません。

  • com.day.cq.dam.cameraraw.process.CameraRawHandlingProcess
  • com.day.cq.dam.core.process.CommandLineProcess
  • com.day.cq.dam.pdfrasterizer.process.PdfRasterizerHandlingProcess
  • com.day.cq.dam.core.process.AddPropertyWorkflowProcess
  • com.day.cq.dam.core.process.CreateSubAssetsProcess
  • com.day.cq.dam.core.process.DownloadAssetProcess
  • com.day.cq.dam.word.process.ExtractImagesProcess
  • com.day.cq.dam.word.process.ExtractPlainProcess
  • com.day.cq.dam.ids.impl.process.IDSJobProcess
  • com.day.cq.dam.indd.process.INDDMediaExtractProcess
  • com.day.cq.dam.indd.process.INDDPageExtractProcess
  • com.day.cq.dam.core.impl.lightbox.LightboxUpdateAssetProcess
  • com.day.cq.dam.pim.impl.sourcing.upload.process.ProductAssetsUploadProcess
  • com.day.cq.dam.core.process.SendDownloadAssetEmailProcess
  • com.day.cq.dam.similaritysearch.internal.workflow.smarttags.StartTrainingProcess
  • com.day.cq.dam.similaritysearch.internal.workflow.smarttags.TransferTrainingDataProcess
  • com.day.cq.dam.switchengine.process.SwitchEngineHandlingProcess
  • com.day.cq.dam.core.process.GateKeeperProcess
  • com.day.cq.dam.s7dam.common.process.DMEncodeVideoWorkflowCompletedProcess
  • com.day.cq.dam.core.process.DeleteImagePreviewProcess
  • com.day.cq.dam.video.FFMpegTranscodeProcess
  • com.day.cq.dam.core.process.ThumbnailProcess
  • com.day.cq.dam.video.FFMpegThumbnailProcess
  • com.day.cq.dam.core.process.CreateWebEnabledImageProcess
  • com.day.cq.dam.core.process.CreatePdfPreviewProcess
  • com.day.cq.dam.s7dam.common.process.VideoUserUploadedThumbnailProcess
  • com.day.cq.dam.s7dam.common.process.VideoThumbnailDownloadProcess
  • com.day.cq.dam.s7dam.common.process.VideoProxyServiceProcess
  • com.day.cq.dam.scene7.impl.process.Scene7UploadProcess
  • com.day.cq.dam.s7dam.common.process.S7VideoThumbnailProcess
  • com.day.cq.dam.core.process.MetadataProcessorProcess
  • com.day.cq.dam.core.process.AssetOffloadingProcess
  • com.adobe.cq.dam.dm.process.workflow.DMImageProcess

このページ