MediaClient

メディア操作用クライアント

このクライアントは、X API のメディアエンドポイントとやり取りするためのメソッドを提供します。認証、リクエストの整形、メディア関連のすべての操作に対するレスポンスの解析を処理します。

• initializeUpload
• createSubtitles
• deleteSubtitles
• createMetadata
• getByKey
• getByKeys
• finalizeUpload
• getUploadStatus
• upload
• appendUpload

​

コンストラクタ

​

constructor

• new MediaClient(client): MediaClient

新しいメディアクライアントのインスタンスを作成します

​

パラメータ

名前	型	説明
client	Client	X API のメインクライアントインスタンス

​

返り値

MediaClient

​

定義元

media/client.ts:181

​

メソッド

​

getAnalytics

▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options?): Promise<MediaAnalytics>

メディアのアナリティクスを取得 メディアに関するアナリティクスデータを取得します。

​

パラメーター

名前	型	説明
mediaKeys	any[]	メディアキーのカンマ区切りリスト。1 回のリクエストで最大 100 まで指定可能。
endTime	string	YYYY-MM-DDTHH:mm:ssZ。時間範囲の終了時刻を表す UTC タイムスタンプ。
startTime	string	YYYY-MM-DDTHH:mm:ssZ。時間範囲の開始時刻を表す UTC タイムスタンプ。
granularity	string	検索件数結果の粒度。
options	GetAnalyticsOptions	-

​

戻り値

Promise<MediaAnalytics>

API レスポンスで解決される Promise

​

定義元

media/client.ts:210

---

​

initializeUpload

▸ initializeUpload(options?): Promise<MediaUploadResponse>

メディアアップロードの開始 メディアのアップロード処理を開始します。

​

パラメータ

名称	型
options	InitializeUploadOptions

​

返り値

Promise<MediaUploadResponse>

API レスポンスで解決される Promise

​

定義箇所

media/client.ts:273

---

​

createSubtitles

▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

メディアの字幕を作成 特定のメディアファイルに対して字幕を作成します。

​

パラメータ

名称	型
options	CreateSubtitlesOptions

​

返り値

Promise<SubtitlesCreateResponse>

API レスポンスに解決される Promise

​

定義場所

media/client.ts:314

---

​

deleteSubtitles

▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

メディアの字幕を削除 特定のメディアファイルの字幕を削除します。

​

パラメータ

名前	型
options	DeleteSubtitlesOptions

​

戻り値

Promise<SubtitlesDeleteResponse>

API レスポンスで解決される Promise

​

定義箇所

media/client.ts:355

---

​

createMetadata

▸ createMetadata(options?): Promise<MetadataCreateResponse>

メディアのメタデータを作成 メディアファイルのメタデータを作成します。

​

パラメータ

名前	型
options	CreateMetadataOptions

​

返り値

Promise<MetadataCreateResponse>

API レスポンスに解決される Promise

​

定義場所

media/client.ts:396

---

​

getByKey

▸ getByKey(mediaKey, options?): Promise<Get2MediaMediaKeyResponse>

メディアキーでメディアを取得 指定したメディアキーを使って、対象のメディアファイルの詳細を取得します。

​

パラメータ

名前	型	説明
mediaKey	string	単一のメディアキー。
options	GetByKeyOptions	-

​

戻り値

Promise<Get2MediaMediaKeyResponse>

API レスポンスで解決される Promise

​

定義箇所

media/client.ts:441

---

​

getByKeys

▸ getByKeys(mediaKeys, options?): Promise<Get2MediaResponse>

メディアキーでメディアを取得 メディアキーを指定してメディアファイルの詳細を取得します。

​

パラメータ

名前	型	説明
mediaKeys	any[]	Media Key のカンマ区切りリスト。1 回のリクエストにつき最大 100 件まで指定可能。
options	GetByKeysOptions	-

​

戻り値

Promise<Get2MediaResponse>

API レスポンスで解決される Promise

​

定義箇所

media/client.ts:491

---

​

finalizeUpload

▸ finalizeUpload(id): Promise<MediaUploadResponse>

メディアアップロードの完了 メディアのアップロード要求を確定します。

​

パラメータ

名前	型	説明
id	string	ファイナライズ対象のメディアの media id。

​

戻り値

Promise<MediaUploadResponse>

API レスポンスで解決される Promise

​

定義場所

media/client.ts:543

---

​

getUploadStatus

▸ getUploadStatus(mediaId, options?): Promise<MediaUploadResponse>

メディアのアップロードステータスを取得 ID によるメディアアップロードのステータスを取得します。

​

パラメーター

名前	型	説明
mediaId	any	指定したメディアのアップロードステータスを取得するためのメディア id。
options	GetUploadStatusOptions	-

​

返り値

Promise<MediaUploadResponse>

API レスポンスを返す Promise

​

定義場所

media/client.ts:581

---

​

upload

▸ upload(options?): Promise<MediaUploadResponse>

メディアをアップロード Post やその他のコンテンツで使用するメディアファイルをアップロードします。

​

パラメータ

名前	型
options	UploadOptions

​

返り値

Promise<MediaUploadResponse>

API レスポンスを返す Promise

​

定義箇所

media/client.ts:629

---

​

appendUpload

▸ appendUpload(id, options?): Promise<MediaUploadAppendResponse>

メディアアップロードの追補 メディアアップロード要求にdataを追記します。

​

パラメータ

名前	型	説明
id	string	追加操作を行う対象メディアのメディア識別子。
options	AppendUploadOptions	-

​

戻り値

Promise<MediaUploadAppendResponse>

API レスポンスで解決される Promise

​

定義箇所

media/client.ts:672