> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MediaClient

メディア操作向けの Client

この Client は、X API のメディアエンドポイントとやり取りするためのメソッドを提供します。メディア関連のすべての操作について、認証、リクエストのフォーマット、レスポンスの解析を行います。

zeUpload]\(/xdks/typescript/reference/classes/MediaClient#finalizeupload)

* [initializeUpload](/ja/xdks/typescript/reference/classes/MediaClient#initializeupload)
* [createSubtitles](/ja/xdks/typescript/reference/classes/MediaClient#createsubtitles)
* [deleteSubtitles](/ja/xdks/typescript/reference/classes/MediaClient#deletesubtitles)

<div id="constructors">
  ## コンストラクタ
</div>

<div id="constructor">
  ### constructor
</div>

• **new MediaClient**(`client`): [`MediaClient`](/ja/xdks/typescript/reference/classes/MediaClient)

新しい `MediaClient` インスタンスを生成します

<div id="parameters">
  #### パラメーター
</div>

| Name     | Type                                                     | Description                |
| :------- | :------------------------------------------------------- | :------------------------- |
| `client` | [`Client`](/ja/xdks/typescript/reference/classes/Client) | メインの X API の Client インスタンス |

#### 戻り値

[`MediaClient`](/ja/xdks/typescript/reference/classes/MediaClient)

#### 定義元

[media/client.ts:250](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L250)

<div id="methods">
  ## メソッド
</div>

<div id="getbykey">
  ### getByKey
</div>

▸ **getByKey**(`mediaKey`, `options`): `Promise`\<`Response`>

メディアキーを指定してメディアを取得します\
指定したメディアキーに対応するメディアファイルの詳細を取得します。

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:295](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L295)

▸ **getByKey**(`mediaKey`, `options?`): `Promise`\<[`Get2MediaMediaKeyResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2MediaMediaKeyResponse)>

#### パラメータ

| 名前         | Type              |
| :--------- | :---------------- |
| `mediaKey` | `string`          |
| `options?` | `GetByKeyOptions` |

#### 戻り値

`Promise`\<[`Get2MediaMediaKeyResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2MediaMediaKeyResponse)>

#### 定義元

[media/client.ts:308](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L308)

***

<div id="getuploadstatus">
  ### getUploadStatus
</div>

▸ **getUploadStatus**(`mediaId`, `options`): `Promise`\<`Response`>

メディアアップロードのステータスを取得します\
指定された ID のメディアアップロードのステータスを取得します。

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

#### 定義箇所

[media/client.ts:442](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L442)

▸ **getUploadStatus**(`mediaId`, `options?`): `Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### パラメータ

| 名前         | 型                        |
| :--------- | :----------------------- |
| `mediaId`  | `string`                 |
| `options?` | `GetUploadStatusOptions` |

#### 戻り値

`Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:455](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L455)

***

<div id="upload">
  ### upload
</div>

▸ **upload**(`options`): `Promise`\<`Response`>

メディアのアップロード
ポストまたはその他のコンテンツで使用するためのメディアファイルをアップロードします。

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:582](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L582)

▸ **upload**(`options?`): `Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### パラメータ

| 名前         | type            |
| :--------- | :-------------- |
| `options?` | `UploadOptions` |

#### 戻り値

`Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### 定義元

[media/client.ts:591](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L591)

***

<div id="getanalytics">
  ### getAnalytics
</div>

▸ **getAnalytics**(`mediaKeys`, `endTime`, `startTime`, `granularity`, `options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### パラメーター
</div>

| 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`  }  } | -                                              |

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:699](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L699)

▸ **getAnalytics**(`mediaKeys`, `endTime`, `startTime`, `granularity`, `options?`): `Promise`\<[`MediaAnalytics`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaAnalytics)>

#### パラメータ

| 名前            | Type                  |
| :------------ | :-------------------- |
| `mediaKeys`   | `any`\[]              |
| `endTime`     | `string`              |
| `startTime`   | `string`              |
| `granularity` | `string`              |
| `options?`    | `GetAnalyticsOptions` |

#### 戻り値

`Promise`\<[`MediaAnalytics`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaAnalytics)>

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:724](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L724)

***

<div id="appendupload">
  ### appendUpload
</div>

▸ **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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L918)

▸ **appendUpload**(`id`, `options?`): `Promise`\<[`MediaUploadAppendResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadAppendResponse)>

#### パラメータ

| 名前         | 型                     |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `AppendUploadOptions` |

#### 戻り値

`Promise`\<[`MediaUploadAppendResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadAppendResponse)>

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:931](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L931)

***

<div id="getbykeys">
  ### getByKeys
</div>

▸ **getByKeys**(`mediaKeys`, `options`): `Promise`\<`Response`>

メディアキーでメディアを取得します\
指定されたメディアキーに対応するメディアファイルの詳細を取得します。

<div id="parameters">
  #### パラメーター
</div>

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

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

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

#### 定義元

[media/client.ts:1039](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1039)

▸ **getByKeys**(`mediaKeys`, `options?`): `Promise`\<[`Get2MediaResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2MediaResponse)>

<div id="parameters">
  #### パラメーター
</div>

| 名前          | type               |
| :---------- | :----------------- |
| `mediaKeys` | `any`\[]           |
| `options?`  | `GetByKeysOptions` |

#### 戻り値

`Promise`\<[`Get2MediaResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2MediaResponse)>

#### 定義元

[media/client.ts:1052](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1052)

***

<div id="createmetadata">
  ### createMetadata
</div>

▸ **createMetadata**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

#### 定義元

[media/client.ts:1191](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1191)

▸ **createMetadata**(`options?`): `Promise`\<[`MetadataCreateResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MetadataCreateResponse)>

<div id="parameters">
  #### パラメーター
</div>

| 名前         | 型                       |
| :--------- | :---------------------- |
| `options?` | `CreateMetadataOptions` |

#### 戻り値

`Promise`\<[`MetadataCreateResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MetadataCreateResponse)>

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:1200](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1200)

***

<div id="finalizeupload">
  ### finalizeUpload
</div>

▸ **finalizeUpload**(`id`, `options`): `Promise`\<`Response`>

メディアアップロードを完了する\
メディアアップロードリクエストを完了します。

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:1296](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1296)

▸ **finalizeUpload**(`id`): `Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### パラメータ

| 名前   | 型        |
| :--- | :------- |
| `id` | `string` |

#### 戻り値

`Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### 定義元

[media/client.ts:1309](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1309)

***

<div id="initializeupload">
  ### initializeUpload
</div>

▸ **initializeUpload**(`options`): `Promise`\<`Response`>

メディアのアップロードを初期化します
メディアアップロードを初期化します。

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

#### 定義元

[media/client.ts:1396](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1396)

▸ **initializeUpload**(`options?`): `Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### パラメーター
</div>

| 名前         | type                      |
| :--------- | :------------------------ |
| `options?` | `InitializeUploadOptions` |

#### 戻り値

`Promise`\<[`MediaUploadResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:1405](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1405)

***

<div id="createsubtitles">
  ### createSubtitles
</div>

▸ **createSubtitles**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

#### 定義元

[media/client.ts:1497](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1497)

▸ **createSubtitles**(`options?`): `Promise`\<[`SubtitlesCreateResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.SubtitlesCreateResponse)>

<div id="parameters">
  #### パラメーター
</div>

| 名前         | type                     |
| :--------- | :----------------------- |
| `options?` | `CreateSubtitlesOptions` |

#### 戻り値

`Promise`\<[`SubtitlesCreateResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.SubtitlesCreateResponse)>

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:1506](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1506)

***

<div id="deletesubtitles">
  ### deleteSubtitles
</div>

▸ **deleteSubtitles**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### パラメーター
</div>

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

#### 戻り値

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 定義場所
</div>

[media/client.ts:1598](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1598)

▸ **deleteSubtitles**(`options?`): `Promise`\<[`SubtitlesDeleteResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.SubtitlesDeleteResponse)>

<div id="parameters">
  #### パラメーター
</div>

| 名前         | type                     |
| :--------- | :----------------------- |
| `options?` | `DeleteSubtitlesOptions` |

#### 戻り値

`Promise`\<[`SubtitlesDeleteResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.SubtitlesDeleteResponse)>

#### 定義元

[media/client.ts:1607](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1607)