ODX API v4
string · readOnlybooleaninteger · readOnlyinteger · min: -2147483648 · max: 2147483647string | null · maxLength: 256AmasianCarouselGroupTypeEnum · enum
Schemas
AgeRatingEnum
string · enum
Enum values:
All
PG
R12
R13
R14
R15
R16
R17
All- AllPG- PGR12- 12+R13- 13+R14- 14+R15- 15+R16- 16+R17- 17+R18- 18+R19- 19+NR- NRVN_P- PVN_K- KVN_T13- T13VN_T16- T16VN_T18- T18VN_C- C
AmasianCarouselGroup
carouselenabledidrefresh_timeslugtypebrowser- Browserchannel- Channel
Enum values:
browser
channel
AmasianCarouselGroupApi
캐러셀 그룹 API 정보를 나타내는 시리얼라이저입니다.
object[] · readOnly
List of enabled carousels in this group
Example: [{"id":1,"image_orientation":"landscape","slug":"popular-series","title":"Popular Series"},{"id":2,"image_orientation":"landscape","slug":"new-releases","title":"New Releases"}]
refresh_timeAmasianCarouselGroupRequest
carousel_idsenabledrefresh_timeslugtypebrowser- Browserchannel- Channel
Enum values:
browser
channel
AmasianCarouselGroupTypeEnum
string · enum
Enum values:
browser
channel
browser- Browserchannel- Channel
AmasianCarouselItemApi
캐러셀 아이템 API 정보를 나타내는 시리얼라이저입니다.
readOnly
typeType of carousel item
Enum values:
content
series
season
channel
multi_channel
category
external
Example: series
AmasianCarouselItemApiTypeEnum
string · enum
Enum values:
content
series
season
channel
multi_channel
category
external
AmasianCast
idnameslugthumbnailAmasianCategory
Serializer 용 mixin. `self.service_name` 프로퍼티로 amasian service_name 을 제공한다.
context['request'] 가 없거나 헤더가 없으면 기본값 `amasian` 으로 폴백한다.
slug^[-\w]+$ · requiredtitledescriptioni18n_descriptioni18n_titleidAmasianCategoryNavigation
패턴 B(필드별 i18n_<field> JSONField) 기반 번역 serializer.
modeltrans TranslationField(단일 i18n 컬럼) 를 쓰던 TranslationSerializer 와
동일하게 Accept-Language 로 단일 값을 스왑하지만, 번역 데이터는 필드별로 분리된
i18n_<field> JSONField({lang: value}) 에서 읽고 쓴다.
subclass 는 표시 필드명 -> i18n JSONField 명 매핑을 i18n_fields 로 정의한다.
i18n_fields = {"title": "i18n_title", "description": "i18n_description"}
default_sort_option
orderseo_descriptionseo_keywordsseo_titleslugsort_by_labelsort_optionstitleAmasianCategoryNavigationRequest
패턴 B(필드별 i18n_<field> JSONField) 기반 번역 serializer.
modeltrans TranslationField(단일 i18n 컬럼) 를 쓰던 TranslationSerializer 와
동일하게 Accept-Language 로 단일 값을 스왑하지만, 번역 데이터는 필드별로 분리된
i18n_<field> JSONField({lang: value}) 에서 읽고 쓴다.
subclass 는 표시 필드명 -> i18n JSONField 명 매핑을 i18n_fields 로 정의한다.
i18n_fields = {"title": "i18n_title", "description": "i18n_description"}
orderseo_descriptionseo_keywordsseo_titletitleAmasianCategoryRequest
Serializer 용 mixin. `self.service_name` 프로퍼티로 amasian service_name 을 제공한다.
context['request'] 가 없거나 헤더가 없으면 기본값 `amasian` 으로 폴백한다.
slug^[-\w]+$ · requiredtitledescriptioni18n_descriptioni18n_titleAmasianContentDetail
slug^[-\w]+$ · required
age_rating_infoAmasianCast[] · readOnly
AmasianCategory[] · readOnly
content_typemovie- Movietv-series- TV Seriestrailer- Traileradditional- Additionalclip- Cliplive_streaming- Live Streamingunknown- Unknown
Enum values:
movie
tv-series
trailer
additional
clip
live_streaming
unknown
continue_watching_infoContinue watching information including playback progress and UI status
Example: {"button_text":"Resume","cw_updated":1640995200,"duration":2700,"last_position":1800,"progress_percentage":67,"status":"in_progress"}
cue_pointsdisplay_durationHuman-readable duration format (e.g., "45m", "1h 30m")
Example: 45m
dubbing_modeWhether dubbing mode is available for this content
Example: true
durationepisode_orderobject[] · readOnly
List of genres associated with the content
Example: [{"id":1,"name":"action","slug":"action"},{"id":2,"name":"drama","slug":"drama"}]
i18n_seo_keywordi18n_seo_synopsisi18n_seo_titleidis_favoriteWhether the content is in user's favorites
Example: true
mediahub_categoriesmediahub_content_idMediahub content ID (UCMS content ID)
Example: 12345
posterPoster image information
Example: {"language":"en","orientation":"landscape","url":"https://example.com/poster.jpg"}
publish_endpublish_startrelease_yearRelease year of the content
Example: 2023
object · readOnly
seo_keywordseo_synopsisseo_titlesubtitlesList of available subtitle language codes
Example: ["en","ko","es"]
synopsisAmasianTag[] · readOnly
thumbnailtitletypes_of_contentsList of additional content types available for movie content (e.g., trailer, clip). Returns null for non-movie content.
Example: ["trailer","clip","additional"]
AmasianContentSyncHistory
콘텐츠 동기화 히스토리 Serializer
createdidmodifiedstatusSUCCESS- SuccessERROR- ErrorIN_PROGRESS- In Progress
Enum values:
SUCCESS
ERROR
IN_PROGRESS
syncedsynced_counttotal_countAmasianFavorite
Serializer for AmasianFavorites model.
Handles serialization and validation of favorite items.
Supports content, season, and channel types.
Device ID is provided via 'did' request header, not in request body.
source_idID of the content, season, or channel (positive integer)
typecontent- Contentseason- Seasonchannel- Channel
Enum values:
content
season
channel
createddevice_idAmasianFavoriteRequest
Serializer for AmasianFavorites model.
Handles serialization and validation of favorite items.
Supports content, season, and channel types.
Device ID is provided via 'did' request header, not in request body.
source_idID of the content, season, or channel (positive integer)
typecontent- Contentseason- Seasonchannel- Channel
Enum values:
content
season
channel
AmasianFavoriteTypeEnum
string · enum
Enum values:
content
season
channel
content- Contentseason- Seasonchannel- Channel
AmasianGenre
nameslug^[-\w]+$ · requiredcreatedi18n_nameidmodifiedAmasianItemBadges
bottom_leftbottom_righttop_lefttop_rightAmasianItemChannelView
titleobject
object
object
image_urllanding_optionAmasianItemInfo
category_slugchannel_idchannel_slugAmasianMultichannel
slug^[-\w]+$ · requiredobject[] · readOnly
List of channels in multichannel configuration
titleAmasianSeasonBaseInfo
slug^[-\w]+$ · requiredidposterAmasianSeasonPoster[] · readOnly
titleAmasianSeasonDetail
slug^[-\w]+$ · required
age_rating_infoAmasianCast[] · readOnly
AmasianCategory[] · readOnly
continue_watching_infoContinue watching information with status and playback target
Example: {"button_text":"Watch Now","cw_updated":null,"display_text":"Episode 1","episode":{"duration":3600,"episode_order":1,"id":100,"slug":"episode-1"},"last_position":0,"progress_percentage":0,"status":"not_started"}
direct_play_content_iddirect_play_content_slugdubbing_modeAmasianGenre[] · readOnly
i18n_seo_keywordi18n_seo_synopsisi18n_seo_titleidis_favoriteCheck if the season is in user's favorites Args: obj: AmasianSeason instance Returns: bool: True if season is in favorites, False otherwise
posterAmasianSeasonPoster[] · readOnly
publish_endpublish_startrelease_date_endrelease_date_startrelease_yearseason_orderseasonsseo_keywordseo_synopsisseo_titleobject · readOnly
subtitlessynopsisAmasianTag[] · readOnly
titletotal_number_of_seasonstypes_of_contentsAmasianSeasonPoster
idis_representativelanguageko- Koreanen- Englishzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishjp- Japanese
Enum values:
ko
en
zh-hans
zh-hant
es
jp
orientationlandscape- Landscapeportrait- Portrait
Enum values:
landscape
portrait
AmasianSeriesBaseInfo
slug^[-\w]+$ · requiredidtitleAmasianSeriesList
Serializer 용 mixin. `self.service_name` 프로퍼티로 amasian service_name 을 제공한다.
context['request'] 가 없거나 헤더가 없으면 기본값 `amasian` 으로 폴백한다.
object · readOnly
typeAmasianTag
패턴 B(필드별 i18n_<field> JSONField) 기반 번역 serializer.
modeltrans TranslationField(단일 i18n 컬럼) 를 쓰던 TranslationSerializer 와
동일하게 Accept-Language 로 단일 값을 스왑하지만, 번역 데이터는 필드별로 분리된
i18n_<field> JSONField({lang: value}) 에서 읽고 쓴다.
subclass 는 표시 필드명 -> i18n JSONField 명 매핑을 i18n_fields 로 정의한다.
i18n_fields = {"title": "i18n_title", "description": "i18n_description"}
slug^[-\w]+$ · requiredtitledescriptioni18n_descriptioni18n_titleidAvailableChannel
Serializer representing a channel eligible for the available-channels rail.
Input is an EPG instance (the channel's currently-airing, child-safe
programme, `select_related('channel')`'d by the query); channel identity
fields are read through the `channel` FK, matching `current_epg` naming
used elsewhere for the same pairing (see `Channel.current_epg`).
AvailableChannelEpg · required
Serializer representing the channel's currently-airing programme.
idlogonumbertitleAvailableChannelEpg
Serializer representing the channel's currently-airing programme.
end_timeScheduled end time of the program
start_timeScheduled start time of the program
thumbnailtitleChannel
Serializer representing channel information.
colordescriptionidobject
Serializer representing channel image information.
numberorderIncreasing values sequentially from 1. Only enabled channel has not null value
slug^[-\w]+$stream_urltitleChannelCategory
Serializer representing channel category and its channel list.
Accepts either a ChannelCategory or a ChannelCategoryOrder instance.
When a ChannelCategoryOrder is given, `order` comes from the order entry
(supporting same category at multiple positions).
category_typecategory- Categorybanner- Banner
Enum values:
category
banner
Channel[] · readOnly
orderobject · readOnly
Client API serializer for promoted content with platform-aware image selection and derived relationships.
slug^[-a-zA-Z0-9_]+$titleConsentResponse
consentsPer-purpose consent flags, e.g. {"advertising": true, "analytics": false}.
device_idpolicy_versionVersion of the consent document the user agreed to.
policy_version_idReference to amasian_policy AmasianPolicyVersion.id (the bundle the user consented to). Stored by value across the bounded-context boundary (no DB FK). Nullable for services without a managed policy.
service_name서비스 구분자 (예: amasian, lg-channel-vietnam)
Default: amasian
updated_atversionIncrements on each real change (no-op re-saves do not bump).
ConsentSaveRequest
POST body 검증. 닫힌 목적 키 셋을 강제한다:
- 알 수 없는 목적 키 → 400
- 누락된 목적 키 → 400 (전체 스냅샷 저장이 감사에 안전)
object · required
policy_versionpolicy_version_idamasian_policy AmasianPolicyVersion.id (from the policy read API).
ContentTypeEnum
string · enum
Enum values:
movie
tv-series
trailer
additional
clip
live_streaming
unknown
movie- Movietv-series- TV Seriestrailer- Traileradditional- Additionalclip- Cliplive_streaming- Live Streamingunknown- Unknown
ContinueWatchingSaveRequest
Continue Watching 데이터 저장을 위한 Serializer
content_id시청 중인 콘텐츠 ID
last_position마지막 시청 위치 (초 단위)
device_id디바이스 ID
Cover
slugenabledi18n_titleidrefresh_timerolling_time
CoverRequest
slugenabledi18n_titlerefresh_timerolling_time
CoverRetrieve
slugenabledi18n_titleiditemsrefresh_timerolling_time
DeletionRequestResponse
삭제요청 처리 결과/상태 응답 (실제 삭제된 콘텐츠 내용은 포함하지 않음).
deleted_scopes삭제된 범위/건수, 예: {"favorites": 3, "continue_watching": 5, "consent": true}
processed_atrequested_atrequester_typesubject / admin / a05
retention_untilsla_duestatusreceived / completed / failed
DeviceDataDeleteResponse
단일 종류(favorites 또는 continue watching) 일괄 삭제 응답.
deleted_count삭제된 레코드 수
message응답 메시지
success삭제 성공 여부
ImageTypeEnum
string · enum
Enum values:
banner_754x70
banner_754x76
banner_1060x76
banner_1464x120
banner_320x50
quickview_banner_standard
quickview_banner_flexible
banner_754x70- Banner 754x70banner_754x76- Banner 754x76banner_1060x76- Banner 1060x76banner_1464x120- Banner 1464x120banner_320x50- Banner 320x50quickview_banner_standard- Quickview Banner Standardquickview_banner_flexible- Quickview Banner Flexible
LanguageEnum
string · enum
Enum values:
ko
en
zh-hans
zh-hant
es
jp
ko- Koreanen- Englishzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishjp- Japanese
OdxV4ChannelImages
Serializer representing channel image information.
logoposterOdxV4NextRecommendedContent
Next recommended content information.
<details>
<summary>Use cases</summary>
* Binge now - when next_content is not available
</details>
content_idcontent_slugcontent_typeseason_idseason_slugseries_idseries_slugOdxV4Playback
Serializer representing content playback information.
object · readOnly
Continue watching information including playback progress and UI status
Example: {"button_text":"Resume","cw_updated":1640995200,"duration":3600,"last_position":1800,"progress_percentage":50,"status":"in_progress"}
OdxV4VideoCuePoint[] · readOnly
OdxV4VideoCue[] · readOnly
durationidis_chromecast_ableis_live_streamingmanifestsStreaming manifest information containing playback URLs and metadata
Example: {"id":123,"preset":"high_quality","stream_url":"https://cdn.example.com/content/123/playlist.m3u8","type":"application/x-mpegURL"}
mediahub_content_idnext_contentInformation about the next episode to play
Example: {"content_id":124,"content_slug":"episode-2-journey-continues","is_last_episode":false,"season_id":5,"season_slug":"season-1","series_id":1,"series_slug":"amazing-series","thumbnail":"https://cdn.example.com/thumbnails/124.jpg","title":"Episode 2: The Journey Continues"}
object · readOnly
Next recommended content information.
Use cases
Code
series_slugOdxV4VideoCue
Serializer representing video cue information.
endstarttypeOdxV4VideoCuePoint
Serializer representing video cue point information.
nametimecodetypemetadataOnboardingEventIngestRequest
온보딩 이벤트 수집(write) 입력. session_id로 세션에 묶인다.
- `type`: preference / view / interaction / cta_app / cta_web / misc 등 자유
- `step`: 퍼널 단계(FunnelStep). 진행도 계산용. 없으면 세부 이벤트로만 기록
session_idtypemetasourceDefault: direct
tsOrientationEnum
string · enum
Enum values:
landscape
portrait
landscape- Landscapeportrait- Portrait
PromotedContent
Client API serializer for promoted content with platform-aware image selection and derived relationships.
PromotedContentBeacon[] · readOnly
campaign_end_datecampaign_start_datecategory_slugchannel_idchannel_slugcontent_idcontent_slugcontent_typeidPromotedContentImage[] · readOnly
season_idGet season ID from content hierarchy.
season_slugseries_idGet series ID from content hierarchy.
series_slug
External url for web & mobile
PromotedContentBeacon
Serializer representing promoted content beacon URL information.
beacon_typeType of beacon, 'impression' or 'engagement'
beacon_urlPromotedContentImage
Serializer representing promoted content image information.
image_typebanner_754x70- Banner 754x70banner_754x76- Banner 754x76banner_1060x76- Banner 1060x76banner_1464x120- Banner 1464x120banner_320x50- Banner 320x50quickview_banner_standard- Quickview Banner Standardquickview_banner_flexible- Quickview Banner Flexible
Enum values:
banner_754x70
banner_754x76
banner_1060x76
banner_1464x120
banner_320x50
quickview_banner_standard
quickview_banner_flexible
descriptionheight
title
widthPromotedContentTypeEnum
string · enum
Enum values:
season
series
content
channel
category
external
season- Seasonseries- Seriescontent- Contentchannel- Channelcategory- Categoryexternal- External
Recommend
Serializer representing recommendation content information.
object · readOnly
Recommendation data containing view and info sections
Example: {"info":{"content_id":123,"content_slug":"example-movie","content_type":"movie","title":"Example Movie"},"view":{"badges":{"bottom_full":"newly-added","bottom_left":null,"bottom_right":null,"top_left":"dub","top_right":null},"image":{"orientation":"landscape","url":"https://cdn.example.com/images/content.jpg"}}}
typeStatusEnum
string · enum
Enum values:
SUCCESS
ERROR
IN_PROGRESS
SUCCESS- SuccessERROR- ErrorIN_PROGRESS- In Progress
StepEnum
string · enum
Enum values:
entry_view
start_click
questions_done
shorts_done
carousel_view
cta_app_click
cta_web_click
entry_view- Entrystart_click- Start Clickquestions_done- Questions Doneshorts_done- Shorts Donecarousel_view- Carousel Viewcta_app_click- Cta App Clickcta_web_click- Cta Web Click