playback

에피소드 재생 정보 조회

GET

https://odkmedia.io

/odx/api/v3/playback/{id}/

에피소드 재생 정보 조회 › path Parameters

id

integer · required

A unique integer value identifying this Episode.

에피소드 재생 정보 조회 › query Parameters

debug

string

If value is "on", debug is included in response.

adid

string

광고 식별자(Advertising ID, IDFA/AAID 등).

did

string

ODK 클라이언트가 보내는 Device ID. 없으면 헤더의 did 값을, 그것도 없으면 서버가 생성한 기본값을 쓴다.

dnt

string · enum

Do Not Track preference. Values: "0" (not enabled) or "1" (enabled). This is a user/browser preference and is independent of both the CMP consent choice and is_lat.

Enum values:

gdpr

string · enum

GDPR applicability flag as reported by the CMP. Values: "0" (does not apply) or "1" (applies). Omit the parameter when the CMP does not report it; the backend never assumes a value.

Enum values:

gdpr_consent

string

IAB TCF consent string, required by buyers when gdpr=1. Forwarded unmodified.

gpp

string

IAB Global Privacy Platform (GPP) consent string as reported by the CMP. Forwarded to ad tags unmodified. Omit the parameter when the CMP has not resolved.

gpp_sid

string

GPP section ID(s) as reported by the CMP (e.g. "7" for usnat, "8" for usca). Send whatever the CMP reports. The value is forwarded unmodified and is never validated or defaulted, because it differs per platform and jurisdiction.

is_lat

string · enum

Limit Ad Tracking (LAT). 사용자가 광고 추적을 거부했는지 여부. "0"(허용, 기본값) 또는 "1"(거부).

Enum values:

lmt

string · enum

Limit Ad Tracking flag as reported by the device (OpenRTB device.lmt). Values: "0" (allow tracking) or "1" (limit tracking). Equivalent to is_lat.

Enum values:

us_privacy

string

CCPA US Privacy string as reported by the CMP (e.g. "1YNN", "1YYN"). Send the real consent value. Omit the parameter when no consent signal is available.

에피소드 재생 정보 조회 › Headers

Service-Name

string · enum · required

요청을 처리할 서비스. v3 에서 유효한 값은 odk, odc 뿐이다 (content.constants.Service; v4 는 다른 값 체계를 쓴다).

Enum values:

odk

odc

Example: odk

Accept-Language

string

"zh-Hans", "zh-Hant" is deprecated. Supported values: ko, en, es, zh-Hans, zh-Hant, pt, vi (default: en) — see LANGUAGES in app/settings/base.py.

Example: ko-KR,ko;q=0.9,en;q=0.8

IP-Version

string

영상 스트림 CDN 도메인 선택에 쓰인다. 값이 ipv4 면 IPv4 전용 CDN 도메인을 반환하고, 그 외(생략 포함)에는 기본 도메인을 반환한다.

에피소드 재생 정보 조회 › Responses

200

OdxV3Playback

OdxV3PlaybackEpisode · required

OdxV3PlaybackExternal · required

OdxV3PlaybackProgram · required

age_rating

string · readOnly

bumper

string · readOnly

bumper_duration

string · readOnly

video's bumper duration info

array · readOnly

language codes and settings for subtitles in manifests

array · readOnly

cue_points isn't used in phase 1.

cwl_call_cycle

integer · readOnly

drm

string · readOnly

If Non-drm video, drm: {} in response

duration

integer | null · readOnly

video's duration info (millisecond)

id

integer | null · readOnly

ID of video.api object(Video Asset)

is_chromecast_able

boolean · readOnly

Whether the video can be casted to chromecast

is_live_streaming

boolean · readOnly

에피소드가 라이브 스트리밍 타입인지 여부를 반환

array · readOnly

매니페스트를 반환하되, 라이브 스트리밍 에피소드는 별도 처리

mediahub_content_id

integer | null · readOnly

PEV2 mci 조인 키 — MediahubContentEpisodeMapper(OneToOne) 없으면 null (BEE-5140).

클라이언트는 이 값을 PEV2 playlist 이벤트의 mci 로 에코한다 (st=vod 필수, spec v2.1.4). null 이면 클라이언트는 mci 를 생략 전송한다 — 잘못된 값 대체 금지 (KA2-754 #1). view 가 select_related('mediahub_episode_mapper') 로 동반 로드한다.

source

string · readOnly

비디오 소스를 반환하되, 라이브 스트리밍인 경우 'inhouse' 반환

array · readOnly

비디오 소스를 반환하되, 라이브 스트리밍 에피소드는 별도 처리

storyboards_url

string · readOnly

If there's no file info for storyboards, this field returns null.

array · readOnly

If asset_type is in inhouse, relay, and mediahold (the asset stored in s3), text_tracks is required.

GET/odx/api/v3/playback/{id}/

curl https://odkmedia.io/odx/api/v3/playback/:id \
  --header 'Service-Name: odk' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "age_rating": "age_rating",
  "bumper": "bumper",
  "bumper_duration": "bumper_duration",
  "cc_languages": [
    {}
  ],
  "cue_points": [
    {}
  ],
  "cwl_call_cycle": 0,
  "drm": "drm",
  "duration": 0,
  "episode": {
    "id": 0,
    "images": {
      "thumbnail": "https://www.example.com/path/to/resource"
    },
    "is_kocowa": "is_kocowa",
    "kind": "series",
    "next_episode": {
      "key": {}
    },
    "number": 0,
    "part": 0,
    "program": {
      "id": 0,
      "images": {
        "poster": "https://www.example.com/path/to/resource",
        "poster_landscape": "https://www.example.com/path/to/resource",
        "poster_portrait": "https://www.example.com/path/to/resource"
      },
      "slug": "slug",
      "title": "title"
    },
    "release_date": "2024-08-25",
    "sales_type": "sales_type",
    "slug": "slug",
    "title": "title"
  },
  "external": {
    "kcp": "kcp"
  },
  "id": 0,
  "is_chromecast_able": true,
  "is_live_streaming": true,
  "manifests": [
    {}
  ],
  "mediahub_content_id": 0,
  "program": {
    "categories": [
      {
        "id": 0,
        "slug": "slug",
        "title": "title"
      }
    ],
    "genres": [
      {
        "id": 0,
        "slug": "slug",
        "title": "title"
      }
    ],
    "id": 0,
    "images": {
      "poster": "https://www.example.com/path/to/resource",
      "poster_landscape": "https://www.example.com/path/to/resource",
      "poster_portrait": "https://www.example.com/path/to/resource"
    },
    "is_favorite": "is_favorite",
    "provider": {
      "name": "name",
      "slug": "slug"
    },
    "slug": "slug",
    "synopsis": "synopsis",
    "title": "title"
  },
  "source": "source",
  "sources": [
    {}
  ],
  "storyboards_url": "storyboards_url",
  "text_tracks": [
    {}
  ]
}

json

application/json

playback-log profile

에피소드 재생 정보 조회

GET

https://odkmedia.io

/odx/api/v3/playback/{id}/

에피소드 재생 정보 조회 › path Parameters

id

integer · required

A unique integer value identifying this Episode.

에피소드 재생 정보 조회 › query Parameters

debug

string

If value is "on", debug is included in response.

adid

string

광고 식별자(Advertising ID, IDFA/AAID 등).

did

string

ODK 클라이언트가 보내는 Device ID. 없으면 헤더의 did 값을, 그것도 없으면 서버가 생성한 기본값을 쓴다.

dnt

string · enum

Do Not Track preference. Values: "0" (not enabled) or "1" (enabled). This is a user/browser preference and is independent of both the CMP consent choice and is_lat.

Enum values:

gdpr

string · enum

GDPR applicability flag as reported by the CMP. Values: "0" (does not apply) or "1" (applies). Omit the parameter when the CMP does not report it; the backend never assumes a value.

Enum values:

gdpr_consent

string

IAB TCF consent string, required by buyers when gdpr=1. Forwarded unmodified.

gpp

string

IAB Global Privacy Platform (GPP) consent string as reported by the CMP. Forwarded to ad tags unmodified. Omit the parameter when the CMP has not resolved.

gpp_sid

string

is_lat

string · enum

Limit Ad Tracking (LAT). 사용자가 광고 추적을 거부했는지 여부. "0"(허용, 기본값) 또는 "1"(거부).

Enum values:

lmt

string · enum

Limit Ad Tracking flag as reported by the device (OpenRTB device.lmt). Values: "0" (allow tracking) or "1" (limit tracking). Equivalent to is_lat.

Enum values:

us_privacy

string

CCPA US Privacy string as reported by the CMP (e.g. "1YNN", "1YYN"). Send the real consent value. Omit the parameter when no consent signal is available.

에피소드 재생 정보 조회 › Headers

Service-Name

string · enum · required

요청을 처리할 서비스. v3 에서 유효한 값은 odk, odc 뿐이다 (content.constants.Service; v4 는 다른 값 체계를 쓴다).

Enum values:

odk

odc

Example: odk

Accept-Language

string

"zh-Hans", "zh-Hant" is deprecated. Supported values: ko, en, es, zh-Hans, zh-Hant, pt, vi (default: en) — see LANGUAGES in app/settings/base.py.

Example: ko-KR,ko;q=0.9,en;q=0.8

IP-Version

string

영상 스트림 CDN 도메인 선택에 쓰인다. 값이 ipv4 면 IPv4 전용 CDN 도메인을 반환하고, 그 외(생략 포함)에는 기본 도메인을 반환한다.

에피소드 재생 정보 조회 › Responses

200

OdxV3Playback

OdxV3PlaybackEpisode · required

OdxV3PlaybackExternal · required

OdxV3PlaybackProgram · required

age_rating

string · readOnly

bumper

string · readOnly

bumper_duration

string · readOnly

video's bumper duration info

array · readOnly

language codes and settings for subtitles in manifests

array · readOnly

cue_points isn't used in phase 1.

cwl_call_cycle

integer · readOnly

drm

string · readOnly

If Non-drm video, drm: {} in response

duration

integer | null · readOnly

video's duration info (millisecond)

id

integer | null · readOnly

ID of video.api object(Video Asset)

is_chromecast_able

boolean · readOnly

Whether the video can be casted to chromecast

is_live_streaming

boolean · readOnly

에피소드가 라이브 스트리밍 타입인지 여부를 반환

array · readOnly

매니페스트를 반환하되, 라이브 스트리밍 에피소드는 별도 처리

mediahub_content_id

integer | null · readOnly

PEV2 mci 조인 키 — MediahubContentEpisodeMapper(OneToOne) 없으면 null (BEE-5140).

source

string · readOnly

비디오 소스를 반환하되, 라이브 스트리밍인 경우 'inhouse' 반환

array · readOnly

비디오 소스를 반환하되, 라이브 스트리밍 에피소드는 별도 처리

storyboards_url

string · readOnly

If there's no file info for storyboards, this field returns null.

array · readOnly

If asset_type is in inhouse, relay, and mediahold (the asset stored in s3), text_tracks is required.