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

共通

バージョン別機能範囲のご案内
  • 国家およびタイムゾーン一覧取得: v3 で新規追加された機能で、v1 および v2 ではサポートされません。
  • 言語一覧取得: すべてのバージョンで言語一覧取得をサポートします。
  • 共通認証: すべてのバージョンの API はクエリストリングパラメーター(?access_token=)による共通認証方式を使用します。エラー判定基準に関する共通仕様は、API v3 移行ガイドの コア変更点 セクションをご参照ください。
共通 API v3 リファレンスへ移動

国家一覧取得​

  • 既存 (v1/v2): 非対応
  • 変更後 (v3): GET /countries
リクエストおよびレスポンス構造の詳細

リクエストボディおよびパラメーター​

渡す個別のパラメーター（Path/Query/Body）が存在しない、単純な照会エンドポイントです。

レスポンスフィールド仕様​

フィールドデータ型説明
idInteger国家固有 ID
english_nameString国家名称（英語表記）
native_nameString国家名称（現地語表記）
code_2charStringISO 標準 2 桁国コード（例: jp）
code_3charStringISO 標準 3 桁国コード（例: jpn）
short_nameString国家略式名称

レスポンス構造仕様​

{
  "data": [
    {
      "id": 109,
      "english_name": "Japan",
      "native_name": "日本国",
      "code_2char": "jp",
      "code_3char": "jpn",
      "short_name": ""
    }
  ]
}

言語一覧取得​

  • 既存 (v1): GET /media/subtitle/languages
  • 既存 (v2): GET /vod/languages
  • 変更後 (v3): GET /languages

タイムゾーン一覧取得​

  • 既存 (v1/v2): 非対応
  • 変更後 (v3): GET /timezones
リクエストおよびレスポンス構造の詳細

リクエストボディおよびパラメーター​

渡す個別のパラメーター（Path/Query/Body）が存在しない、単純な照会エンドポイントです。

レスポンス構造仕様​

大陸別にグループ化された 2 段階のネスト JSON オブジェクト構造でデータを返します。

{
  "data": [
    {
      "name": "Asia",
      "timezones": [
        {
          "key": "Asia/Tokyo",
          "value": "Tokyo, UTC+09:00"
        }
      ]
    }
  ]
}