adi20 icms内容运营平台与业务运营平台元数据同步接口技术规范本

1、ICMS内容运营平台与业务运营平台元数据同步接口技术规范总体说明ICMS内容运营平台 与业务运营平台元数据同步接口技术规范目 录V3.3i第1章 总体说明5第2章 XML指令文件72.1 XML文件技术要求72.1.1 规范适用范围72.1.2 XML文件结构72.2 ADI定义132.2.1 GroupAsset定义及分类142.2.2 MetadataAsset定义及分类152.2.3 ContentAsset定义分类162.2.4 AssociateContent定义分类182.2.5 AssociateGroup定义分类192.2.6 MetadataAsset中元数据分类192.2.

2、7 Movie定义202.2.8 Series定义232.2.9 Music定义282.2.10 Character定义312.2.11 Information定义332.2.12 Columns定义352.2.13 StaticLink定义402.2.14 Game定义412.2.15 Channel定义412.2.16 News定义432.2.17 Column定义462.2.18 Schedule定义492.2.19 Audio定义502.2.20 Image定义522.2.21 PhysicalChannel542.2.22 AssetProgram定义562.2.23 Program

3、定义572.2.24 Text定义592.2.25 Paragraph定义602.2.26 Video定义62iv修订记录ICMS内容运营平台 与业务运营平台元数据同步接口技术规范XML指令文件第1章 总体说明。71第2章 XML指令文件2.1 XML文件技术要求2.1.1 规范适用范围本规范所定义的是ICMS内容管理系统向各业务系统发内容时，以各种方式所发送xml指令信息的内容含义，与具体接口过程无关。2.1.2 XML文件结构XML 文件的结构如下图所示：图 2-1 XML 文件结构图以下是一个 XML 定义的通用格式例子：<?xml version="1.0"

4、encoding="UTF-8"?><adi:ADI2 xmlns= xmlns:adi=" xmlns:vod=" <adi:OpenGroupAsset type="VODRelease" product="VOD"> <vod:VODRelease providerID="providerID" assetID="metaData.assetId" updateNum="" groupAsset="Y"

5、; serialNo=""> <adi:AssetLifetime startDateTime="startDateTime" endDateTime="endDateTime"/> </vod:VODRelease> </adi:OpenGroupAsset> <adi:AddMetadataAsset groupProviderID="providerID" groupAssetID="metaData.assetId" type="

6、Title" product="VOD"> <vod:Title providerID="providerID" assetID="assetId" updateNum="1"> <adi:AssetLifetime startDateTime="startDateTime" endDateTime="endDateTime"/> <vod:TitleFull>assetName</vod:TitleFull>

7、<vod:ShowType>Movie</vod:ShowType> <vod:SummaryMedium>description</vod:SummaryMedium> <vod:SummaryShort>viewPoint</vod:SummaryShort> <vod:RunTime>length</vod:RunTime> <vod:CountryOfOrigin>region</vod:CountryOfOrigin> <vod:Actor type=&quo

8、t;Actor"> <vod:LastNameFirst>actor</vod:LastNameFirst> </vod:Actor> <vod:Actor type="Actress"> <vod:LastNameFirst>actress</vod:LastNameFirst> </vod:Actor> <vod:Actor type="CoActor"> <vod:LastNameFirst>coactor</vod:L

9、astNameFirst> </vod:Actor> <vod:Actor type="CoActress"> <vod:LastNameFirst>coactress</vod:LastNameFirst> </vod:Actor> <vod:Director> <vod:LastNameFirst>director</vod:LastNameFirst> </vod:Director> <vod:Year>publishYear</vod:

10、Year> <vod:Comments>comments</vod:Comments> </vod:Title> </adi:AddMetadataAsset> <adi:AddMetadataAsset groupProviderID="providerID" groupAssetID="metaData.assetId" type="CategoryPath" product="VOD"> <vod:CategoryPath provide

11、rID="providerID" assetID="assetId" updateNum="1"> <adi:AssetLifetime startDateTime="startDateTime" endDateTime="endDateTime"/> <vod:Category>category,category2</vod:Category><vod: Classification>classification</vod: Clas

12、sification> </vod:CategoryPath> </adi:AddMetadataAsset> <adi:AddMetadataAsset groupProviderID="providerID" groupAssetID="metaData.assetId" type="Copyright" product="VOD"> <vod:Copyright providerID="providerID" assetID="me

13、taData.assetId" updateNum="1"> <adi:AssetLifetime startDateTime="startDateTime" endDateTime="endDateTime"/><vod:LicenseType>licenseType</vod:LicenseType> <vod:OriginalLicenseCompany>originalLicenseCompany</vod:OriginalLicenseCompany>

14、; </vod:Copyright> </adi:AddMetadataAsset> <adi:AcceptContentAsset type="Video" metadataOnly="N" fileName="fileName" fileSize="childMetaData.fileSize" mD5CheckSum="md5Sum"> <vod:Video providerID="providerID" assetID=&qu

15、ot;childMetaData.assetId" updateNum="1" fileName="fileName" fileSize="fileSize" mD5CheckSum="md5Sum" transferContentURL="fileURL" encodingProfile="videoCodec"> <adi:AssetLifetime startDateTime="startDateTime" endDateTim

16、e="endDateTime"/> <vod:Duration>duration</vod:Duration> <vod:MimeType>1</vod:MimeType> <vod:Bitrate>bitrate</vod:Bitrate> <vod:Numberofframes>numberofframes</vod:Numberofframes> <vod:FrameHeight>frameHeight</vod:FrameHeight> &l

17、t;vod:Usage>useType</vod:Usage> </vod:Video> </adi:AcceptContentAsset> <adi:AssociateContent type="itemType" effectiveDate="" groupProviderID="providerID" groupAssetID="assetId" providerID="providerID" assetID="assetId&qu

18、ot;/></adi:ADI2>ADI2/OpenGroupAsset/AddMetadataAsset/AcceptContentAsset/AssociateContent 是接口 XML 的通用基础框架，基于该通 用框架定义不同的MetadataAsset.Title. ShowType 和不同的ContentAsset. type 来 满足对不同对象的定义需求。请注意本规范的描述中应用以下规则：a) 元数据接口规范是根据ADI2的规范制定，文档包含OpenGroupAsset ReplaceGroupAssetDropGroupAsset、AddMetadataAss

19、et ReplaceMetadataAssetRemoveMetadataAsset、AcceptContentAsset ReplaceContentAsset DestroyContentAsset、AssociateContent，以及自定义的AssociateGroup用于表多个组之间关系的元素，各元素的意义同ADI2中定义。b) 本接口规范中内容的增、删、改由GroupAsset的相应操作决定，OpenGroupAsset表示新建内容、ReplaceGroupAsset表示修改内容、DropGroupAsset表示删除内容，子内容的增、删、改由ContentAsset决定，Accep

20、tContentAsset表示新增、ReplaceContentAsset表示修改、DestroyContentAsset表示删除。c) 对于任何资内容类型，由AddMetadataAsset标签中Title子标签的ShowType元素决定。d) 文档中同一组的groupAssetID相同，是标识一个内容的全局唯一ID，具体一个内容的标识也取这个值e) AcceptContentAsset代表每个内容的实体文件的描述，一组中可有0到多个子内容，子内容的类型由AcceptContentAsset的type属性决定，子内容的增、删、改由ContentAsset相应的操作决定。f) Associat

21、eContent定义每个实体内容与资产元数据之间的映射关系，groupAssetID定义对应的资产元数据的ID，assetID定义实体内容的ID。g) 本接口规范还自定义了AssociateGroup元素，表示多个组之间的关系，处理对于类似于电视剧集与各集之间，各组存在父子关系的场景，sourceGroupAssetID定义要关联的各子组的ID，targetGroupAssetID定义被关联的父组的IDh) 一个文档中有1.n个GroupAsset 元素，如果是电影之类，在实际中只有一集的，则只有一个GroupAsset，如果是电视剧之类，在实际中有一个总集，还有多集的情况，在发布时，一般是一

22、起发布，所以会有1.n个GroupAsset。一个GroupAsset元素中只有一个<vod:VODRelease>元素，以GroupAsset为组的一个整体中，会有1.3个MetadataAsset元素，根据实际情况，其中各MetadataAsset的type唯一（2.2.2MetadataAsset定义及分类中的 其中type分类定义中），例如不能同时存在有两个type是Title是元素， 并MetadataAsset中type为Title元素是必须的，CategoryPath或Copyright是可选的，如，有的内容没有版权的概念。这三者下的各子元素都只有一个，<vod

23、:Actor> 有多个，但是有type区分以GroupAsset为组的一个整体中，会有0.n个ContentAsset元素，根据实际情况，其中的type并不唯一，例如同时会有两个Video文件，其中一个是正片，一个是片花。ContentAsset下的各子元素只有一个。ContentAsset的type定义见2.2.3ContentAsset定义分类，其中type分类定义。一个AssociateContent元素定义一个ContentAsset与一个GroupAsset之间的关系，如果有0.n个ContentAsset元素，就有0.n个AssociateContent元素一个Associa

24、teGroup元素定义一个子GroupAsset与一个父GroupAsset之间的关系，根据实际情况，如一部电视剧中有一个总集的定义，还会有0.m个剧集定义，所以会有0.m个AssociateGroup以上是文档的结构文档中各元素的操作如下：如果是icms向 某业务系统以新增的方式发布内容，则各子内容都是新增操作，其中GroupAsset与MetadataAsset操作相同，所以GroupAsset取OpenGroupAsset， MetadataAsset取AddMetadataAsset，各ContentAsset取AcceptContentAsset如果是以修改的方式发布内容，而子内容的

25、操作是增删改，如修改一部电影，子内容的操作是新增了一部片花、删除之前的海报、以一部高清正片替换之前标清的正片，则GroupAsset取ReplaceGroupAsset，MetadataAsset取ReplaceMetadataAsset，ContentAsset分别取AcceptContentAsset、DestroyContentAsset、ReplaceContentAsset如果是以删除的方式发布内容，而子内容肯定是全部删除，所以GroupAsset取DropGroupAsset， MetadataAsset取RemoveMetadataAsset。2.2 ADI定义以下章节描述了 X

26、ML 的详细定义。在其中 att 表示 XML 属性, el表示 XML 元素, pn 表示 Property 节点的 Name)。ADI2 是 XML 的根元素。名称说明是否必选长度注释1ADI2根元素2OpenGroupAssetReplaceGroupAssetDropGroupAssetel组对象M同一个xml中可有多个组对象3AddMetadataAssetReplaceMetadataAssetRemoveMetadataAssetel元数据对象M同一个组可有多个MetadataAsset，每个MetadataAsset的type不同4AcceptContentAssetRepla

27、ceContentAssetDestroyContentAssetel内容对象O同一个组可有多个同type的ContentAsset5AssociateContentel内容与元数据映射对象O将Content与对应的元数据关联6AssociateGroupel多组之间父子关系对象O对于类似与电视剧这样存在多层结构的父子关系的描述2.2.1 GroupAsset定义及分类名称说明是否必选长度（字节）注释OpenGroupAsset,DropGroupAsset,ReplaceGroupAssettypeatt默认值VODReleaseMproductatt默认值VODMElementName(c

28、hild of GAoperation)VODReleaseelproviderIDatt内容提供商的ID（CPID）M128本规范中所有该属性的意义和值相同providerTypeatt内容提供商的类型M1CP类型: 1 个人用户 2 CP 3 集团 4 联通自有系统assetIDatt内容ID，全局唯一O128与本规范中的所有的groupAssetID取值相同updateNumatt更新数O2暂不处理groupAssetatt默认值YO1serialNoatt每次操作的序列号M256必须使用在异步操作中标识同一次操作AssetLifetimeelstartDateTimeattO8日期格式

29、：YYYY-MM-DDendDateTimeattO8日期格式：YYYY-MM-DD2.2.2 MetadataAsset定义及分类名称说明是否必选长度（字节）注释AddMetadataAsset,RemoveMetadataAsset,ReplaceMetadataAssetgroupProviderIDatt同groupAsset中的providerIDMgroupAssetIDatt同groupAsset中的assetIDMtypeattMetadataAsset的类型M本规范中定义三种类型，Title、CategoryPath、Copyrightproductatt默认值VODOTit

30、leelMproviderIDatt同groupAsset中的providerIDM assetIDatt资产IDM与groupAsset中的assetID取值相同updateNumatt默认值1MCategoryPathelOproviderIDatt同groupAsset中的providerIDM assetIDatt资产IDM与groupAsset中的assetID取值相同updateNumatt默认值1MCopyrightelOproviderIDatt同groupAsset中的providerIDM assetIDatt资产IDM与groupAsset中的assetID取值相同upd

31、ateNumatt默认值1M其中type分类定义序号Type 取值说明1Title元数据的基本信息2CategoryPath元数据的分类信息3Copyright元数据的版权信息2.2.3 ContentAsset定义分类名称说明是否必选长度（字节）注释AcceptContentAsset,DestroyContentAsset,ReplaceContentAssettypeattContentAsset的类型M本规范中定义类型Image、Video、Audio、PhysicalChannel、Program、AssetProgrammetadataOnlyatt默认值NMfileNameatt

32、实体文件的名称M(如果对应实体文件没有些属性，可不要)fileSizeatt实体文件的的大小M单位byte(如果对应实体文件没有些属性，可不要)mD5CheckSumatt实体文件MD5值M(如果对应实体文件没有些属性，可不要)orderatt子内容的顺序o16数字。子内容生成方式为拆条编辑而来时，代表生成该子内容的拆条在原子内容所有拆条中的顺序Copyrightel子内容的版权Otypeatt版权类型M21：手机版权2：互联网版权3：IPTV版权4：互联网电视版权effectiveTimeatt版权生效时间OYYYY-MM-DDexpireTimeatt版权失效时间OYYYY-MM-DDal

33、lowedAreasatt版权有效区域O255多个区域用逗号分隔其中type分类定义序号Type 取值说明1Video视频实体内容2Audio音频实体内容3PhysicalChannel物理频道实体内容4Program程序实体内容5AssetProgram节目单实体内容6Image图片实体内容7Text文本实体内容8Paragraph段落实体内容（主要用如拆条之类的片段信息）2.2.4 AssociateContent定义分类名称说明是否必选长度（字节）注释AssociateContenttypeattContentAsset的类型M本规范中定义类型Image、Video、Audio、Phys

34、icalChannel、Program、AssetProgrameffectiveDateatt生效日期O暂不处理groupProviderIDatt同groupAsset中的providerIDMgroupAssetIDatt对应groupAsset中的assetIDMproviderIDattCPID，同groupAsset中的providerIDMassetIDatt对应实体内容ContentAsset的assetIDM2.2.5 AssociateGroup定义名称说明是否必选长度（字节）注释AssociateGroupeffectiveDateatt生效日期O暂不处理groupPro

35、viderIDatt对应的groupAsset中的providerIDMproviderIDattCPID，同groupAsset中的providerIDMassetIDatt对应实体内容ContentAsset的assetIDMsourceGroupAssetIDatt原GroupAsset的assetIDM对应所要关联的子组资产的assetIDtargetGroupAssetIDatt目标GroupAsset的assetIDM对应被关联的父组资产的assetID2.2.6 MetadataAsset中元数据分类序号Type 取值说明1Movie电影2Series连续剧3Music音乐4Co

36、lumns电视专栏5Character人物6Information新闻资讯7StaticLink静态链接8Game游戏9Channel节目频道10Schedule节目单11News视频新闻12Column栏目 （与电视专栏区别是，栏目是独立内容，也可作为电视专栏的一期内容）2.2.7 Movie定义c说明是否必选长度（字节）注释TitleAssetLifetimeelstartDateTimeattO暂不处理endDateTimeattO暂不处理TitleFullel电影名称M255ShowTypeel元数据类型：MovieM50电影类型标识SummaryMediumel中文描述O1024Su

37、mmaryShortel看点M1024RunTimeel播放时长（单位:秒）O50CountryOfOriginel国家地区内地=1,港台=2,韩日=3,欧美=4,东南亚=5，其他=99O50Actorel演员O1typeatt类型Actor男主演员、Actress女主演员LastNameFirstel全名255Actor的elDirectorel导演OLastNameFirstel全名255Director的elStudioNameel出品公司O255Ratingel限制类别采用国际通用的 Rating 等级O50Agentel代理公司O255IsAdvertiseel广告内容标识M20：非

38、广告内容; 1：广告内容Languageel语言O50MediaFormatel媒体格式O50MetaLanguageel元数据对应的语言版本O50IptvDescelIPTV简介O1024Formatel制式黑白、彩色O50Superviserel监制O50EnglishDescel英文简介O1024Keywordel关键字多个关键字之间使用逗号分隔O255StarLevelel推荐星级从 110，数字越大推荐星级越高，缺省为 6 ，为 3 颗星O2Tagel标签多个标签之间使用逗号分隔O512Awardsel所含奖项多个奖项之间使用；分隔O255Yearel发行年份（YYYY）O50Com

39、mentsel说明O2000Backgroundel幕后人员O50Priorityel内容的优先级，从1n,数字越大优先级越高O2CategoryPathAssetLifetimeelstartDateTimeattO暂不处理endDateTimeattO暂不处理Categoryel类别分类(多个二级分类以英文逗号,分隔)O256Classificationel一级分类O50CopyrightAssetLifetimeelstartDateTimeatt版权开始时间（YYYY-MM-DD）M50endDateTimeatt版权结束时间（YYYY-MM-DD）M50LicenseType版权类型

40、 0-无 1-有O2OriginalLicenseCompany源版权人O255TransferLicenseCompany转授权人O255Transfer3rd已转授3次及以上 0-否 1-是O2TransferAgain可再授权 0-否 1-是O2CountryNo国家批转文号O255PublicationDateel发布日期(YYYY-MM-DD)O50CopyNameel版权名称O255VideoLicenseel音像制品版号O255PublishNoel发行/公映许可证号O255AuthorserilNoel进口批准文号O255CopyIdeael版权备注O1024CopyTypee

41、l版权内容类型1 影视, 2, 游戏, 3, 信息,4, 音乐,5, 电视剧,6, 星空动漫,7, 电视专栏O2CopyLicenserel授权单位O255CopyLicenseel版权书编号O255CopySerilNoel授权序号O2552.2.8 Series定义1. 电视剧总集的定义名称说明是否必选长度（字节）注释TitleAssetLifetimeelstartDateTimeattO暂不处理endDateTimeattO暂不处理TitleFullel电视剧名称M255EnglishNameel英文名称O255ShowTypeel元数据类型：SeriesM50电视剧类型标识IsAdv

42、ertiseel广告内容标识M20：非广告内容; 1：广告内容SummaryMediumel中文描述O1024SummaryShortel看点M1024RunTimeel播放时长（单位:秒）O50CountryOfOriginel国家地区内地=1,港台=2,韩日=3,欧美=4, 东南亚=5，其他=99O255Actorel演员typeatt类型MActor男主演员、Actress女主演员、CoActor男配角、CoActress女配角LastNameFirstel全名O255Actor的elDirectorel导演LastNameFirstel全名O255Director的elProducer

43、el制作人LastNameFirstel全名O255Producer的elStudioNameel出品公司O255Ratingel限制类别采用国际通用的 Rating 等级O50Agentel代理公司O255Itemsel集数O4IsCompleted是否已经出版完毕O20-仍在出版播出；1-已经出版完毕Languageel语言O50MediaFormatel媒体格式O50MetaLanguageel元数据对应的语言版本O50IptvDescelIPTV简介O1024Formatel制式黑白、彩色O50Superviserel监制O50EnglishDescel英文简介O1024Keyword

44、el关键字多个关键字之间使用逗号分隔O255StarLevelel推荐星级从 110，数字越大推荐星级越高，缺省为 6 ，为 3 颗星O2Tagel标签多个标签之间使用逗号分隔O512Awardsel所含奖项多个奖项之间使用；分隔O255Yearel发行年份（YYYY）O50Commentsel说明O2000Backgroundel幕后人员O50Statusel状态标志0:失效 1:生效M1SearchNameel搜索名称首字母供界面搜索O80Priorityel内容的优先级，从1n,数字越大优先级越高O2CategoryPathAssetLifetimeelstartDateTimeattO

45、暂不处理endDateTimeattO暂不处理Categoryel类别分类(多个二级分类以英文逗号,分隔)O256Classificationel一级分类O50CopyrightAssetLifetimeelstartDateTimeatt版权开始时间（YYYY-MM-DD）M50endDateTimeatt版权结束时间（YYYY-MM-DD）M50LicenseType版权类型 0-无 1-有O2OriginalLicenseCompany源版权人O255TransferLicenseCompany转授权人O255Transfer3rd已转授3次及以上 0-否 1-是O2TransferAg

46、ain可再授权 0-否 1-是O2CountryNo国家批转文号O255PublicationDateel发布日期(YYYY-MM-DD)O50CopyNameel版权名称O255VideoLicenseel音像制品版号O255PublishNoel发行/公映许可证号O255AuthorserilNoel进口批准文号O255CopyIdeael版权备注O1024CopyTypeel版权内容类型1 影视, 2, 游戏, 3, 信息,4, 音乐,5, 电视剧,6, 星空动漫,7, 电视专栏O2CopyLicenserel授权单位O255CopyLicenseel版权书编号O255CopySeril

47、Noel授权序号O2552. 电视剧各集的定义名称说明是否必选长度（字节）注释TitleAssetLifetimeelstartDateTimeattO暂不处理endDateTimeattO暂不处理TitleFullel电视剧单集名称M255EnglishNameel英文名称O255IsAdvertiseel广告内容标识M20：非广告内容; 1：广告内容ShowTypeel元数据类型：SeriesM255电视剧类型标识Tagel标签多个标签之间使用逗号分隔O512MetaLanguageel元数据对应的语言版本O50SummaryMediumel中文描述O1024EpisodeIDel剧集的编

48、号M3RunTimeel播放时长（单位:秒）O50Statusel状态标志0:失效 1:生效M1SearchNameel搜索名称首字母供界面搜索O80Priorityel内容的优先级，从1n,数字越大优先级越高O22.2.9 Music定义名称说明是否必选长度（字节）注释TitleAssetLifetimeelstartDateTimeattO暂不处理endDateTimeattO暂不处理TitleFullel音乐名称M255EnglishNameel英文名称O255ShowTypeel元数据类型：MusicM50音乐类型标识MetaLanguageel元数据对应的语言版本O50IsAdvertiseel广告内容标识M20：非广告内容; 1：广告内容SummaryMediumel中文描述O1024SummaryShortel看点M1024RunTimeel播放时长（单位:秒）O50CountryOfOriginel国家地区内地=1,港台=2,韩日=3,欧美=4, 东南亚=5，其他=99O50Actorel演员O1typeatt类型Actor男主演员、Actress女主演员LastNameFirstel全名255Actor的elD