1. アップロード API (V1)

アップロード API (V1)

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

アップロード API を使用すると、Sitecore Content Hub™、Web UI 以外のクライアントからアップロードできます。たとえば、Sitecore Connect™ for Creative Cloud™ を使用できます。

アップロード API は、次のエンドポイントを公開します。

  • api/v1.0/upload: アップロード URL を要求します。
  • api/v1.0/upload/assets: すでにアップロードされているファイルから新しいアセットをアップロード (作成) します。
  • api/v1.0/upload/assets/{id}: 既存のアセットのマスター ファイルをアップロードします。
  • api/v1.0/upload/assets/{id}/alternative: 既存のアセットの代替ファイルをアップロードします。

完全なアップロード フローは、次の 3 つのステップで構成されます。

  1. アップロード URL の要求
  2. 受信した URL へのファイルのアップロード
  3. 新しいアセットのアップロード/作成、またはマスター ファイル/代替ファイルによる既存のアセットの更新

アップロード URL の要求

アップロード URL を取得するには、POST 要求をエンドポイント api/v1.0/upload に送信します。

要求フォームの本文には、次のフィールドが含まれている必要があります。

  • fileName - アップロードするファイルの名前。
  • fileSize - アップロードするファイルのサイズ。

成功した応答では、アップロード URL を含むロケーション ヘッダーと、次のように構造化された情報を含む JSON 本文が返されます。

{
"fileIdentifier": "azr123grz3",
"storageIdentifier": "weu"
}
  • fileIdentifier は、システム内のファイルの識別子を表します。
  • storageIdentifier は、ファイルが保存されている場所を表します。これは JSON では null か欠落している可能性があります。

アップロード URL は、常に Azure Storage Blob を指します。

分散アップロードの場合、ポータル アプリケーションの API エンドポイント api/v1.0/upload によってトラフィック マネージャーにリダイレクトされ、最も近い衛星がアップロード URL を作成して返します。

受信した URL へのファイルのアップロード

受信したアップロード URL は、Azure Storage Blob のパブリック URL です。つまり、Azure Blob サービスの REST API を使用してファイルをアップロードできます。

アップロードを実行するには、次の必須ヘッダーを使用して、PUT 要求をアップロード URL に送信します。

  • x-ms-blob-type: Azure は、値が BlockBlob であると予期しています。
  • x-ms-blob-content-type: ファイルのコンテンツ タイプ
  • x-ms-meta-Filename: ファイルの名前

Azure Blob Storage に大きなファイルをアップロードする

ファイルが 200 MB より大きい場合は、ファイルを分割し、クエリ文字列パラメーター comp=block&blockid={blockid} でアップロード URL を拡張することにより、ブロックごとに Azure に送信します。

  • blockid は、ブロックを識別するための有効な Base64 文字列値です。
  • 特定の blob について、指定された blockid 値の長さは、各ブロックで同じサイズである必要があります。

すべてのブロックが送信されたら、アップロード URL に別の要求を送信して、アップロードが完了したことと、すべてのブロックをまとめる必要があることを通知します。

  • クエリ文字列パラメーター comp=blocklist を使用してアップロード URL を拡張します。
  • 要求の本文は XML 形式でなければなりません。また、blockid を使用してブロックを読み込む順序を指定する必要があります。

次のコード スニペットは、blockid を使用してブロックを読み込む方法を示しています。

<?xml version="1.0" encoding="utf-8"?>  
<BlockList>  
<Latest>AAAAAA==</Latest>  
<Latest>AQAAAA==</Latest>  
<Latest>AZAAAA==</Latest>  
</BlockList>

この最後の要求は、次のヘッダーを要求します。

  • x-ms-blob-content-type: ファイルのコンテンツ タイプ
  • x-ms-meta-Filename: ファイルの特定の名前
注意

詳細については、Azure Put ブロックのドキュメントを参照してください。また、JavaScript Azure SDK を使用して、前述のアクションを実行することもできます。

新しいアセットのアップロード/作成、またはマスター ファイル/代替ファイルによる既存のアセットの更新

アップロードされたファイルから新しいアセットを作成するには、POST 要求を api/v1.0/upload/assets に送信します。

既存のアセットのマスター ファイルをアップロードするには、アセットの ID を使用して、POST 要求を api/v1.0/upload/assets/{id} に送信します。

既存のアセットの代替ファイルをアップロードするには、アセットの ID を使用して、POST 要求を api/v1.0/upload/assets/{id}/alternative に送信します。

重要

いずれにしても、要求本文には以前に受信した JSON コンテンツが含まれている必要があります。

アップロード設定

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

アップロードは、アップロード設定を使用して処理されます。アップロード設定には次のものが含まれます。

  • 許可される最大ファイル サイズ: アップロードできるファイルのサイズを制限します。
  • 許可されていない拡張子: アップロードが許可されていないファイル拡張子を定義します。
  • DefaultUploadConfiguration: 既定の設定を定義します。
注意

スーパーユーザーは、ApiUploadConfigurationsetting を使用して、作成されたアセットのリポジトリとライフ サイクルのアップロード設定をオーバーライドできます。この設定を変更するには、[管理] をクリックし、[管理] ページで [設定] をクリックします。ProtalConfiguration で、ApiUploadConfigurationsetting を選択します。

この記事を改善するための提案がある場合は、 お知らせください!