as

Settings
Sign out
Notifications
Alexa
亚马逊应用商店
Ring
AWS
文档
Support
Contact Us
My Cases
开发
测试
应用发布
盈利
用户参与
设备规格
资源

服务目录

服务目录

服务目录定义了客户如何访问和发现内容,包括权利、启动目标和发现元数据。以下各部分描述了OfferCatalog中包含的元素。

OfferCatalog

包含与服务相关的实体,用于定义用户访问和发现内容的方式。

属性 详细信息
父元素 DataCollections
数据类型 OfferCatalogType
子元素 描述
Delete 用于从目录中删除服务的管理动词。
ProgramOffers 定义特定节目的访问详细信息。
ProgramAiringOffers 定义节目特定播出的访问详细信息。
StationOffers 定义特定电视台的访问详细信息。
ProgramDiscovery 定义节目探索属性,例如排名、评分和促销徽标。
属性 描述
id

服务目录的标识符。默认值为DEFAULT_OFFER_CATALOG

数据类型: ID

version

每次修订都会增加的整数。用于版本控制。默认值为1

数据类型:long

action

指明在提交目录时应采取哪个操作。默认值为upsert
有效值:upsertreplace

数据类型: CatalogActionType



↑返回顶部

Delete

一个管理动词,能够以编程方式从目录中删除项目。当引入系统处理Delete元素时,它会将具有指定ID的项目从系统中移除。

属性 详细信息
父元素 DataCollections
ProgramCatalog
ScheduleCatalog
OfferCatalog
StationCatalog
LineupCatalog
PolicyCatalog
数据类型 DeleteType
属性 描述
id
必需

要删除的实体的唯一标识符。

数据类型: ID

version

要删除的实体的版本。必须大于或等于当前实体版本。默认值为1

数据类型:long



↑返回顶部

ProgramOffers

节目服务列表。

属性 详细信息
父元素 OfferCatalog
数据类型 ProgramOffersType
子元素 描述
ProgramOffer
必需
定义节目的访问详细信息。
属性 描述
id
必需

节目服务的标识符。

数据类型: ID

version

节目服务的版本。默认值为1

数据类型:long

programRef
必需

将此服务链接到特定节目的引用标识符。

数据类型: ID

programCatalogRef

包含所提供节目的目录的引用。默认值为DEFAULT_PROGRAM_CATALOG

数据类型: ID



↑返回顶部

ProgramAiringOffers

播出服务的列表。

属性 详细信息
父元素 OfferCatalog
数据类型 ProgramAiringOffersType
子元素 描述
ProgramAiringOffer
必需
定义播出的访问详细信息。
属性 描述
id
必需

播出服务的标识符。

数据类型: ID

version

播出服务的版本。默认值为1

数据类型:long

programRef
必需

将此服务链接到特定节目或节目播出的引用标识符。

数据类型: ID

programCatalogRef

包含所提供节目或节目播出的目录的引用。默认值为DEFAULT_PROGRAM_CATALOG

数据类型: ID



↑返回顶部

StationOffers

电视台服务列表。

属性 详细信息
父元素 OfferCatalog
数据类型 StationOffersType
子元素 描述
StationOffer
必需
定义电视台的访问详细信息。
属性 描述
id
必需

电视台服务的标识符。

数据类型: ID

version

电视台服务的版本。

数据类型:long

stationRef
必需

将此服务链接到特定电视台的引用标识符。

数据类型: ID

stationCatalogRef

包含所提供电视台的目录的引用。默认值为DEFAULT_STATION_CATALOG

数据类型: ID



↑返回顶部

ProgramDiscovery

定义节目探索属性,例如排名、评分和促销徽标。

属性 详细信息
父元素 OfferCatalog
数据类型 ProgramDiscoveryType
子元素 描述
Ranks Rank元素列表。
CustomerRatings CustomerRating元素列表。
Badges Badge元素列表。
属性 描述
start

探索可用性开始时间。

数据类型: DateTimeType

end

探索可用性结束时间。

数据类型: DateTimeType

territories

可以探索节目或电视台的国家/地区。以逗号分隔的地区代码列表,例如"US,CA"。要表示该值适用于所有地区,请使用GLOBAL

数据类型: TerritoriesType

programRef
必需

将此服务链接到特定节目或节目播出的引用标识符。

数据类型: ID

programCatalogRef

包含所提供节目或节目播出的目录的引用。默认值为DEFAULT_PROGRAM_CATALOG

数据类型: ID



↑ 返回顶部

ProgramOffer

定义节目的访问详细信息。

属性 详细信息
父元素 ProgramOffers
数据类型 ProgramOfferType
子元素 描述
Entitlements
必需
内容访问的权利列表。
AudioLanguages 包含可用的音频语言选项。
SubtitleLanguages 包含可用的字幕语言选项。
VideoResolutions 包含可用的视频分辨率选项。
VideoAttributes 包含可用的视频属性选项。
AudioAttributes 包含可用的音频属性选项。
Ads 表示节目中的广告。这是一个空元素。
Tags Tag元素列表。
GeoRestrictions 内容访问的地理限制列表。
LaunchTargets LaunchTarget元素列表。
属性 描述
start

订阅可用性开始时间。

数据类型: DateTimeType

end

订阅可用性结束时间。

数据类型: DateTimeType

territories

以逗号分隔的地区代码列表,例如"US,CA"。默认值为GLOBAL(表示该值适用于所有地区)。

数据类型: TerritoriesType



↑ 返回顶部

Entitlements

内容访问的权利列表。

属性 详细信息
父元素 ProgramOffer
ProgramAiringOffer
StationOffer
数据类型 EntitlementListType
子元素 描述
Entitlement
必需
用于访问内容的权利详细信息。指定typepolicyRef属性,不能同时指定两者:
  • 对于简单的标准权利(freesubscription)以及不需要额外策略配置时,使用type
  • 使用订阅授权API集成与亚马逊共享用户权利时,请使用policyRef


↑ 返回顶部

Entitlement

用于访问内容的权利详细信息。指定typepolicyRef属性,不能同时指定两者:

  • 对于简单的标准权利(freesubscription)以及不需要额外策略配置时,使用type
  • 使用订阅授权API集成与亚马逊共享用户权利时,请使用policyRef

属性 详细信息
父元素 Entitlements
数据类型 EntitlementType
属性 描述
type
必需

typepolicyRef中的一个为必需。权利的类型。有效值:

  • free – 内容为免费提供。
  • subscription – 内容需要订阅或附加订阅。例如,高级套餐内容或体育附加内容。

数据类型: EntitlementTypeEnumType

policyRef
必需

typepolicyRef中的一个为必需。带有权利详细信息的策略的引用。

数据类型:string

policyCatalogRef

包含所引用策略的策略目录的引用。默认值为DEFAULT_POLICY_CATALOG

数据类型: ID



↑ 返回顶部

AudioLanguages

包含可用的音频语言选项。

属性 详细信息
父元素 Airing
ProgramOffer
StationOffer
Station
数据类型 AudioLanguageList
子元素 描述
AudioLanguage
必需
节目或电视台的音频语言。


↑返回顶部

AudioLanguage

节目或电视台的音频语言。

属性 详细信息
父元素 AudioLanguages
数据类型 AudioLanguageType - 表示节目音频语言的string
属性 描述
language
必需

包含此项目的语言数据。

数据类型: LanguageType

default

表示默认音频语言。

数据类型:boolean

original

指明这是否是内容的原始语言。对原始语言使用true,对配音内容使用false。

数据类型:boolean



↑返回顶部

SubtitleLanguages

包含可用的字幕语言选项。

属性 详细信息
父元素 Airing
ProgramOffer
StationOffer
Station
数据类型 SubtitleLanguageList
子元素 描述
SubtitleLanguage
必需
节目或电视台的字幕语言。


↑返回顶部

SubtitleLanguage

节目或电视台的字幕语言。

属性 详细信息
父元素 SubtitleLanguages
数据类型 SubtitleLanguageType - 表示节目字幕语言的string
属性 描述
language
必需

包含此项目的语言数据。

数据类型: LanguageType

closed

隐藏式字幕为True;录入字幕为false或省略。

数据类型:boolean

default

表示SubtitleLanguage元素列表中的默认字幕语言。

数据类型:boolean



↑返回顶部

VideoResolutions

包含可用的视频分辨率选项。

属性 详细信息
父元素 ProgramOffer
ProgramAiringOffer
StationOffer
Station
数据类型 VideoResolutionList
子元素 描述
VideoResolution
必需
一种封闭枚举,表示提供的视频分辨率。有效值包括SDHDFullHD4K8K


↑返回顶部

VideoResolution

表示所提供的视频分辨率的封闭式枚举。有效值包括SDHDFullHD4K8K

属性 详细信息
父元素 VideoResolutions
数据类型 ResolutionType


↑返回顶部

VideoAttributes

包含可用的视频属性选项。

属性 详细信息
父元素 ProgramOffer
ProgramAiringOffer
StationOffer
数据类型 VideoAttributeList
子元素 描述
VideoAttribute
必需
包含在服务中的节目视频属性。


↑返回顶部

VideoAttribute

包含在服务中的节目视频属性。示例包括SDRHDR10+Dolby Vision

属性 详细信息
父元素 VideoAttributes
数据类型 一个string


↑返回顶部

AudioAttributes

包含可用的音频属性选项。

属性 详细信息
父元素 ProgramOffer
ProgramAiringOffer
StationOffer
数据类型 AudioAttributeList
子元素 描述
AudioAttribute
必需
节目的音频属性。


↑返回顶部

AudioAttribute

节目的音频属性。示例包括Dolby Digital 5.1DD 5.1DD7.1DD7.1+Dolby Atmos

属性 详细信息
父元素 AudioAttributes
数据类型 一个string


↑返回顶部

Ads

表示节目中的广告。这是一个空元素。

属性 详细信息
父元素 ProgramOffer
ProgramAiringOffer
StationOffer
数据类型 AdsType - 空元素,表示内容播放期间是否插入动态广告。


↑返回顶部

Tags

Tag元素列表。

属性 详细信息
父元素 Movie
TVEpisode
TVSeason
TVSeries
Extra
SportsEvent
Event
Other
OffAir
ToBeAnnounced
Airing
ProgramOffer
StationOffer
ProgramAiringOffer
Station
EntitlementPolicy
数据类型 TagList
子元素 描述
Tag
必需
用于对节目或播出进行分类、推广或以其他方式应用自定义处理的其他元数据。


↑返回顶部

Tag

用于对节目或播出进行分类、推广或以其他方式应用自定义处理的其他元数据。这些值的架构、键和有效格式必须由您和亚马逊协商。此功能用于启用非标准或新兴用例,直到在规范中添加专用实体或属性并对其进行版本控制为止。

属性 详细信息
父元素 Tags
数据类型 TagType - 添加了必需的schemekey属性的string
属性 描述
scheme
必需

键值对的通用唯一命名空间。

数据类型:string

key
必需

键值对的键。该值是元素值。

数据类型:string



↑返回顶部

GeoRestrictions

内容访问的地理限制列表。

属性 详细信息
父元素 Airing
ProgramOffer
StationOffer
Lineup
数据类型 GeoRestrictionList
子元素 描述
GeoRestriction
必需
内容访问的GeoRestriction详细信息。


↑返回顶部

GeoRestriction

内容访问的GeoRestriction详细信息。

属性 详细信息
父元素 GeoRestrictions
数据类型 GeoRestrictionType
属性 描述
policyRef
必需

对策略的引用,该策略包含地理限制详细信息。

数据类型: ID

policyCatalogRef

包含所引用策略的策略目录的引用。默认值为DEFAULT_POLICY_CATALOG

数据类型: ID



↑返回顶部

LaunchTargets

LaunchTarget元素列表。

属性 详细信息
父元素 ProgramOffer
ProgramAiringOffer
StationOffer
数据类型 LaunchTargetList
子元素 描述
LaunchTarget
必需
指定在各种设备、服务和演示上启动给定节目、播出或电视台所需的信息。


↑返回顶部

LaunchTarget

指定在各种设备、服务和演示上启动给定节目、播出或电视台所需的信息。

属性 详细信息
父元素 LaunchTargets
数据类型 LaunchTargetType - 一种字符串,指定启动给定节目、播出或电视台所需的信息。
属性 描述
type

枚举有效的启动目标类型。有效值: WEBFIRETV

数据类型: LaunchTargetTypeEnum



↑返回顶部

ProgramAiringOffer

定义播出的访问详细信息。

属性 详细信息
父元素 ProgramAiringOffers
数据类型 ProgramAiringOfferType
子元素 描述
Airing
必需
节目播出详情。
Entitlements
必需
内容访问的权利列表。
VideoResolutions 包含可用的视频分辨率选项。
VideoAttributes 包含可用的视频属性选项。
AudioAttributes 包含可用的音频属性选项。
Ads 表示节目中的广告。这是一个空元素。
Tags Tag元素列表。
LaunchTargets LaunchTarget元素列表。
属性 描述
start

订阅可用性开始时间。

数据类型: DateTimeType

end

订阅可用性结束时间。

数据类型: DateTimeType

territories

以逗号分隔的地区代码列表,例如"US,CA"。默认值为GLOBAL(表示该值适用于所有地区)。

数据类型: TerritoriesType

scheduleCatalogRef

包含播出的目录的引用。默认值为DEFAULT_SCHEDULE_CATALOG

数据类型: ID



↑返回顶部

Airing

Airing实体将节目与时段相关联。必须使用标识符的ref属性引用现有节目条目来定义节目表的内容。您可以在节目表中定义评分,但这些评分是针对单个节目表条目的覆盖项,不会影响内容的评分。

属性 详细信息
父元素 Schedule
ProgramAiringOffer
数据类型 AiringType
子元素 描述
Live 表示该节目正在实时播出。这是一个空元素。
New 表示该节目是首次播出。这是一个空元素。
Edited 表示播出内容与原始版本相比是否有所变化。
Ratings Rating元素列表。
AudioLanguages 包含可用的音频语言选项。
SubtitleLanguages 包含可用的字幕语言选项。
Tags Tag元素列表。
GeoRestrictions 节目表的策略引用列表,例如地区限制。
属性 描述
id
必需

播出实体的标识符。

数据类型: ID

startTime
必需

播出开始时间。

数据类型: DateTimeType

duration
必需

播出持续时间。

数据类型: DurationType

programRef
必需

与播出相关节目的引用。

数据类型: ID

programCatalogRef

包含播出的节目的节目目录的引用。覆盖为节目表提供的节目目录。默认值为DEFAULT_PROGRAM_CATALOG

数据类型: ID



↑返回顶部

Live

表示该节目正在实时播出。这是一个空元素。

属性 详细信息
父元素 Airing
数据类型 string


↑返回顶部

New

表示该节目是首次播出。这是一个空元素。

属性 详细信息
父元素 Airing
数据类型 string


↑返回顶部

Edited

表示播出内容与原始版本相比是否有所变化。

属性 详细信息
父元素 Airing
数据类型 EditedType
属性 描述
cropped

表示内容已被裁剪。裁剪会编辑宽高比,通常是为了获得更合适的电视宽高比。

数据类型:boolean

content

表示该节目已针对内容进行了编辑。对内容进行编辑会缩短节目的广播时长。这样做可以删除更具限制性的场景或适应广播时段。

数据类型:boolean

language

表示该节目已针对语言进行了编辑。编辑语言通常不会影响节目的长度,但会为音频配音或将亵渎内容静音,以降低对节目的限制性评分。

数据类型:boolean



↑返回顶部

Ratings

Rating元素列表。

属性 详细信息
父元素 Movie
TVEpisode
TVSeason
TVSeries
Extra
SportsEvent
Event
Other
Airing
Station
数据类型 RatingList
子元素 描述
Rating
必需
提供针对适龄观众限制的认证。


↑返回顶部

Rating

提供针对适龄观众限制的认证。adultProductnotRated标记是布尔属性,表示该计划已应用适用的年龄限制业务规则。实际节目和播出都有评分值。Rating元素包括内容描述符,其具有代码和相应的描述。描述来自评分系统的管理机构,并使用评分机构的主要语言。在某些地区,法律要求提供内容描述符。Video Central文档(仅提供英文版)中列出了支持的评分和描述符。使用全球评分规范。

特定于目录的条件:

  • 节目表目录: 如果您为播出指定评分,它将覆盖节目评分信息。
  • 电视台目录: 如果没有节目或播出评分,则目录系统使用电视台评分。

属性 详细信息
父元素 Ratings
数据类型 RatingType - 包含针对适龄观众限制的认证的结构。
子元素 描述
Descriptors Descriptor元素列表。
属性 描述
system
必需

电影内容评级系统。

数据类型:string

certification
必需

认证价值取决于节目对受众的适用性。

数据类型:string

adultProduct

指明节目是否应用了适用的年龄限制业务规则。

数据类型:boolean

notRated

指明节目是否应用了适用的年龄限制业务规则。

数据类型:boolean

territories

以逗号分隔的地区代码列表,例如"US,CA"。默认值为GLOBAL(表示该值适用于所有地区)。

数据类型: TerritoriesType

sourceName

来源的名称。如果未提供,则目录系统使用数据提交者作为数据元素的来源。

数据类型: SourceNameType

sourceDate

检索信息的日期。如果未提供,则系统使用数据提交日期。

数据类型: SourceDateType

sourceId

提供值的数据记录的标识符(内部或外部)或URI。如果未提供,则默认为包含实体的ID。

数据类型: SourceIdType



↑返回顶部

Descriptors

Descriptor元素列表。

属性 详细信息
父元素 Rating
数据类型 DescriptorList
子元素 描述
Descriptor
必需
Descriptor元素提供内容描述符。内容描述符包括代码和相应的描述。


↑返回顶部

Descriptor

Descriptor元素提供内容描述符。内容描述符包括代码和相应的描述。描述来自评分系统的管理机构,并使用评分机构的主要语言。在某些地区,法律要求提供内容描述符。Video Central文档(仅提供英文版)中列出了支持的评分和描述符。使用全球评分规范。

属性 详细信息
父元素 Descriptors
数据类型 DescriptorType
属性 描述
code

描述符的两个字母的编码。

数据类型:string



↑返回顶部

StationOffer

定义电视台的访问详细信息。

属性 详细信息
父元素 StationOffers
数据类型 StationOfferType
子元素 描述
Entitlements
必需
内容访问的权利列表。
AudioLanguages 包含可用的音频语言选项。
SubtitleLanguages 包含可用的字幕语言选项。
VideoResolutions 包含可用的视频分辨率选项。
VideoAttributes 包含可用的视频属性选项。
AudioAttributes 包含可用的音频属性选项。
Ads 表示节目中的广告。这是一个空元素。
Tags Tag元素列表。
GeoRestrictions 内容访问的地理限制列表。
LaunchTargets LaunchTarget元素列表。
StationTransport 电视台传输详细信息。
属性 描述
start

订阅可用性开始时间。

数据类型: DateTimeType

end

订阅可用性结束时间。

数据类型: DateTimeType

territories

以逗号分隔的地区代码列表,例如"US,CA"。默认值为GLOBAL(表示该值适用于所有地区)。

数据类型: TerritoriesType



↑ 返回顶部

StationTransport

指定在各种设备、服务和演示上启动给定电视台作品所需的信息。

属性 详细信息
父元素 StationOffer
Channel
数据类型 StationTransportType - 一种字符串,用于指定启动给定电视台作品所需的信息。
属性 描述
channelnum
必需

向观众显示的频道编号。可以包括小数和子频道,例如“2.1”。

数据类型:string

subsystem

传输系统类型。有效值: DVB-TDVB-SDVB-CISDB-TISDB-SISDB-CATSCATSC3DTMB

数据类型:string

onid

原始网络ID。网络的唯一标识符。

数据类型:string

tsid

传输流ID。识别多样流。

数据类型:string

sid

服务ID。识别传输流中的特定服务。

数据类型:string



↑返回顶部

Ranks

Rank元素列表。

属性 详细信息
父元素 ProgramDiscovery
数据类型 RankList
子元素 描述
Rank
必需
排名是相对于目录中所有其他节目的分数。


↑返回顶部

Rank

排名是相对于目录中所有其他节目的分数。较低的值表示该节目的排名高于其他具有较高值的项目。项目可以获得的最高排名是1。多个项目具有相同的排名是可以接受的。

属性 详细信息
父元素 Ranks
数据类型 RankType - 包含节目排名的结构。
属性 描述
territories

以逗号分隔的地区代码列表,例如"US,CA"。默认值为GLOBAL(表示该值适用于所有地区)。

数据类型: TerritoriesType

value

数据类型:nonNegativeInteger



↑ 返回顶部

CustomerRatings

CustomerRating元素列表。

属性 详细信息
父元素 ProgramDiscovery
数据类型 CustomerRatingList
子元素 描述
CustomerRating
必需
客户评分包含众包或经过专业审查的作品相对评分。必须提供系统的来源、分数、分数基准(最大分数)和群组规模,以及从来源检索数据的日期。


↑返回顶部

CustomerRating

客户评分包含众包或经过专业审查的作品相对评分。必须提供系统的来源、分数、分数基准(最大分数)和群组规模,以及从来源检索数据的日期。

属性 详细信息
父元素 CustomerRatings
数据类型 CustomerRating - 包含众包或经过专业审查的作品评分的结构。
属性 描述
territories

以逗号分隔的地区代码列表,例如"US,CA"。默认值为GLOBAL(表示该值适用于所有地区)。

数据类型: TerritoriesType

score

为内容提供的实际评分值或分数。

数据类型:decimal

maxScore

评分系统中可能的最大分数。

数据类型:decimal

numVotes

给出的总票数或评分。

数据类型:unsignedInt

sourceName

提供评分的组织或系统的名称。

数据类型:string

sourceDate

收集或上次更新评分数据的日期。

数据类型: DateType



↑返回顶部

Badges

Badge元素列表。

属性 详细信息
父元素 ProgramDiscovery
数据类型 BadgeList
子元素 描述
Badge
必需
徽标包含一个枚举值,允许节目标题向客户提供有关标题来源或可用性的更多信息。根据客户的语言和地区对徽标文字或图标进行本地化。


↑返回顶部

Badge

徽标包含一个枚举值,允许节目标题向客户提供有关标题来源或可用性的更多信息。根据客户的语言和地区对徽标文字或图标进行本地化。

属性 详细信息
父元素 Badges
数据类型 BadgeType - 向客户提供有关标题来源或可用性的其他信息的结构。
属性 描述
territories

以逗号分隔的地区代码列表,例如"US,CA"。默认值为GLOBAL(表示该值适用于所有地区)。

数据类型: TerritoriesType

scheme

徽标命名空间。支持的架构是ember_badgeember_badge的有效值:

  • original – 制作或独家授权。
  • new – 最近向目录中添加的内容。
  • premiere —连续剧、季或电影的首次发布或首次亮相。
  • finale – 连续剧或季的最后一集。
  • coming_soon – 将在不久的将来推出的内容。
  • leaving_soon – 即将从目录中删除的内容。
请咨询您的亚马逊代表,了解定义时间敏感徽标的具体时间窗口,例如newcoming_soonleaving_soon

数据类型:string



↑返回顶部

Last updated: 2026年5月28日