插件 / AdsProvider 选项
在用户整个生命周期内保持不变的唯一标识(用于再营销与奖励广告)。
本次对话启用的 placement code。默认为 ['inlineAd']。
本次对话的合规对象。
请求是否受 GDPR 约束。(0 = 否,1 = 是,null = 未知)
IAB 透明度与同意框架(TCF)的 consent 字符串。
请求是否受 COPPA 约束。(0 = 否,1 = 是,null = 未知)
Global Privacy Platform (GPP) consent 字符串。
本次请求适用的 GPP section ID 列表。
美国隐私法规(如 CCPA、LSPA)相关的消费者信号。
SDK 内部诊断事件的回调。接收 (name, data?)——在接入期间排查 preload / session 行为时很有用。默认关闭。
useAds() composable
返回 addMessage,一个总是路由到当前会话的转发函数。如果 <AdsProvider> 切换了会话(例如 publisherToken 改变),下一次调用会自动指向新的会话。
(message: Message, options?: AddMessageOptions) => void —— 向 SDK 注册一条新消息。下一次预加载会被自动安排。AddMessageOptions 目前提供一个开关:
当为 true 时,preload 请求仍会发出(用于分析),但本条消息不会展示广告。可用于在不丢失追踪数据的前提下抑制广告。
Message 结构
InlineAd 属性
Onboarding 时提供的 placement code。默认为 'inlineAd'。
Slots
render-prop 形式的具名插槽,允许你用自己的 DOM 结构包裹广告 iframe。插槽接收已渲染的广告作为 ad:
支持的事件
ad.clicked
用户点击了广告。
用户点击的素材区域(例如 'cta'、'banner')。
ad.viewed
用户已查看广告。
ad.filled
有可投放的广告。
ad.no-fill
没有可投放的广告。
ad.render-started
在第一个 token 到达之前触发。
ad.render-completed
在最后一个 token 到达之后触发。
ad.error
出现错误时触发。
video.started
视频开始播放时触发。
video.completed
视频播放完成时触发。
reward.granted
激励广告向用户发放奖励时触发。