# 推荐流游戏直出能力（选接）

推荐流游戏直出能力（即直玩能力）是一种通过游戏内的关键信息，在抖音推荐流提醒用户别错过关键信息的触达能力。

以游戏内的高价值信息为深度玩家的召回抓手，使用游戏进程中的不同场景掉落的重点信息进行触达召回；
通过预加载能力，实现抖音推荐流无缝进入游戏的体验，将预加载完成的游戏在推荐流中分发给符合条件的用户。

有关推荐流游戏直出能力的更多内容，如应用实例、数据效果、自助接入指引，以及游戏画布设计规范等，请自行阅读《推荐流游戏直出能力》 (opens new window)，本文档不做赘述：

# 查询直玩订阅状态

# 接口说明

用于查询用户直玩订阅的授权状态。

sdkInstance.checkFeedSubscribeStatus(options);

最低基础库版本要求

若用户客户端基础库版本低于 3.34.0，调用 sdkInstance.checkFeedSubscribeStatus(options) 接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！

注意事项

直玩订阅能力仅支持抖音、抖音Lite，且必须在登录后才能调用；本接口存在频控限制，需要注意调用场景和频率。

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
type	string	是	--	订阅Feed流的类型，目前仅支持 `play` 直玩场景
allScene	boolean	否	false	是否为全场景订阅
scene	number	否	--	订阅的场景ID（非全场景下必传） `1` - 离线收益场景 `2` - 体力恢复场景 `3` - 重要事件掉落
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回查询结果，接口调用失败时返回 `null`
data.status	boolean	为 `true` 时表示已经订阅，为 `false` 时表示尚未订阅
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 若用户客户端基础库版本低于 3.34.0，调用此接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.checkFeedSubscribeStatus({
  type: "play",
  scene: 1,
  success: function(response) {
    console.log(response.data.status); // 是否已经订阅：true 表示已经订阅，false 表示尚未订阅
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

# 直玩订阅

# 接口说明

用于向用户请求授权，允许游戏在满足一定的条件后出现在Feed流中。

sdkInstance.subscribeFeedMessage(options);

最低基础库版本要求

若用户客户端基础库版本低于 3.34.0，调用 sdkInstance.subscribeFeedMessage(options) 接口将中断用户当前操作并弹出升级提示，不会报错！

注意事项

直玩订阅能力仅支持抖音、抖音Lite，且必须在登录后才能调用；本接口存在频控限制，需要注意调用场景和频率。

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
type	string	是	--	订阅Feed流的类型，目前仅支持 `play` 直玩场景
allScene	boolean	否	false	是否为全场景订阅
scene	number	否	--	订阅的场景ID（非全场景下必传） `1` - 离线收益场景 `2` - 体力恢复场景 `3` - 重要事件掉落
contentIds	string[]	否	--	自定义提醒文案的 `contentId` 数组（非全场景下必传）；`contentId` 在抖音开放平台控制台申请开通直玩能力后可获取
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回订阅结果，接口调用失败时返回 `null`
data.success	boolean	为 `true` 时表示订阅成功，为 `false` 时表示订阅失败
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 若用户客户端基础库版本低于 3.34.0，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
sdkInstance.subscribeFeedMessage({
  type: "play",
  scene: 1,
  contentIds: ["CONTENT12345678", "CONTENT23456789"],
  success: function(response) {
    console.log(response.data.success); // 是否订阅成功：true 表示订阅成功，false 表示订阅失败
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

# 监听进入/退出小游戏事件

# 接口说明

用于监听Feed流进入/退出小游戏事件，仅限推荐流游戏直出场景。

sdkInstance.onFeedStatusChange(callback);

最低基础库版本要求

若用户客户端基础库版本低于 3.59.0，调用 sdkInstance.onFeedStatusChange(callback) 接口将直接触发回调函数，并返回失败信息，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！

注意事项

直玩订阅能力仅支持抖音、抖音Lite。

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
callback	function	是	--	事件回调函数

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回事件结果，接口调用失败时返回 `null`
data.type	string	为 `feedEnter` 时表示从Feed流进入小游戏，为 `feedExit` 时表示退出小游戏回到Feed流
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 若用户客户端基础库版本低于 3.59.0，调用此接口将直接触发回调函数，并返回失败信息，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.onFeedStatusChange(function(response) {
  // code 非 0 时表示接口调用失败
  if (response.data.code !== 0) {
    return;
  }

  console.log(response.data.type); // 动作类型：feedEnter 表示从Feed流进入小游戏，feedExit 表示退出小游戏回到Feed流
});

# 取消监听进入/退出小游戏事件

# 接口说明

用于取消监听Feed流进入/退出小游戏事件，仅限推荐流游戏直出场景。

sdkInstance.offFeedStatusChange(callback);

最低基础库版本要求

若用户客户端基础库版本低于 3.59.0，调用 sdkInstance.offFeedStatusChange(callback) 接口将直接触发回调函数，并返回失败信息，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！

注意事项

直玩订阅能力仅支持抖音、抖音Lite。

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
callback	function	是	--	通过 `onFeedStatusChange` 绑定的事件回调函数

# 返回值说明

无

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 定义事件回调函数
const feedStatusChangeCallback = function(response) {
  // code 非 0 时表示接口调用失败
  if (response.data.code !== 0) {
    return;
  }

  console.log(response.data.type); // 动作类型：feedEnter 表示从Feed流进入小游戏，feedExit 表示退出小游戏回到Feed流
};

// 若用户客户端基础库版本低于 3.59.0，调用下述接口将直接触发回调函数，并返回失败信息，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.onFeedStatusChange(feedStatusChangeCallback); // 注册事件监听
sdkInstance.offFeedStatusChange(feedStatusChangeCallback); // 取消事件监听

← 添加到桌面（选接）订阅消息（选接） →