广告平台的InCost API

推荐用于

广告平台

最近更新： 2024年03月13日 10:23

概要：InCost API是AppsFlyer ROI360的一部分，能让广告平台通过程序化的方式向AppsFlyer发送广告成本数据，从而为广告主提供汇总成本信息，让其了解贵平台真正的投放价值。

InCost API简介

InCost API是广告平台向AppsFlyer发送成本数据的最佳解决方案。与广告主合作的广告平台可通过此API向AppsFlyer发送详细的广告投放成本数据。AppsFlyer取得该数据后会对其进行处理，并通过面板和报告向广告主和平台呈现相关信息。

优势

通过流畅的成本数据上报让您的广告主了解贵平台真正的投放价值。如果缺少成本数据，您的广告主就失去了衡量投放效果的关键信息，无法准确地掌握ROAS，导致广告主将预算盲目投入其他渠道，最终影响到贵平台的效益。
使用该API可保障成本数据衡量的准确性、完整性和实时性，更有效地展示贵平台的ROI。
InCost API部署简单快捷，效果立竿见影，并能让您完全把控数据发送的方式和节点，且支持前90天内的成本数据发送。
InCost API支持所有的广告定价模式，不仅仅局限于CPI（若通过点击发送成本，则仅支持CPI）。
完成InCost API对接后贵平台在AppsFlyer Partner Marketplace中会获得一个“成本”徽章，表示支持成本数据。

InCost API的部署方式

前期准备：如需使用InCost API，贵平台需符合以下条件：

90%的广告系列在归因链接中包含广告系列ID（Campaign ID）。
每天可发送数据至少6次，以提高数据时效性。具体的发送时间由贵平台决定。
【如果广告平台对数据进行回滚更新】每次可发送最近7天的数据，以提高数据的完整性。

请按以下方式部署InCost API并向AppsFlyer发送成本数据：

请按下表所列的步骤操作。

步骤	操作
1	申请使用InCost：进入AppsFlyer后台，在页面顶部的菜单中选择帮助 > 联系我们。界面会打开渠道支持微件。选择启用成本衡量，并提交相关信息。提交完毕后，系统会创建工单，并且会有AppsFlyer渠道解决方案工程师与您联系。
2	确保至少90%的流量在其归因链接中包含广告层级信息，这些信息包括广告系列ID（必须配置）以及广告组ID和广告ID（可选）。
3	从AppsFlyer面板中获取AppsFlyer API token。
4	将API token发送给您的开发人员，在API认证头（authorization header）中使用，并让其按照相关说明部署以下3个API方法： Get app list。 InCost upload：告知开发人员用于填充JSON文件的字段：必须发送的字段一定要填充，也就是说这些字段不能发送空值。媒体渠道仅限关联到贵平台账户（即在平台账户下注册）的渠道。请让您的渠道拓展负责人向您提供相关渠道列表。请注意相关应用的时区设置（通过Get app permission list API上报），确保成本数据的日期与应用时区相符。请勿上传不包含在成本数据中的广告层级字段，如广告组ID、素材资产名称、广告ID、广告名称等。 Get job status。
6	在工单进度中（步骤1）通知AppsFlyer该API已部署完毕，并等待对接生效的确认消息。
7	请确保您的广告主在AppsFlyer对接渠道页面的成本选项卡中打开了获取成本数据的开关。打开该开关后广告主即可获取成本数据。

JSON格式的InCost Upload字段

字段	是否必须发送	说明
date	是	产生消耗的日期格式：`YYYY-MM-DD` 示例：`2019-12-30`
app_id	是	AppsFlyer后台显示的应用ID 格式：字符串，最多可包含250个字符示例：安卓：`com.app.name`，iOS：`id123456789`
media_source	是	在AppsFlyer中关联到您广告平台账户的平台名称（ID）格式：50个字符的字符串示例：`network_int`
af_prt	否*	如需衡量代理流量和成本，必须填充该字段。归因链接中的代理名称，也是AppsFlyer中关联到该代理账户的名称。格式：50个字符的字符串示例：`agencya`
campaign_id	是	必须与归因链接中传递的`af_c_id`参数值完全一致字符串不能为空格式：24个字符的字符串示例：`123abc`
campaign_name	是	格式：100个字符的字符串示例：`my_campaign123`
adset_id	否*	如果发送`adset_name`，则必须填充该字段必须与归因链接中传递的`af_adset_id`参数值完全一致如果您贵平台上报的成本中不支持`adset_id`，切勿发送该字段格式：24个字符的字符串示例：`123A`
adset_name	否	若发送此字段，还必须一并发送`adset_id` 格式：100个字符的字符串示例：`my_adset_name`
ad_id	否*	如果发送`ad_name`，则必须填充该字段必须与归因链接中传递的`af_ad_id`参数值完全一致如果您贵平台上报的成本中不支持`adset_id`，切勿发送该字段格式：24个字符的字符串示例：`123AB`
site_id	否	用于标记广告发行商（展示广告的媒体）的唯一ID。格式：24个字符的字符串。
ad_name	否	若发送此字段，还必须一并发送`ad_id` 格式：100个字符的字符串示例：`Ad-name`
geo	否	贵平台记录到的收入所关联的国家应尽可能填充展示广告的国家格式：符合ISO 3166标准的2字符国家/地区代码示例：`US, CN, ZA`
currency	是	广告消耗的币种格式：符合ISO 4217标准的3字符货币代码示例：`USD, EUR, ZAR`
spend	是	以指定币种为单位的消耗金额最多可精确到小数点后五位可填充零值（0）不可填充负值切勿发送分隔符“`,`” 切勿使用引号发送值。格式：十进制数示例值：`1`、`1.2`、`1234.20`
channel	否	必须与归因链接中传递的`af_channel`参数值完全一致格式：20个字符的字符串示例：`my_channel`
keywords	否	格式：100个字符的字符串示例：`abc app`
* 部分情况下必须发送此字段，详情请见说明栏。