我们正在准备 React SDK 的 v4 版本。下方文档对应当前正式版本——一旦 v4 发布,本页会同步更新。
React Demo 项目
看看用我们轻量的 SDK 接入高性能广告有多简单。
环境要求
- React:18.3.1 或更高版本
快速开始
1. 安装
在开始之前,你需要先建立一个 发布方账号 来获取
publisherToken 和 code。2. 初始化 AdsProvider
AdsProvider 负责所有数据获取逻辑,必须能访问到聊天消息。请把它放在组件树的足够上层,以包含所有的广告位。
3. 展示你的第一个广告
广告位(ad slot)是 UI 中专门用来渲染广告的区域,通常出现在聊天消息下方。Onboarding 时,你会拿到每个广告位的唯一code。
把 <InlineAd /> 放在希望广告出现的位置,并为 messageId 传入唯一标识。例如,在 MessageList 组件中,可以在每条消息后渲染一个广告(由于每条消息的 messageId 不同,展示的广告也会各自独立)。
API 文档
AdsProvider 属性
InlineAd 属性
支持的事件
ad.clicked
用户点击了广告。
ad.viewed
用户已查看广告。
ad.filled
有可投放的广告。
ad.no-fill
没有可投放的广告。
ad.render-started
在第一个 token 到达之前触发。
ad.render-completed
在最后一个 token 到达之后触发。
ad.error
出现错误时触发。
video.started
视频开始播放时触发。
video.completed
视频播放完成时触发。
实践指南
控制广告加载时机
你可以通过控制何时把新的messages 传入 AdsProvider 来微调广告频率,从而动态调整广告与消息的比例。
处理 no-fill 事件
可以通过onEvent 回调感知广告何时不可用。