MediaClient

メディア操作向けの Client この Client は、X API のメディアエンドポイントとやり取りするためのメソッドを提供します。メディア関連のすべての操作について、認証、リクエストのフォーマット、レスポンスの解析を行います。 zeUpload](/xdks/typescript/reference/classes/MediaClient#finalizeupload)

コンストラクタ

constructor

• new MediaClient(client): MediaClient 新しい MediaClient インスタンスを生成します

パラメーター

Name	Type	Description
`client`	`Client`	メインの X API の Client インスタンス

戻り値

MediaClient

定義元

media/client.ts:250

メソッド

getByKey

▸ getByKey(mediaKey, options): Promise<Response> メディアキーを指定してメディアを取得します
指定したメディアキーに対応するメディアファイルの詳細を取得します。

パラメーター

名前	型	説明
`mediaKey`	`string`	単一の Media Key。
`options`	`GetByKeyOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンス (requestOptions.raw が true の場合は生の Response) に解決される Promise

定義場所

media/client.ts:295 ▸ getByKey(mediaKey, options?): Promise<Get2MediaMediaKeyResponse>

パラメータ

名前	Type
`mediaKey`	`string`
`options?`	`GetByKeyOptions`

戻り値

Promise<Get2MediaMediaKeyResponse>

定義元

media/client.ts:308

getUploadStatus

▸ getUploadStatus(mediaId, options): Promise<Response> メディアアップロードのステータスを取得します
指定された ID のメディアアップロードのステータスを取得します。

パラメーター

Name	Type	Description
`mediaId`	`string`	指定されたメディアアップロードステータスの対象メディアのID。
`options`	`GetUploadStatusOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンス、または requestOptions.raw が true の場合は生の Response に解決される Promise

定義箇所

media/client.ts:442 ▸ getUploadStatus(mediaId, options?): Promise<MediaUploadResponse>

パラメータ

名前	型
`mediaId`	`string`
`options?`	`GetUploadStatusOptions`

戻り値

Promise<MediaUploadResponse>

定義場所

media/client.ts:455

upload

▸ upload(options): Promise<Response> メディアのアップロードポストまたはその他のコンテンツで使用するためのメディアファイルをアップロードします。

パラメーター

名前	type
`options`	`UploadOptions` & { `requestOptions`: { `raw`: `true` } }

戻り値

Promise<Response> API レスポンスを解決結果とする Promise。requestOptions.raw が true の場合は生の Response。

定義場所

media/client.ts:582 ▸ upload(options?): Promise<MediaUploadResponse>

パラメータ

名前	type
`options?`	`UploadOptions`

戻り値

Promise<MediaUploadResponse>

定義元

media/client.ts:591

getAnalytics

▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options): Promise<Response> メディアのアナリティクスを取得します
メディアに関する分析データを取得します。

パラメーター

Name	Type	Description
`mediaKeys`	`any`[]	メディアキーのカンマ区切りリスト。1 回のリクエストで最大 100 個まで指定できます。
`endTime`	`string`	YYYY-MM-DDTHH:mm:ssZ。時間範囲の終了時刻を表す UTC タイムスタンプ。
`startTime`	`string`	YYYY-MM-DDTHH:mm:ssZ。時間範囲の開始時刻を表す UTC タイムスタンプ。
`granularity`	`string`	検索結果カウントの粒度。
`options`	`GetAnalyticsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Returns

Promise<Response> API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

定義場所

media/client.ts:699 ▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options?): Promise<MediaAnalytics>

パラメータ

名前	Type
`mediaKeys`	`any`[]
`endTime`	`string`
`startTime`	`string`
`granularity`	`string`
`options?`	`GetAnalyticsOptions`

戻り値

Promise<MediaAnalytics>

定義場所

media/client.ts:724

appendUpload

▸ appendUpload(id, options): Promise<Response> メディアアップロードの追加
メディアアップロードリクエストにデータを追加します。

パラメータ

Name	Type	Description
`id`	`string`	append 操作を実行する対象のメディアの識別子。
`options`	`AppendUploadOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response オブジェクト

定義元

media/client.ts:918 ▸ appendUpload(id, options?): Promise<MediaUploadAppendResponse>

パラメータ

名前	型
`id`	`string`
`options?`	`AppendUploadOptions`

戻り値

Promise<MediaUploadAppendResponse>

定義場所

media/client.ts:931

getByKeys

▸ getByKeys(mediaKeys, options): Promise<Response> メディアキーでメディアを取得します
指定されたメディアキーに対応するメディアファイルの詳細を取得します。

パラメーター

名前	型	説明
`mediaKeys`	`any`[]	メディアキーのカンマ区切りリスト。1 回のリクエストで最大 100 件まで指定できます。
`options`	`GetByKeysOptions` & { `requestOptions`: { `raw`: `true` } }	-

Returns

Promise<Response> API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

定義元

media/client.ts:1039 ▸ getByKeys(mediaKeys, options?): Promise<Get2MediaResponse>

パラメーター

名前	type
`mediaKeys`	`any`[]
`options?`	`GetByKeysOptions`

戻り値

Promise<Get2MediaResponse>

定義元

media/client.ts:1052

createMetadata

▸ createMetadata(options): Promise<Response> メディアのメタデータを作成します
メディアファイル用のメタデータを作成します。

パラメーター

名前	型
`options`	`CreateMetadataOptions` & { `requestOptions`: { `raw`: `true` } }

戻り値

Promise<Response> API レスポンス (または requestOptions.raw が true の場合は生の Response) を返す Promise

定義元

media/client.ts:1191 ▸ createMetadata(options?): Promise<MetadataCreateResponse>

パラメーター

名前	型
`options?`	`CreateMetadataOptions`

戻り値

Promise<MetadataCreateResponse>

定義場所

media/client.ts:1200

finalizeUpload

▸ finalizeUpload(id, options): Promise<Response> メディアアップロードを完了する
メディアアップロードリクエストを完了します。

パラメーター

Name	Type	Description
`id`	`string`	最終処理の対象となるメディアの id。
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

Promise<Response> API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response

定義場所

media/client.ts:1296 ▸ finalizeUpload(id): Promise<MediaUploadResponse>

パラメータ

名前	型
`id`	`string`

戻り値

Promise<MediaUploadResponse>

定義元

media/client.ts:1309

initializeUpload

▸ initializeUpload(options): Promise<Response> メディアのアップロードを初期化しますメディアアップロードを初期化します。

パラメーター

名前	type
`options`	`InitializeUploadOptions` & { `requestOptions`: { `raw`: `true` } }

戻り値

Promise<Response> API レスポンス (requestOptions.raw が true の場合は生の Response オブジェクト) で解決される Promise

定義元

media/client.ts:1396 ▸ initializeUpload(options?): Promise<MediaUploadResponse>

パラメーター

名前	type
`options?`	`InitializeUploadOptions`

戻り値

Promise<MediaUploadResponse>

定義場所

media/client.ts:1405

createSubtitles

▸ createSubtitles(options): Promise<Response> メディアの字幕を作成特定のメディアファイルに対して字幕を作成します。

パラメーター

名前	type
`options`	`CreateSubtitlesOptions` & { `requestOptions`: { `raw`: `true` } }

戻り値

Promise<Response> API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

定義元

media/client.ts:1497 ▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

パラメーター

名前	type
`options?`	`CreateSubtitlesOptions`

戻り値

Promise<SubtitlesCreateResponse>

定義場所

media/client.ts:1506

deleteSubtitles

▸ deleteSubtitles(options): Promise<Response> メディアの字幕を削除します
特定のメディアファイルの字幕を削除します。

パラメーター

名前	Type
`options`	`DeleteSubtitlesOptions` & { `requestOptions`: { `raw`: `true` } }

戻り値

Promise<Response> API レスポンス (requestOptions.raw が true の場合は生の Response) を解決する Promise

定義場所

media/client.ts:1598 ▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

パラメーター

名前	type
`options?`	`DeleteSubtitlesOptions`

戻り値

Promise<SubtitlesDeleteResponse>

定義元

media/client.ts:1607