ORTB
…
SIMID 分册导航

SIMID 1.0 → 1.2

SIMID 四个版本的消息、参数、响应、错误码与章节结构对照。跨版本按「命名空间 + 事件名」对齐,因此官方的改名(如 requestFullScreen → requestFullscreen)记为改名而非删除新增。

41 msg · 36 err · 3 enum · 71 sections

本页目录

消息矩阵

● 表示该版有此消息;单元格下方列出该版内的章节号与参数数量。

条目1.2.01.1.01.0.11.0.0
SIMID:Creative:clickThru● §4.4.16 args● §4.4.16 args● §4.4.12 args● §4.4.12 args
SIMID:Creative:collapseNonlinear● §4.4.20 args● §4.4.20 args——
SIMID:Creative:expandNonlinear● §4.4.35 args● §4.4.35 args——
SIMID:Creative:fatalError● §4.4.42 args● §4.4.42 args● §4.4.22 args● §4.4.22 args
SIMID:Creative:getMediaState● §4.4.58 args● §4.4.58 args● §4.4.38 args—
SIMID:Creative:getVideoState———● §4.4.30 args
SIMID:Creative:log● §4.4.61 args● §4.4.61 args● §4.4.41 args● §4.4.41 args
SIMID:Creative:reportTracking● §4.4.73 args● §4.4.73 args● §4.4.53 args● §4.4.52 args
SIMID:Creative:requestChangeAdDuration● §4.4.81 args● §4.4.81 args● §4.4.61 args● §4.4.61 args
SIMID:Creative:requestChangeVolume● §4.4.92 args● §4.4.92 args● §4.4.72 args● §4.4.70 args
SIMID:Creative:requestExitFullscreen● §4.4.110 args● §4.4.110 args● §4.4.90 args● §4.4.90 args
SIMID:Creative:requestFullscreen● §4.4.100 args● §4.4.100 args● §4.4.80 args● §4.4.80 args
SIMID:Creative:requestNavigation● §4.4.121 args● §4.4.121 args——
SIMID:Creative:requestPause● §4.4.130 args● §4.4.130 args● §4.4.100 args● §4.4.100 args
SIMID:Creative:requestPlay● §4.4.140 args● §4.4.140 args● §4.4.110 args● §4.4.110 args
SIMID:Creative:requestResize● §4.4.1510 args● §4.4.1510 args● §4.4.1210 args● §4.4.120 args
SIMID:Creative:requestSkip● §4.4.160 args● §4.4.160 args● §4.4.130 args● §4.4.130 args
SIMID:Creative:requestStop● §4.4.170 args● §4.4.170 args● §4.4.140 args● §4.4.140 args
SIMID:Media:durationchange● §4.2.11 args● §4.2.11 args● §4.2.11 args● §4.2.11 args
SIMID:Media:ended● §4.2.20 args● §4.2.20 args● §4.2.20 args● §4.2.20 args
SIMID:Media:error● §4.2.32 args● §4.2.32 args● §4.2.32 args● §4.2.32 args
SIMID:Media:pause● §4.2.40 args● §4.2.40 args● §4.2.40 args● §4.2.40 args
SIMID:Media:play● §4.2.50 args● §4.2.50 args● §4.2.50 args● §4.2.50 args
SIMID:Media:playing● §4.2.60 args● §4.2.60 args● §4.2.60 args● §4.2.60 args
SIMID:Media:seeked● §4.2.70 args● §4.2.70 args● §4.2.70 args● §4.2.70 args
SIMID:Media:seeking● §4.2.80 args● §4.2.80 args● §4.2.80 args● §4.2.80 args
SIMID:Media:stalled● §4.2.90 args● §4.2.90 args● §4.2.90 args● §4.2.90 args
SIMID:Media:timeupdate● §4.2.101 args● §4.2.101 args● §4.2.101 args● §4.2.101 args
SIMID:Media:volumechange● §4.2.112 args● §4.2.112 args● §4.2.112 args● §4.2.111 args
SIMID:Player:adSkipped● §4.3.10 args● §4.3.10 args● §4.3.10 args● §4.3.10 args
SIMID:Player:adStopped● §4.3.21 args● §4.3.21 args● §4.3.21 args● §4.3.21 args
SIMID:Player:appBackgrounded● §4.3.30 args● §4.3.30 args● §4.3.30 args—
SIMID:Player:appBackgrounding———● §4.3.30 args
SIMID:Player:appForegrounded● §4.3.40 args● §4.3.40 args● §4.3.40 args—
SIMID:Player:appForegrounding———● §4.3.40 args
SIMID:Player:collapseNonlinear● §4.3.50 args● §4.3.50 args——
SIMID:Player:fatalError● §4.3.62 args● §4.3.62 args● §4.3.52 args● §4.3.50 args
SIMID:Player:init● §4.3.731 args● §4.3.731 args● §4.3.627 args● §4.3.625 args
SIMID:Player:log● §4.3.81 args● §4.3.81 args● §4.3.71 args● §4.3.71 args
SIMID:Player:resize● §4.3.911 args● §4.3.911 args● §4.3.811 args● §4.3.811 args
SIMID:Player:startCreative● §4.3.102 args● §4.3.102 args● §4.3.92 args● §4.3.90 args

消息变更时间线

按版本倒序,只列结构性变化(新增 / 改名 / 参数与响应变更)。

条目生效版本变化内容
SIMID:Creative:clickThru1.0.0新增消息SIMID:Creative:clickThru
SIMID:Creative:clickThru1.0.1参数新增x:short, y:short
SIMID:Creative:clickThru1.0.1参数移除x:int, y:int
SIMID:Creative:clickThru1.0.1参数写法变更prose-list → webidl
SIMID:Creative:clickThru1.1.0参数新增playerHandles:boolean, url:DOMString, errorCode:short, reason:DOMString
SIMID:Creative:clickThru1.1.0响应变更无响应 → resolve+reject
SIMID:Creative:collapseNonlinear1.1.0新增消息SIMID:Creative:collapseNonlinear
SIMID:Creative:expandNonlinear1.1.0新增消息SIMID:Creative:expandNonlinear
SIMID:Creative:fatalError1.0.0新增消息SIMID:Creative:fatalError
SIMID:Creative:fatalError1.0.1参数新增errorCode:unsigned short
SIMID:Creative:fatalError1.0.1参数移除errorCode:int
SIMID:Creative:fatalError1.0.1参数写法变更prose-list → webidl
SIMID:Creative:getMediaState1.0.1新增消息SIMID:Creative:getMediaState
SIMID:Creative:getVideoState1.0.0新增消息SIMID:Creative:getVideoState
SIMID:Creative:getVideoState1.0.1移除消息SIMID:Creative:getVideoState
SIMID:Creative:getVideoState1.1.0移除消息SIMID:Creative:getVideoState
SIMID:Creative:getVideoState1.2.0移除消息SIMID:Creative:getVideoState
SIMID:Creative:log1.0.0新增消息SIMID:Creative:log
SIMID:Creative:log1.0.1转为必选message
SIMID:Creative:log1.0.1参数写法变更prose-list → webidl
SIMID:Creative:reportTracking1.0.0新增消息SIMID:Creative:reportTracking
SIMID:Creative:reportTracking1.0.1参数新增trackingUrls:Array, errorCode:unsigned short
SIMID:Creative:reportTracking1.0.1参数移除errorCode:int
SIMID:Creative:reportTracking1.0.1参数写法变更none → webidl
SIMID:Creative:requestChangeAdDuration1.0.0新增消息SIMID:Creative:requestChangeAdDuration
SIMID:Creative:requestChangeAdDuration1.0.1参数新增duration:float
SIMID:Creative:requestChangeAdDuration1.0.1参数移除duration:int
SIMID:Creative:requestChangeAdDuration1.0.1参数写法变更prose-list → webidl
SIMID:Creative:requestChangeVolume1.0.0新增消息SIMID:Creative:requestChangeVolume
SIMID:Creative:requestChangeVolume1.0.1参数新增volume:float, muted:boolean
SIMID:Creative:requestChangeVolume1.0.1参数写法变更none → webidl
SIMID:Creative:requestExitFullscreen(旧:SIMID:Creative:requestExitFullScreen)1.0.0新增消息SIMID:Creative:requestExitFullScreen
SIMID:Creative:requestExitFullscreen(旧:SIMID:Creative:requestExitFullScreen)1.0.1改名SIMID:Creative:requestExitFullScreen → SIMID:Creative:requestExitFullscreen
SIMID:Creative:requestFullscreen(旧:SIMID:Creative:requestFullScreen)1.0.0新增消息SIMID:Creative:requestFullScreen
SIMID:Creative:requestFullscreen(旧:SIMID:Creative:requestFullScreen)1.0.1改名SIMID:Creative:requestFullScreen → SIMID:Creative:requestFullscreen
SIMID:Creative:requestNavigation1.1.0新增消息SIMID:Creative:requestNavigation
SIMID:Creative:requestPause1.0.0新增消息SIMID:Creative:requestPause
SIMID:Creative:requestPlay1.0.0新增消息SIMID:Creative:requestPlay
SIMID:Creative:requestResize1.0.0新增消息SIMID:Creative:requestResize
SIMID:Creative:requestResize1.0.1参数新增mediaDimensions:Dimensions, mediaDimensions.x:long, mediaDimensions.y:long, mediaDimensions.width:long, mediaDimensions.height:long, creativeDimensions:Dimensions, creativeDimensions.x:long, creativeDimensions.y:long, creativeDimensions.width:long, creativeDimensions.height:long
SIMID:Creative:requestResize1.0.1参数写法变更none → webidl
SIMID:Creative:requestSkip1.0.0新增消息SIMID:Creative:requestSkip
SIMID:Creative:requestStop1.0.0新增消息SIMID:Creative:requestStop
SIMID:Media:durationchange1.0.0新增消息SIMID:Media:durationchange
SIMID:Media:durationchange1.0.1转为必选duration
SIMID:Media:durationchange1.0.1参数写法变更prose-list → webidl
SIMID:Media:ended1.0.0新增消息SIMID:Media:ended
SIMID:Media:error1.0.0新增消息SIMID:Media:error
SIMID:Media:error1.0.1参数新增error:unsigned short
SIMID:Media:error1.0.1参数移除error:DOMString
SIMID:Media:error1.0.1参数写法变更prose-list → webidl
SIMID:Media:pause1.0.0新增消息SIMID:Media:pause
SIMID:Media:play1.0.0新增消息SIMID:Media:play
SIMID:Media:playing1.0.0新增消息SIMID:Media:playing
SIMID:Media:seeked1.0.0新增消息SIMID:Media:seeked
SIMID:Media:seeking1.0.0新增消息SIMID:Media:seeking
SIMID:Media:stalled1.0.0新增消息SIMID:Media:stalled
SIMID:Media:timeupdate1.0.0新增消息SIMID:Media:timeupdate
SIMID:Media:timeupdate1.0.1参数新增currentTime:float
SIMID:Media:timeupdate1.0.1参数移除currentTime:number
SIMID:Media:timeupdate1.0.1参数写法变更prose-list → webidl
SIMID:Media:volumechange1.0.0新增消息SIMID:Media:volumechange
SIMID:Media:volumechange1.0.1参数新增volume:float, muted:boolean
SIMID:Media:volumechange1.0.1参数移除volume:number
SIMID:Media:volumechange1.0.1参数写法变更prose-list → webidl
SIMID:Player:adSkipped1.0.0新增消息SIMID:Player:adSkipped
SIMID:Player:adStopped1.0.0新增消息SIMID:Player:adStopped
SIMID:Player:adStopped1.0.1参数新增code:unsigned short
SIMID:Player:adStopped1.0.1参数移除code:int
SIMID:Player:adStopped1.0.1参数写法变更prose-list → webidl
SIMID:Player:appBackgrounded1.0.1新增消息SIMID:Player:appBackgrounded
SIMID:Player:appBackgrounding1.0.0新增消息SIMID:Player:appBackgrounding
SIMID:Player:appBackgrounding1.0.1移除消息SIMID:Player:appBackgrounding
SIMID:Player:appBackgrounding1.1.0移除消息SIMID:Player:appBackgrounding
SIMID:Player:appBackgrounding1.2.0移除消息SIMID:Player:appBackgrounding
SIMID:Player:appForegrounded1.0.1新增消息SIMID:Player:appForegrounded
SIMID:Player:appForegrounding1.0.0新增消息SIMID:Player:appForegrounding
SIMID:Player:appForegrounding1.0.1移除消息SIMID:Player:appForegrounding
SIMID:Player:appForegrounding1.1.0移除消息SIMID:Player:appForegrounding
SIMID:Player:appForegrounding1.2.0移除消息SIMID:Player:appForegrounding
SIMID:Player:collapseNonlinear1.1.0新增消息SIMID:Player:collapseNonlinear
SIMID:Player:fatalError1.0.0新增消息SIMID:Player:fatalError
SIMID:Player:fatalError1.0.1参数新增errorCode:unsigned short, errorMessage:DOMString
SIMID:Player:fatalError1.0.1参数写法变更none → webidl
SIMID:Player:init1.0.0新增消息SIMID:Player:init
SIMID:Player:init1.0.1参数新增environmentData.videoDimensions:Dimensions, environmentData.creativeDimensions:Dimensions, environmentData.fullscreen:boolean, errorCode:unsigned short, reason:DOMString
SIMID:Player:init1.0.1参数移除environmentData.videoDimensions:VideoDimensions, environmentData.creativeDimensions:CreativeDimensions, environmentData.fullScreen:boolean
SIMID:Player:init1.1.0参数新增environmentData.skipoffset:DOMString, environmentData.navigationSupport:NavigationSupport, environmentData.closeButtonSupport:CloseButtonSupport, environmentData.nonlinearDuration:float
SIMID:Player:log1.0.0新增消息SIMID:Player:log
SIMID:Player:log1.0.1转为必选message
SIMID:Player:log1.0.1参数写法变更prose-list → webidl
SIMID:Player:resize1.0.0新增消息SIMID:Player:resize
SIMID:Player:resize1.0.1参数新增videoDimensions:Dimensions, creativeDimensions:Dimensions, fullscreen:boolean
SIMID:Player:resize1.0.1参数移除videoDimensions:VideoDimensions, creativeDimensions:CreativeDimensions, fullScreen:boolean
SIMID:Player:startCreative1.0.0新增消息SIMID:Player:startCreative
SIMID:Player:startCreative1.0.1参数新增errorCode:unsigned short, reason:DOMString

Message 结构对照

五个成员自 1.0.1 起保持稳定。

成员1.2.01.1.01.0.11.0.0
sessionId:DOMString!●●●●
messageId:unsigned long!●●●●
timestamp:unsigned long!●●●●
type:DOMString!●●●●
args:any●●●●

枚举对照

NavigationSupport 与 CloseButtonSupport 自 1.1.0 出现(非线性与导航能力需要显式协商)。

枚举1.2.01.1.01.0.11.0.0
SkippableStateplayerHandles, adHandles, notSkippableplayerHandles, adHandles, notSkippableplayerHandles, adHandles, notSkippableplayerHandles, adHandles, notSkippable
NavigationSupportadHandles, playerHandles, notSupportedadHandles, playerHandles, notSupported——
CloseButtonSupportadHandles, playerHandlesadHandles, playerHandles——

错误码增长

1.0 只有 12 个错误码,1.0.1 扩到 26 个,1.1.0 与 1.2.0 为 36 个。

错误码类型1.2.01.1.01.0.11.0.0
1100Unspecified error.●●●●
1101Resources could not be loaded.●●●●
1102Playback area not usable by creative.●●●●
1103Wrong SIMID version.●●●●
1104Creative not playable for a technical reason on this site.●●●●
1105Request for expand not honored.●●●●
1106Request for pause not honored.●●●●
1107Play mode not adequate for creative.●●●●
1108Ad internal error.●●●●
1109Device not supported.●●●●
1110The player is not following the spec in the way it sends messages.●●●●
1111The player is not responding adequately to messages.●●●●
1200Unspecified error.●●●—
1201Wrong SIMID version.●●●—
1202The creative is requesting more time than the player is willing to support.●●●—
1203The creative is requesting more functionality than the player is willing to support.●●●—
1204The creative is doing actions not supported on this site.●●●—
1205The creative is overloading the postmessage channel.●●●—
1206The SIMID media could not be loaded.●●●—
1207Media Timeout.●●●—
1208The creative is taking too long to resolve or reject messages.●●●—
1209The SIMID media from the VAST response is not supported on this device.●●●—
1210The creative is not following the spec when initializing.●●●—
1211The creative is not following the spec in the way it sends messages.●●●—
1212The creative did not reply to the § 4.3.7 SIMID:Player:init message.●●●—
1213The creative did not reply to the § 4.3.10 SIMID:Player:startCreativemes sage.●●●—
1214Environment does not support navigation.●●——
1215Navigation not possible at all on this device.●●——
1216Too many calls to § 4.4.12 SIMID:Creative:requestNavigation.●●——
1217Invalid navigation request URL.●●——
1218Invalid navigation request app.●●——
1219Extra clickthrough blocked.●●——
1220Nonlinear expasion not possible due to problem pausing the media.●●——
1221Nonlinear expansion rejected by user.●●——
1222Player received excessive number of § 4.4.3 SIMID:Creative:expandNonline armessages.●●——
1223Session not created.●●——

章节结构对照

编号跨版会漂移(如 1.0.1 的 Player:init 在 §4.3.6、1.1.0 起在 §4.3.7),对照按标题定位、把每版编号一并列出。

条目1.2.01.1.01.0.11.0.0
Ad Completes at Media Completion6.9.46.9.46.8.4—
Ad Completes at Video Completion———6.3.4
Ad Duration Changed Workflow6.106.106.9—
Ad Duration Changed Workflow - Known Time6.10.26.10.26.9.2—
Ad Duration Changed Workflow - Unknown Time6.10.36.10.36.9.3—
Ad Ends Before Media Completion6.9.36.9.36.8.3—
Ad Ends Before Video Completion———6.3.2
Ad Errors Out6.9.56.9.56.8.56.3.5
Ad Extends Beyond Media Completion6.10.16.10.16.9.1—
Ad Extends Beyond Video Completion———6.3.3
Ad Pause6.8.16.8.16.7.16.2.1
Ad Requests Stop6.9.66.9.66.8.6—
Ad Resizing and Fullscreen6.8.26.8.26.7.26.2.2
Ad Skips———6.3.1
Additional Notes———6.3.7
API Reference4444
Audio Only in a Web Player3.4———
Changes In SIMID 1.1—2.3——
Changes In SIMID 1.22.3———
Common Workflows6666
Conformance———
Creative Delays Resolving Init6.56.56.5—
Creative Rejects Init6.66.66.6—
Creative Skips Ad6.9.26.9.26.8.2—
Data Layer8.18.18.1—
Data Structure8.1.18.1.18.1.1—
Error Codes9998.4
Error Handling and Timeouts7777
Establishing a New Session8.4.18.4.18.4.18.2.1
Executive Summary2222
How to Handle Ad End and Unload6.96.96.86.3
How to Handle Ad Loading6.16.16.16.1
How to Handle Ad Playback6.86.86.76.2
Intended Audience2.22.22.22.2
Introduction3333
Introduction to Nonlinear Ads3.63.5——
L-Shaped Ads (L Squeeze backs)3.6.1———
Message Data Structure———8.3
Message Serialization8.3.28.3.28.3.28.1.2
Messages Categories8.28.28.2—
Messages from the Creative to the Player4.44.44.44.4
Messages from the player4.34.34.34.3
Messages Triggered by Media Element Events4.24.24.24.2
Messaging Protocol8888
Nonlinear Ads VAST Response3.6.23.5.1——
Nonlinear Initialization and Start WorkFlow6.76.7——
Player and Creative Communication3.33.33.33.3
Player Skips Ad6.9.16.9.16.8.1—
postMessage Transport8.3.18.3.18.3.18.1.1
Privacy Compliance3.5.1———
Receiving messages———8.2.3
Reference Table4.14.14.14.1
References———
Referencing a SIMID creative from VAST5555
reject Messages8.2.28.2.28.2.28.3.2
resolve Messages8.2.18.2.18.2.18.3.1
Scope and Limitation———3.4
Scope and Limitations3.53.43.4—
Sending messages———8.2.2
Session Establishing Delays and Failures8.4.28.4.28.4.2—
Session Layer8.48.48.48.2
SIMID Ad Serving Flow3.23.23.23.2
SIMID Interactive Creative Nature3.13.13.13.1
SIMID vs. VPAID Comparison2.12.12.12.1
Terminology1010109
Transport Layer8.38.38.38.1
Typical Initialization WorkFlow6.26.26.2—
Typical Start Creative WorkFlow6.36.36.3—
Uninterrupted Initialization WorkFlow6.46.46.4—
User Experience6.116.116.106.3.6
Version1111