メインコンテンツまでスキップ

メディアコンテンツキー管理

バージョン別機能範囲のご案内
  • コンテンツキー情報の照会および割り当て：v2 および v3 でのみサポートされます。
  • コンテンツキーの有効性検証：v1 および v3 でのみサポートされます。
  • コンテンツキーの交換：v1 および v2 でのみサポートされます。
  • 共通認証：すべてのバージョンの API は、クエリ文字列パラメーター（?access_token=）による共通認証方式を使用します。エラー判定基準に関する共通仕様については、API v3 移行ガイドのコア変更点セクションを参照してください。
メディアコンテンツキー管理 API v3 リファレンスへ

メディアコンテンツキー情報の照会​

  • 既存（v2）：GET /vod/media-content-keys/{media_content_key}
  • 変更（v3）：GET /media-content-keys/{media_content_key}
変更事項
  • v1 非対応：該当エンドポイントは v1 ではサポートされていません。
  • レスポンスフィールド名の変更：既存 v2 のkeyフィールドが v3 でmedia_content_keyに変更されました。
  • レスポンス構造の簡素化：既存 v2 ではmedia_contentおよびmedia_channelの全データを階層構造でネストして返却していましたが、v3 では帯域幅の最小化のため、upload_file_keyおよびchannel_keyをはじめとする 1 次元のフラットなデータフィールド構造で返却します。
レスポンス構造の詳細

レスポンス構造対照​

v2​

{
  "data": {
    "id": 12,
    "key": "string",
    "media_content": {
      "id": 34,
      "upload_file_key": "string",
      "title": "string"
    },
    "media_channel": {
      "id": 56,
      "channel_key": "string",
      "name": "string"
    }
  }
}

v3​

{
  "data": {
    "id": 12,
    "media_content_key": "string",
    "upload_file_key": "string",
    "channel_key": "string",
    "status": true,
    "created_at": "string",
    "updated_at": "string"
  }
}

メディアコンテンツキーの有効性検証​

  • 既存（v1）：POST /media/media_content_key/validate
  • 変更（v3）：GET /media-content-keys/validate
変更事項
  • HTTP メソッドの変更：HTTP メソッドがPOSTからGETに変更されました。
  • パラメーター送信仕様の変更：既存 v1 ではリクエストボディにカンマ（,）区切りのテキスト構造で渡していましたが、v3 ではクエリ文字列の配列構造（media_content_keys[]=A&media_content_keys[]=B）形式でリクエストを記述する必要があります。
リクエストパラメーター送信仕様およびレスポンス構造の詳細

リクエストパラメーター送信仕様対照​

区分v1 仕様v3 仕様
送信領域リクエストボディクエリ文字列
パラメーター名media_content_keysmedia_content_keys[]
値の構造String（例："mck_key_A,mck_key_B"）Array（例：media_content_keys[]=mck_key_A&media_content_keys[]=mck_key_B）

レスポンス構造対照​

リクエストしたキー自体がレスポンスデータのフィールド名として宣言される動的データ拡張パターンは、同様に維持されます。

v1​

{
  "error": 0,
  "result": {
    "mck_key_A": true,
    "mck_key_B": false
  }
}

v3​

{
  "data": {
    "mck_key_A": true,
    "mck_key_B": false
  }
}

メディアコンテンツキーの割り当て​

  • 既存（v2）：PUT /vod/media-contents/{upload_file_key}/assign-media-content-key
  • 変更（v3）：PUT /media-contents/{upload_file_key}/media-content-keys/{media_content_key}/assign
変更事項
  • v1 非対応：該当エンドポイントは v1 ではサポートされていません。
  • パラメーター送信経路の変更：既存 v2 ではコンテンツキー（media_content_key）項目をリクエストボディに含めて渡していましたが、v3 移行ガイドライン仕様では対象識別子がすべて URL パス（Path）構造に統合されました。
  • レスポンスデータフォーマットの高度化：v3 では、規格化されたステータスコードを含むデータ構造を返却します。
リクエストパラメーターおよびレスポンス構造の詳細

リクエストパラメーター構成およびパス対照​

区分v2 仕様v3 仕様
upload_file_keyURL パスパラメーターURL パスパラメーター（前方に配置）
media_content_keyリクエストボディURL パスパラメーター（後方に配置）

レスポンス構造仕様​

{
  "data": ApiVodMediaContent object,
  "status": "ok"
}

メディアコンテンツキーの相互交換​

  • 既存（v1）：POST /media/channel/change_media_content_key/{media_content_key}
  • 既存（v2）：PUT /vod/media-content-keys/{media_content_key}/exchange-key
  • 変更（v3）：非対応
API 正式廃止のご案内

v1 および v2 で提供されていたコンテンツキー交換機能は、v3 仕様において完全に廃止されました。