メインコンテンツへスキップ

​
サブモジュール

​
モジュールの内容

このモジュールは X API のメディアエンドポイントへのアクセスを提供し、 すべてのメディア関連機能への主なエントリーポイントとなります。

​
class xdk.media.MediaClient

メディア操作を行う Client

​
パラメータ

​
path.client
Client

​
__init__

​
パラメータ

​
path.client
Client

​
append_upload

メディアアップロードの追記 メディアアップロードリクエストにデータを追記します。

​
パラメーター

​
path.id
Any
append 操作を実行する対象メディアの識別子。
​
body.body
AppendUploadRequest
リクエストボディ

​
create_metadata

メディアのメタデータを作成 メディアファイルのメタデータを作成します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateMetadataResponse

​
パラメータ

​
body.body
CreateMetadataRequest

​
create_subtitles

Media の字幕を作成します。 特定の Media ファイルの字幕を作成します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateSubtitlesResponse

​
パラメータ

​
body.body
CreateSubtitlesRequest

​
delete_subtitles

メディアの字幕を削除 特定のメディアファイルの字幕を削除します。 body: リクエストボディ :returns: レスポンスデータ :rtype: DeleteSubtitlesResponse

​
パラメータ

​
body.body
DeleteSubtitlesRequest

​
finalize_upload

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

​
パラメータ

​
path.id
Any
finalize_upload で確定する対象メディアの media id。

​
戻り値

FinalizeUploadResponse - レスポンスデータ

​
get_analytics

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

​
Parameters

​
path.media_keys
List
カンマ区切りの Media Key のリスト。1 回のリクエストで最大 100 個まで指定できます。
​
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ。時間範囲の終了時刻を表す UTC タイムスタンプ。
​
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ。時間範囲の開始時刻を表す UTC タイムスタンプ。
​
path.granularity
str
検索カウント結果の集計粒度。
​
path.media_analytics_fields
List or None
デフォルト:"None"
表示する MediaAnalytics フィールドをカンマ区切りで指定するリスト。

​
戻り値

GetAnalyticsResponse - レスポンスデータ

​
get_by_key

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

​
パラメーター

​
path.media_key
Any
1 つの Media Key。
​
path.media_fields
List or None
デフォルト:"None"
表示対象の Media フィールドをカンマ区切りで指定したリスト。

​
戻り値

GetByKeyResponse - レスポンスデータ

​
get_by_keys

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

​
パラメーター

​
path.media_keys
List
カンマ区切りのメディアキーのリストです。1 回のリクエストで最大 100 個まで指定できます。
​
path.media_fields
List or None
デフォルト:"None"
表示するメディアフィールドのカンマ区切りリストです。

​
戻り値

GetByKeysResponse - レスポンス データ

​
get_upload_status

メディアアップロードのステータス取得 id でメディアアップロードのステータスを取得します。

​
パラメーター

​
path.media_id
Any
取得対象のメディアアップロードステータスに対応するメディアID。
​
path.command
str or None
デフォルト:"None"
メディアアップロードリクエストに指定するコマンド。

​
戻り値

GetUploadStatusResponse - レスポンスデータ

​
initialize_upload

メディアのアップロードを初期化します メディアアップロードを初期化します。 body: リクエストボディ :returns: レスポンスデータ :rtype: InitializeUploadResponse

​
パラメータ

​
body.body
InitializeUploadRequest

​
upload

メディアをアップロードします ポストやその他のコンテンツで使用するためのメディアファイルをアップロードします。 body: リクエストボディ :returns: レスポンスデータ :rtype: UploadResponse

​
パラメータ

​
body.body
UploadRequest