Assembly の変更をリアルタイムでストリーミングする
Assembly Status の変更を Server-Sent Events としてストリーミングします。
{UPDATE_STREAM_URL}検証済みの Assembly レスポンスに含まれる update_stream_url ケイパビリティ URL をリクエスト先として使用します。API2 ホストに関連付けられ、暗黙的に利用可能な認証情報は使用しません。
Assembly を作成した後のレスポンスには、Assembly Status を取得するための
2 つのフィールド、assembly_ssl_url と update_stream_url があります。assembly_ssl_url に指定された URL から現在の Assembly Status を取得できます。Assembly の進行状況を把握するには、その URL を定期的にポーリングするか、このドキュメントで説明する更新ストリームを購読できます。
サーバー送信イベント
Assembly Status の update_stream_url プロパティは、対応する Assembly の更新ストリームをサーバー送信イベントで利用できる URL を定義します。
サーバー送信イベントは、HTTP 経由でサーバーからクライアントへリアルタイムに通知を送信するための Web 技術です。Web Sockets に似ていますが、サーバーからクライアントへの一方向のメッセージのみを許可し、シンプルなテキストベースの形式で構成されます。
Assembly がアップロード中または実行中の状態にある間、クライアントは
update_stream_url に指定された URL に、Accept: text/event-stream ヘッダーフィールドを付けた
GET リクエストを送信してこのエンドポイントに接続し、レスポンスストリームを解析できます。サーバーは、メッセージとイベントを混在させてクライアントに送信できます。両者の違いは、イベントには情報を含む追加のペイロードがありますが、メッセージにはないことです。
複数のクライアントが同じ Assembly を購読できます。1 つの接続を閉じても、他の接続は維持されます。アップローダーのシャットダウン中は、既存のストリームが閉じられ、新しい接続には空の HTTP 503 レスポンスが返されます。現在の Assembly Status を取得して、処理が終了したかどうかを確認してください。
メッセージ
メッセージはメッセージ名で構成され、追加のペイロードはありません。通信上では、assembly_finished という名前のメッセージは次のようになります([NL] は改行を示します)。
data: assembly_finished[NL]
[NL]
Transloadit は次のメッセージを送信します。
assembly_upload_meta_data_extractedは、すべてのアップロードが完了し、それらすべてのメタデータが抽出されたときに送信されます。assembly_uploading_finishedは、この Assembly のすべてのアップロードが完了し、Assembly がアップロード中から実行中の状態に移行するときに送信されます。assembly_finishedは、Assembly が終了したときに送信されますが、必ずしも処理が成功したことを意味するわけではありません。キャンセル後や、失敗したものを含め、すでに終了した Assembly に接続したときにも送信されます。サーバーはこのメッセージの後にストリームを終了します。assembly_ssl_urlの内容を取得し、最終ステータスを確認してください。ok: "ASSEMBLY_COMPLETED"は成功、ok: "ASSEMBLY_CANCELED"はキャンセル、errorは失敗を示します。pingは、Assembly の処理中に接続を維持するため、定期的に送信されます。現在は毎分送信されますが、この間隔は将来変更される可能性があります。
イベント
イベントは、イベント名と追加のペイロードで構成されます。通信上では、assembly_result_finished という名前のイベントは次のようになります([NL] は改行を示します)。
event: assembly_result_finished[NL]
data: ["avatar",{"id":"5789e06b48ad450aa55f9b3721376581","basename":"lesereihe","field":"file","md5hash":"e9df77e5ee87e8ec3b4453bcddf191bc","ext":"pdf","meta":{"width":1238,"height":1750,"page_count":1},"mime":"application/pdf","name":"lesereihe.pdf","size":120456,"type":"pdf"}][NL]
[NL]
Transloadit は次のイベントを送信します。
-
assembly_errorは、Assembly の実行中にエラーが発生したときに送信されます。サーバーはこのイベントの後にストリームを終了します。エラーに関する追加情報が含まれます。例:{ "error": "FILE_FILTER_DECLINED_FILE", "message": "One of your files was declined", "step": "filter", "previousStep": ":original", "http_code": 400 } -
assembly_upload_finishedは、完了したアップロードごとに送信されます。アップロードされたファイルに関する追加情報が含まれます。構造は、Assembly Status のuploads配列内のオブジェクトと同じです。例:{ "id": "6bb16f6cd49a44b4ae431f576e016c6d", "name": "lesereihe.doc", "basename": "lesereihe", "ext": "doc", "size": 61440, "mime": "application/msword", "type": "office", "field": "file", "md5hash": "154a9349b8f9111865a07ed0a7050f55", "original_id": "6bb16f6cd49a44b4ae431f576e016c6d", "url": null, "meta": {} } -
assembly_result_finishedは、Step の新しい結果が利用可能になるたびに送信されます。ペイロードは[stepName, file]タプルです。file オブジェクトは、Assembly Status のresults[stepName]内の要素と同じ構造です。例:[ "avatar", { "id": "5789e06b48ad450aa55f9b3721376581", "basename": "lesereihe", "field": "file", "md5hash": "e9df77e5ee87e8ec3b4453bcddf191bc", "ext": "pdf", "meta": { "width": 1238, "height": 1750, "page_count": 1 }, "mime": "application/pdf", "name": "lesereihe.pdf", "size": 120456, "type": "pdf" } ] -
assembly_execution_progressは、Assembly とそのファイルの全体的な Execution Progress に関する情報とともに、一定の間隔で送信されます。構造と仕組みの詳細は、Assembly Execution Progress で説明しています。例:{ "progress_combined": 50, "progress_per_original_file": [ { "original_id": "6bb16f6cd49a44b4ae431f576e016c6d", "progress": 50 } ] }注:
progress_per_original_fileはoriginal_idをキーとします。original_idのないインポートされたファイルは、このリストには表示されません。
将来、メッセージやイベントが追加される可能性があります。そのため、クライアントは想定外のメッセージやイベントを無視し、エラーで停止しないようにする必要があります。
ストリームは過去のイベントを再送しません。特に、assembly_error リスナーは、接続する前に発生したエラーを報告できません。Assembly がアップローダーのメモリ内に存在しなくなると、ストリーム URL は HTTP 404 を返します。切断された場合やストリームを利用できない場合は、assembly_ssl_url の内容を取得してください。Assembly がまだアップロード中または実行中であれば、その URL のポーリングを続けてください。ストリームが閉じられたことだけでは、成功したとは判断できません。
JavaScript の例
最新のブラウザーは、EventSource コンストラクターを通じてサーバー送信イベントをネイティブにサポートしています。Assembly Status が assembly_status 変数に格納されている場合、クライアントは次のように assembly_finished メッセージ、assembly_uploading_finished メッセージ、および
assembly_result_finished イベントをリッスンできます。ストリームが切断されると、この例では 2 秒ごとのポーリングに切り替え、Assembly が終端ステータスに達するまで続けます。HTTP またはネットワークの障害は、成功として扱われるのではなく、報告されます。
const stream = new EventSource(assembly_status.update_stream_url)
const activeStatuses = ["ASSEMBLY_UPLOADING","ASSEMBLY_EXECUTING","ASSEMBLY_REPLAYING"]
let pollingStarted = false
async function checkAssemblyStatus() {
while (true) {
const response = await fetch(assembly_status.assembly_ssl_url)
if (!response.ok) {
throw new Error(`Assembly status request failed: ${response.status}`)
}
const status = await response.json()
if (status.error) {
console.error('Assembly failed', status.error)
return
}
if (status.ok === 'ASSEMBLY_COMPLETED') {
console.log('Assembly completed', status.results)
return
}
if (status.ok === 'ASSEMBLY_CANCELED') {
console.warn('Assembly was canceled')
return
}
if (!activeStatuses.includes(status.ok)) {
throw new Error(`Assembly did not complete successfully: ${status.ok}`)
}
console.log('Assembly is not complete; continue polling its status URL', status.ok)
await new Promise((resolve) => setTimeout(resolve, 2000))
}
}
function closeStreamAndCheckStatus() {
if (pollingStarted) return
pollingStarted = true
stream.close()
checkAssemblyStatus().catch(console.error)
}
// Listen for the assembly_finished and assembly_uploading_finished messages
stream.addEventListener('message', (event) => {
switch (event.data) {
case 'assembly_finished':
closeStreamAndCheckStatus()
break
case 'assembly_uploading_finished':
console.log('All uploads are finished')
break
}
})
// Handle terminal Assembly errors without reconnecting the stream
stream.addEventListener('assembly_error', (event) => {
const error = JSON.parse(event.data)
console.error('Assembly failed', error)
closeStreamAndCheckStatus()
})
// Recover from a disconnected or unavailable stream using the status URL
stream.addEventListener('error', closeStreamAndCheckStatus)
// Listen for the assembly_result_finished event
stream.addEventListener('assembly_result_finished', (event) => {
const result = JSON.parse(event.data)
console.log('Assembly result is available', result)
})
リクエスト例
UPDATE_STREAM_URL に、Assembly 作成レスポンスの update_stream_url の完全な URL を設定してください。ホスト名は置き換えないでください。
curl --fail-with-body -sS --request GET --no-buffer \
--url "${UPDATE_STREAM_URL:?Set UPDATE_STREAM_URL}" \
--header 'accept: text/event-stream'
必須のリクエストヘッダー
accept(固定値)、必須。指定可能な値: "text/event-stream"。 複数回出現するヘッダーの値は、照合前に結合されます。
任意のレスポンスクエリパラメーター
callback(JavaScript コールバック名)。JSON レスポンスを JSONP コールバックでラップします。コールバック名は^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$に一致する必要があります。最後に指定されたものだけが使用され、空の値は無視されます。コールバック名が無効な場合は HTTP 403 が返されます。変換後のレスポンスは HTTP 200 を使用します。コールバックはレスポンスのシリアライズ後に適用されます。
リクエスト
追加のリクエストボディやフィールドは必要ありません。
レスポンス
レスポンスボディの例を以下に示します:
data: assembly_uploading_finished
event: assembly_upload_finished
data: {"id":"6bb16f6cd49a44b4ae431f576e016c6d","name":"lesereihe.doc","basename":"lesereihe","ext":"doc","size":61440,"mime":"application/msword","type":"office","field":"file","md5hash":"154a9349b8f9111865a07ed0a7050f55","original_id":"6bb16f6cd49a44b4ae431f576e016c6d","url":null,"meta":{}}
data: assembly_upload_meta_data_extracted
event: assembly_result_finished
data: ["avatar",{"id":"5789e06b48ad450aa55f9b3721376581","basename":"lesereihe","field":"file","md5hash":"e9df77e5ee87e8ec3b4453bcddf191bc","ext":"pdf","meta":{"width":1238,"height":1750,"page_count":1},"mime":"application/pdf","name":"lesereihe.pdf","size":120456,"type":"pdf"}]
event: assembly_execution_progress
data: {"progress_combined":100,"progress_per_original_file":[]}
data: assembly_finished
2xx 成功
Server-Sent Events のレスポンスストリーム。 text/event-stream
assembly_error
data フィールドに JSON ペイロードを持つ名前付きイベント。 サーバーはこの通知の後にストリームを閉じます。結果を判断するには、リソースの最終ステータスを取得してください。
イベントペイロード
完全な JSON スキーマ
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 |
|---|---|
error | string (最小長: 1)エラーコード(利用可能な場合)。このフィールドが存在しない場合でも、最終的な Assembly Status を取得してください。 既知の値(370)。その他の値もあり得ます
|
http_code | numberエラーに関連する HTTP ステータスです。このフィールドは、すでに開かれているストリームの HTTP ステータスを変更しません。 |
message | stringこの Assembly の状態を説明する、人が読んで理解できるメッセージです。必ずしも含まれるとは限りません。 |
previousStep | stringエラーに関連する前の Step の名前(取得可能な場合)。 |
reason | null | string | number | boolean | Array<任意の値> | object省略可能な診断の詳細情報です。この値が文字列であると仮定したり、そのまま表示したりしないでください。人が読めるテキストには 次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |
step | stringエラーに関連付けられた Step の名前(取得可能な場合)。 |
assembly_execution_progress
data フィールドに JSON ペイロードを持つ名前付きイベント。
イベントペイロード
完全な JSON スキーマ
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 | ||||||
|---|---|---|---|---|---|---|---|
progress_combined必須 | number | null全体の進捗の推定値をパーセントで表したものです。Null は、全体の進捗を推定できないことを意味します。 | ||||||
progress_per_original_file必須 | Array<object>元の入力ファイルの進捗推定値です。元の ID を持たないインポート済みファイルは含まれません。 配列要素のスキーマ
|
assembly_finished
data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。 サーバーはこの通知の後にストリームを閉じます。結果を判断するには、リソースの最終ステータスを取得してください。
ping
data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。
assembly_result_finished
data フィールドに JSON ペイロードを持つ名前付きイベント。
イベントペイロード
完全な JSON スキーマ
[string, object] (最小項目数: 2, 最大項目数: 2)タプルの要素 1
stringタプルの要素 2
[1]: このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
[1]. | string | Array<string> | null次のいずれかのスキーマが適用される場合があります: stringArray<string>Array<string>配列要素のスキーマstringnull | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number保存されたアセットのリビジョンを表す数値。保持されている正確なバイト列を選択するには、この数値ではなく | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string拡張子を除いたファイル名。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | stringファイルの拡張子です。拡張子が判定されていない場合は | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | stringこのファイルの送信に使用するフォームフィールドの名前。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | booleanこの保存済み画像バージョンにアルファチャンネルがあるかどうか(判明している場合)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | stringTransloadit がファイルを追跡するために内部で使用する、ランダムかつ一意の ID。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | object | null以下に示すような、ファイルから抽出された追加のメタデータを含むオブジェクトです。繰り返し現れる日付タグは、元の値のリストとして返されることがあります。値を単一のタイムスタンプとして使用する前に、その値の型を確認してください。 次のいずれかのスキーマが適用される場合があります: object
null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | stringこのファイルについて判定された MIME タイプ。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | stringファイルの名前です。ファイルが処理によって別の形式に変換される場合、Transloadit はこのフィールドで使用する拡張子を変更します。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | Array<null | string>このファイルの生成元となった元のアップロードファイルの一意の ID です。これは、いくつかの Steps の処理を経た後に、複数ファイルのアップロードのうち、特定のファイルの生成にどのファイルが使用されたかを判断するのに役立ちます。 次のいずれかのスキーマが適用される場合があります: stringArray<null | string>Array<null | string>配列要素のスキーマnull | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string保存されたバイト列の SHA-256 チェックサム(小文字、利用可能な場合)。 検証パターン(正規表現)^[a-f0-9]{64}$ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | nullファイルのサイズ(バイト単位)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string利用可能な場合に、この保存済み画像バージョンとともに保持される Base64 エンコード済みの ThumbHash。この画像データは、元の画像と同じアクセス制御で保護してください。 検証パターン(正規表現)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | stringファイルを表す抽象的なカテゴリです。既知の値は | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | null | stringファイルをダウンロードできる URL、または配信用 URL が利用できない場合は | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | object | null次のいずれかのスキーマが適用される場合があります: objectobject追加プロパティのスキーマ任意の値null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | stringストレージが結果を確定した後に返される不変のバージョン ID です。保持およびアクセスに関する条件の範囲内で、移動や上書きの後も同じバイト列を保持するには、 検証パターン(正規表現)^[A-Za-z0-9_-]{21}[AQgw]$ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1].必須 | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1].必須 | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[1]. | string (最小長: 1)この保存済みの結果を所有する Workspace のスラッグです。この結果をインポートまたは管理する際は、この Workspace に対して認証してください。 |
assembly_upload_finished
data フィールドに JSON ペイロードを持つ名前付きイベント。
イベントペイロード
完全な JSON スキーマ
このオブジェクトについて列挙されているフィールド以外のフィールドも受け付けます。
| フィールド | 型と説明 |
|---|---|
as | string | Array<string> | null次のいずれかのスキーマが適用される場合があります: stringArray<string>Array<string>配列要素のスキーマstringnull |
asset_id | string
|
asset_version | number保存されたアセットのリビジョンを表す数値。保持されている正確なバイト列を選択するには、この数値ではなく |
basename必須 | null | string拡張子を除いたファイル名。 |
cost | number | null |
exec_time | number |
ext必須 | null | stringファイルの拡張子です。拡張子が判定されていない場合は |
field必須 | null | stringこのファイルの送信に使用するフォームフィールドの名前。 |
from_batch_import | boolean |
has_alpha | booleanこの保存済み画像バージョンにアルファチャンネルがあるかどうか(判明している場合)。 |
id必須 | stringTransloadit がファイルを追跡するために内部で使用する、ランダムかつ一意の ID。 |
import_url | string |
is_temp_url | boolean |
is_tus_file | boolean |
md5hash | null | string |
meta必須 | 以下に示すような、ファイルから抽出された追加のメタデータを含むオブジェクトです。繰り返し現れる日付タグは、元の値のリストとして返されることがあります。値を単一のタイムスタンプとして使用する前に、その値の型を確認してください。
|
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | number | nullこの画像の絞り値(例: |
meta. | null | string |
meta. | string | number | boolean | Array<string | number | boolean> | nullメディアのメタデータに記録されているアーティスト情報です。繰り返し出現するタグはリストとして返されます。数値のように見える名前や |
meta. | number | string | null画像のアスペクト比で、幅を高さで割った値です。何らかの理由で画像の高さが 0 の場合は、0 になります。 |
meta. | number | null全チャンネルを合計した音声ビットレートをビット/秒で表した値(例: |
meta. | null | string |
meta. | number | null音声チャンネル数。ステレオの場合は通常 |
meta. | null | string音声コーデック( |
meta. | null | string |
meta. | null | string |
meta. | number | null音声のサンプルレート(ヘルツ単位)。例: |
meta. | string | number | null画像の撮影者。一部のカメラは、 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | null | string最も出現頻度の高いピクセルの色を 1 色だけ集計し、用途が限られるドミナントカラーと混同しないでください。平均色は、まず入力画像を 1 ピクセルに縮小して計算されます。 |
meta. | null | string |
meta. | number | null |
meta. | number | null |
meta. | number | null |
meta. | number | nullOffice ドキュメントのプロパティに保存されている文字数。 |
meta. | number | null |
meta. | string | number | nullこの画像が撮影された都市(例: 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | boolean | null |
meta. | string | Array<string | number> |
meta. | null | string |
meta. | null | string |
meta. | null | string検出されたメディアの色空間( |
meta. | null | string |
meta. | null | string |
meta. | string | number | object | null著作権のメタデータフィールド。 |
meta. | string | number | boolean | nullファイルから抽出された著作権表示のメタデータです。元のスカラー値は保持されます。文字列メソッドを使用する前に型を確認してください。 次のいずれかのスキーマが適用される場合があります: string | number | booleanstring | number | booleannull |
meta. | null | stringこの画像が撮影された国(例: |
meta. | string | number | null画像のメタデータに記録された国コードです。例: 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | Array<string | number> | null |
meta. | string | number | boolean | Array<string | number | boolean> | nullファイルから抽出された作成者メタデータです。元のスカラー値は、それらの値のリストも含めて保持されます。文字列メソッドを使用する前に型を確認してください。 |
meta. | string | number | Array<string | number> | nullメディアのメタデータで報告される作成タイムスタンプ(利用可能な場合)。 |
meta. | string | number | Array<string | number> | nullファイルシステムまたはメディアに埋め込まれたメタデータによって報告される更新タイムスタンプ。 |
meta. | string | number | Array<string | number> | nullメディアが記録された日時。単一の有効な文字列のタイムスタンプは、 |
meta. | string | number | nullこの画像の説明(例: 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | Array<string | object> |
meta. | string | number | nullメディアを記録したデバイスの名前です( 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | nullメディアを記録したデバイスのソフトウェアバージョン( 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | nullメディアを記録したデバイスの製造元( 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | Array<string> | null画像の主要な色を最大 10 色、16 進数の値の配列として返します。この抽出をスキップするには、 |
meta. | number | null音声ファイルの長さ(秒単位)。 |
meta. | null | string |
meta. | null | string |
meta. | null | string |
meta. | null | string |
meta. | number | null |
meta. | null | string |
meta. | number | string | nullこの画像の露出補正値( 次のいずれかのスキーマが適用される場合があります: number | stringnumber | stringnull |
meta. | string | number | nullこの画像の露出モードです( 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | number | string | nullこの画像の露光時間です(例: 次のいずれかのスキーマが適用される場合があります: number | stringnumber | stringnull |
meta. | number | nullこの画像の F 値( |
meta. | Array<object> | null |
meta. | null | stringFFprobe が報告するフィールドオーダーで、 |
meta. | null | stringこの画像のフラッシュ設定( |
meta. | null | stringこの画像の焦点距離(例: |
meta. | number | nullアニメーション GIF ファイルに含まれるフレーム数です。その他のすべての画像形式では、デフォルトで |
meta. | number | null動画のフレームレート( |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | boolean完全に不透明なアルファチャンネル付き画像も含め、元の画像にアルファチャンネルがあるかどうかを示します。thumbhash とともに返され、この項目がない場合は不明を意味します。 |
meta. | boolean | null |
meta. | boolean | null |
meta. | boolean画像にクリッピングパスが含まれる場合は |
meta. | boolean | null画像に透明な領域があるかどうか。透明部分の検査をリクエストするには、 |
meta. | number | nullメディアの高さ(ピクセル単位)。 |
meta. | object | nullTransloadit のインターレース検出器による診断情報です。このオブジェクトには
|
meta. | boolean | null動画がインターレース走査を使用していると見られるかどうかを示します。インターレース動画の場合は |
meta. | number | nullこの画像の ISO 値(例: |
meta. | string | number | Array<string | number | boolean> | nullファイルのメタデータから抽出されたキーワード。値は文字列、有限の数値、または要素が文字列、有限の数値、真偽値のいずれかである配列です。たとえば、 |
meta. | number | nullメディアが記録された場所の緯度(例: |
meta. | number | nullこの画像の明るさの値です(例: |
meta. | number | null |
meta. | string | number | nullこの画像が撮影された場所で、通常は 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | number | nullメディアが記録された地点の経度です。例: |
meta. | null | string |
meta. | number | null音声ファイルの平均音量です。測定を要求するには、 |
meta. | null | stringこの画像の測光モード( |
meta. | string | number | Array<string | number> | null |
meta. | number | null |
meta. | number | null |
meta. | number | null |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | number | null |
meta. | number | nullページ数。Office ドキュメントの場合、この値はファイルに保存されているプロパティから取得されます。 |
meta. | null | string |
meta. | number | null |
meta. | null | string |
meta. | null | string |
meta. | string |
meta. | null | string |
meta. | string |
meta. | Array<string> | Array<object> |
meta. | number | null |
meta. | null | string |
meta. | null | string |
meta. | string | number | boolean | nullファイルから抽出された権利に関するメタデータ。元のスカラー値は保持されます。文字列メソッドを使用する前に型を確認してください。 次のいずれかのスキーマが適用される場合があります: string | number | booleanstring | number | booleannull |
meta. | number | null |
meta. | boolean | null動画の形式がシークをサポートしているかどうか(例: |
meta. | number | null |
meta. | number | string | nullこの画像のシャッタースピード(例: 次のいずれかのスキーマが適用される場合があります: number | stringnumber | stringnull |
meta. | null | string |
meta. | string | number | nullこの画像が撮影された州(例: 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string |
meta. | string |
meta. | string |
meta. | string |
meta. | object | null |
meta. | number | null |
meta. | number | null |
meta. | number | null現在のサムネイルのインデックスです(0 から始まります)。このキーは、🤖/video/thumbs の結果にのみ含まれます。 |
meta. | number | string | null現在のサムネイルのオフセット(秒単位)。このキーは、🤖/video/thumbs の結果にのみ含まれます。
|
meta. | stringEXIF の向き情報を適用した画像の Base64 エンコードされた ThumbHash。生成元の Step で output_meta.thumbhash をリクエストしてください。リクエストされていない場合、未対応の場合、40 メガピクセルを超える場合、または抽出に失敗した場合は省略されます。元の画像が非公開の場合、ハッシュを非公開の画像データとして扱ってください。 検証パターン(正規表現)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$ |
meta. | null | string |
meta. | string | number | nullこの画像のタイトル(例: 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | boolean | null |
meta. | string |
meta. | number | null動画の映像ビットレート( |
meta. | null | string動画のビデオコーデック( |
meta. | string | number | nullこの画像のホワイトバランス設定です(例: 次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | number | nullメディアの幅(ピクセル単位)です。表示比率がピクセル比率と異なる動画の場合、これは意図された表示幅です。 |
meta. | number | nullOffice ドキュメントのプロパティに保存されている単語数。 |
meta. | null | string |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
meta. | string | number | null次のいずれかのスキーマが適用される場合があります: string | numberstring | numbernull |
mime必須 | null | stringこのファイルについて判定された MIME タイプ。 |
name必須 | null | stringファイルの名前です。ファイルが処理によって別の形式に変換される場合、Transloadit はこのフィールドで使用する拡張子を変更します。 |
original_basename | null | string |
original_id必須 | string | Array<null | string>このファイルの生成元となった元のアップロードファイルの一意の ID です。これは、いくつかの Steps の処理を経た後に、複数ファイルのアップロードのうち、特定のファイルの生成にどのファイルが使用されたかを判断するのに役立ちます。 次のいずれかのスキーマが適用される場合があります: stringArray<null | string>Array<null | string>配列要素のスキーマnull | string |
original_md5hash | null | string |
original_name | null | string |
original_path | string |
queue | null | string |
queue_time | number |
sha256 | string保存されたバイト列の SHA-256 チェックサム(小文字、利用可能な場合)。 検証パターン(正規表現)^[a-f0-9]{64}$ |
size必須 | numberファイルのサイズ(バイト単位)。 |
ssl_url | null | string |
thumbhash | string利用可能な場合に、この保存済み画像バージョンとともに保持される Base64 エンコード済みの ThumbHash。この画像データは、元の画像と同じアクセス制御で保護してください。 検証パターン(正規表現)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$ |
tus_upload_url | null | string |
type必須 | null | stringファイルを表す抽象的なカテゴリです。既知の値は |
url必須 | null | stringファイルをダウンロードできる URL、または配信用 URL が利用できない場合は |
user_meta | object追加プロパティのスキーマ任意の値 |
version_id | stringストレージが結果を確定した後に返される不変のバージョン ID です。保持およびアクセスに関する条件の範囲内で、移動や上書きの後も同じバイト列を保持するには、 検証パターン(正規表現)^[A-Za-z0-9_-]{21}[AQgw]$ |
workspace | string (最小長: 1)この保存済みの結果を所有する Workspace のスラッグです。この結果をインポートまたは管理する際は、この Workspace に対して認証してください。 |
assembly_upload_meta_data_extracted
data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。
assembly_uploading_finished
data フィールドにこの名前をプレーンテキストとして含み、event フィールドを持たないメッセージ。
HTTP 404, 503
レスポンスボディはありません。
エラーレスポンス
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
assembly_id | string |
error | string (最小長: 1) |
http_code | number | string
|
message | string人が読んで理解できる形式のエラー説明です。文言は変わる場合があるため、特定の失敗を処理する際は |
reason | null | string | number | boolean | Array<任意の値> | object次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |
レスポンス形式の詳細については、Mozilla のサーバー送信イベントに関するドキュメントを参照してください。