描述

本版块将那些支持播放视频获取奖励的小游戏平台，统一封装成一个可调起视频的接口showVideo，调用后会播放视频；并根据实际播放结果触发相对应的回调。调用后可能出现无法拉取视频的情况，可根据下文提到的查看研发自测栏确认问题并解决。

事件名	是否支持	上报时机
video_click	是	点击视频点时，播放视频前。
video_play	是	视频开始播放时（或视频关闭时）。
video_success	是	视频播放结束时。
video_fail	是	视频中途关闭时，给出完整的 markdown 内容。

以下是对传入的参数对象内的属性详细说明：

• name
• show 视频播放时执行并返回当前播放的广告的 id
• success 视频播放结束并关闭后执行，返回刚刚播放的视频的 id，可在本回调内发放奖励
• fail 视频中途（倒计时结束前）关闭时执行
• error 视频拉取错误时触发
• video_param 自定义视频点参数，只有在需求方明确说明需要该参数时才传入
• video_param1 自定义视频点参数 1，只有在需求方明确说明需要该参数时才传入
• video_param2 自定义视频点参数 2，只有在需求方明确说明需要该参数时才传入

接入说明

WARNING

💡 视频未填充时，提示文本为：视频未拉取到，请稍后再试

💡 视频中途退出 提示文本为：视频未完整播放

请在需要展示视频时直接调用GameHelper.AdsFunc.showVideo并传入参数即可。

开发建议

游戏内有背景音乐时，建议在调用 showVideo 接口时暂停背景音，在 success、fail、error 回调中恢复背景音，如果不手动关闭，可能出现关闭视频后背景音效停止的问题。

video_show 事件（选接）

视频事件中，有一个名为 video_show 的事件，统计视频点按钮的展示次数，由于与游戏内的 UI 逻辑相关，若市场方提出需要对该事件进行统计时，请在游戏内视频点按钮每次展示时调用以下方法埋点：

// videoName未视频点名称，与调用GameHelper.AdsFunc.showVideo内的name属性一致
GameHelper.GameStatistics.ShowVideo(videoName);

研发自测

正常情况下，视频成功创建的 log 如下：

• 是否配置了延迟展示时间，log 内容中最后的数字表示延迟时间； 视频日延迟时间：每次调用播放接口时检测当日在线时长是否满足延迟时间，不满足则不展示； 视频延迟时间：累积总在线时长（重启游戏后继续计时），满足该时长才会展示；

• 在保证视频广告 id 正确的情况下，无法出现视频时一般会触发视频错误监听，可在控制台 log 中检索关键字，根据错误码做对应处理，错误码见文档末尾；
• 若未检测到上面的错误监听信息，则表示广告调用创建接口后无响应；目前在广告 ID 填错时会出现该情况，可找发布方和 id 配置方确认广告 id 是否正确。

接口索引

方法

调用后正常情况下会播放一个视频，若未拉到视频广告会弹出一个拉取失败的提示；

参数	类型	默认值	是否必填	说明
opt	videoParams	/	是	初始化参数对象

videoParams

参数	类型	默认值	是否必填	说明
name	string	/	是	视频点名称，用于 video_click、video_show 等视频事件的属性上报
show	(res) => {}	/	否	视频播放时执行，会返回当前使用的广告 ID
success	(res) => {}	/	是	视频播放结束时执行，可在该回调内执行奖励逻辑，会返回当前使用的广告 ID
fail	function	/	否	视频播放中途（倒计时结束前）关闭时执行的回调
error	function	/	否	视频获取失败时执行的回调
eventProperties	VIDEO_EVENT_PROPERTY	/	否	自定义视频事件属性对象

VIDEO_EVENT_PROPERTY

参数	类型	是否必填	说明
video_param	string	否	自定义的字符串类型的属性参数
video_param1
video_param2
video_param3
video_param4
video_type	number	否	自定义的数字类型的属性参数
video_type1
video_type2
video_type3
video_type4

GameHelper.AdsFunc.showVideo({
  name: "tool1",
  show: (res) => {
    console.log("视频开始播放,当前播放的视频id是", res.id);
  },
  success: (res) => {
    console.log("视频播放回调res：", res.id);
  },
  fail: () => {
    GameHelper.CCComFun.showToast({ title: "视频中途关闭" });
  },
  error: () => {
    console.log("视频获取失败");
  },
  eventProperties: {
    video_param: "videoParamTest",
    video_param1: "videoParamTest1",
    video_param2: "videoParamTest2",
    video_type: 20,
    video_type1: 0,
  },
});