抖音开放平台Logo
开发者文档
控制台

互动数据履约上报

收藏
我的收藏
直播玩法开发者可通过平台服务端或 UnitySDK 获取用户在直播间的送礼、点赞、评论等行为数据,这些数据被称为“推送数据”。
鉴于推送数据的重要性,开发者与平台需共同为推送数据的正确性和稳定性负责。因此,平台提供了用于确认推送数据完成处理的接口,要求开发者在处理完推送数据后进行上报,此上报被称为“履约上报”。

履约上报的重要性

    1.履约上报是平台必接能力
2025 年 4 月 15 日起,所有上线玩法均需接入履约上报能力,否则可能影响版本更新,请各位开发者合理安排时间提前接入。
    2.确保推送数据可靠性
调用履约上报接口以确保推送数据确实被推送给了玩法客户端,以及被玩法客户端处理完成,让推送数据的链路更加有据可查。
    3.便于排查问题
玩法客户端上报后,平台将统计玩法的互动消息的处理是否正常,是否超时。如果有异常,将收到告警消息,及时联系开发者定位问题,解决异常。
    4.玩法本身有正向帮助
当玩法的数据可靠性、正确性,有了保证,对观众、主播对于玩法的评价有正向作用,对与直播间的活跃度,玩法的氛围也有潜在帮助。对数据分析和运营决策有正向帮助。
因此,平台要求开发者在处理完消息后,及时调用确认收到的接口这不仅是对系统稳定性和消息可靠性的保障,也是对用户体验和数据一致性的负责。通过这一简单的操作,可以避免许多潜在的问题,确保平台、SDK和开发者应用的高效协同运行。

履约上报方案

上报步骤

平台提供的履约上报能力总共分为两步:
    1.收到推送数据,进行履约上报
    2.处理推送数据,完成后,进行履约上报

未接入Unity SDK的履约上报方案

开发者使用自己开发的服务器和平台服务端连接时,可通过该方案获取推送数据,接入指引请查看:https://developer.open-douyin.com/docs/resource/zh-CN/interaction/develop/server/live/ack-ability
开发者需做的履约上报方案如下:
    1.开发者服务器在确认开发者客户端收到推送数据时进行第一次履约上报;
    2.开发者服务器在确认开发者客户端处理推送数据完成后进行第二次履约上报。

已接入Unity SDK的履约上报方案

开发者客户端接入Unity SDK时,可使用SDK的接口收到推送数据,接入指引请查看:https://developer.open-douyin.com/docs/resource/zh-CN/interaction/develop/unity-sdk/live-unity-sdk-support/ack-ability
开发者需做的履约上报方案如下:
    1.开发者客户端在处理完推送数据后使用SDK的履约上报接口进行履约上报
    2.注意:使用SDK方式,确认收到推送数据由SDK自动上报,开发者仅需在完成推送数据处理后进行一次履约上报即可。