API 参考

插件 / `AdsProvider` 选项

string

必填

你的 publisher token。

string

必填

在用户整个生命周期内保持不变的唯一标识（用于再营销与奖励广告）。

string

用户邮箱。

string

必填

对话的唯一 ID。

array

本次对话启用的 placement code。默认为 ['inlineAd']。

object

本次对话使用的 character 对象。

显示字段

string

必填

角色的唯一 ID。

string

必填

角色名称。

string

必填

角色头像 URL。

boolean

标识该角色是否面向成人受众。

string

角色的问候语。

string

角色性格的简要描述。

array

描述角色的标签。

object

本次对话的合规对象。

显示字段

请求是否受 GDPR 约束。（0 = 否，1 = 是，null = 未知）

IAB 透明度与同意框架（TCF）的 consent 字符串。

integer

请求是否受 COPPA 约束。（0 = 否，1 = 是，null = 未知）

string

Global Privacy Platform (GPP) consent 字符串。

array

本次请求适用的 GPP section ID 列表。

string

美国隐私法规（如 CCPA、LSPA）相关的消费者信号。

string

发布方提供的用户分群标识（用于 A/B 测试）。

function

事件发生时的回调。详见下方”支持的事件”章节。

function

SDK 内部诊断事件的回调。接收 (name, data?)——在接入期间排查 preload / session 行为时很有用。默认关闭。

`useAds()` composable

返回 addMessage，一个总是路由到当前会话的转发函数。如果 <AdsProvider> 切换了会话（例如 publisherToken 改变），下一次调用会自动指向新的会话。

function

必填

(message: Message, options?: AddMessageOptions) => void —— 向 SDK 注册一条新消息。下一次预加载会被自动安排。AddMessageOptions 目前提供一个开关：

显示 AddMessageOptions

boolean

当为 true 时，preload 请求仍会发出（用于分析），但本条消息不会展示广告。可用于在不丢失追踪数据的前提下抑制广告。

`Message` 结构

string

必填

消息的唯一 ID。

string

必填

消息角色（user 或 assistant）。

string

必填

消息文本。

Date

必填

消息创建时间戳。

`InlineAd` 属性

string

必填

本广告所属消息的唯一 ID。

string

Onboarding 时提供的 placement code。默认为 'inlineAd'。

string

广告主题，例如 light 或 dark。

Slots

slot

render-prop 形式的具名插槽，允许你用自己的 DOM 结构包裹广告 iframe。插槽接收已渲染的广告作为 ad：

<InlineAd :messageId="m.id">
  <template #wrapper="{ ad }">
    <div class="my-ad-card">{{ ad }}</div>
  </template>
</InlineAd>

支持的事件

`ad.clicked`

用户点击了广告。

显示 Payload

string

广告 ID。

string

生成的广告内容。

string

消息 ID。

string

点击跳转的 URL。

string

广告形式。

string

用户点击的素材区域（例如 'cta'、'banner'）。

`ad.viewed`

用户已查看广告。

显示 Payload

string

广告 ID。

string

生成的广告内容。

string

消息 ID。

string

广告形式。

number

广告收入（美元计的 eCPM）。

`ad.filled`

有可投放的广告。

显示 Payload

string

广告 ID。

string

与该广告匹配的 placement code。

number

广告收入（美元计的 eCPM）。

`ad.no-fill`

没有可投放的广告。

显示 Payload

string

指示广告被跳过原因的代码。

`ad.render-started`

在第一个 token 到达之前触发。

显示 Payload

string

广告 ID。

`ad.render-completed`

在最后一个 token 到达之后触发。

显示 Payload

string

广告 ID。

`ad.error`

出现错误时触发。

显示 Payload

string

错误信息。

string

错误代码。

`video.started`

视频开始播放时触发。

显示 Payload

string

广告 ID。

`video.completed`

视频播放完成时触发。

显示 Payload

string

广告 ID。

`reward.granted`

激励广告向用户发放奖励时触发。

显示 Payload

string

广告 ID。

入门

核心概念

实践指南

SDK

资源

插件 / `AdsProvider` 选项

`useAds()` composable

`Message` 结构

`InlineAd` 属性

Slots

支持的事件

`ad.clicked`

`ad.viewed`

`ad.filled`

`ad.no-fill`

`ad.render-started`

`ad.render-completed`

`ad.error`

`video.started`

`video.completed`

`reward.granted`

​插件 / AdsProvider 选项

​useAds() composable

​Message 结构

​InlineAd 属性

​Slots

​支持的事件

​ad.clicked

​ad.viewed

​ad.filled

​ad.no-fill

​ad.render-started

​ad.render-completed

​ad.error

​video.started

​video.completed

​reward.granted

插件 / `AdsProvider` 选项

`useAds()` composable

`Message` 结构

`InlineAd` 属性

Slots

支持的事件

`ad.clicked`

`ad.viewed`

`ad.filled`

`ad.no-fill`

`ad.render-started`

`ad.render-completed`

`ad.error`

`video.started`

`video.completed`

`reward.granted`