媒体组合建模数据请求
本文介绍通过 API 访问媒体组合建模数据的步骤。
简介
媒体组合建模 (MMM) 是一种度量技术,它通过时间序列建模来分析所有传统营销和数字营销触点对业务成果(价格)的影响。通过考量价格、外部因素和经济因素等运营要素,MMM 能够量化广告主在各个媒体渠道的 ROI,并为未来的媒体预算规划提供洞察。
你可以使用 MMM API 访问 MMM 数据,这有助于简化 MMM 数据请求流程,提升运营效率和可扩展性。
前提条件
- 你可以访问 TikTok API for Business。更多信息参见快速入门 - 具体步骤。确保已完成 Marketing API 授权并获取访问令牌。
- 若想创建访问量广告,需拥有相关权限。参见 API 参考,了解使用接口(包括“步骤”小节列出的接口)所需的权限,并参见更新应用权限范围,了解如何配置权限。
确保你的开发者应用拥有数据报表下的 MMM Data Report 权限范围。 - 若想通过 API 访问 MMM 数据,需先在商务中心设置广告账号。
1. 将广告账号添加到商务中心。你可以通过 /bc/advertiser/create/ 接口在商务中心创建广告账号,也可以在商务中心申请访问广告账号。
2. 确保你有权访问想要用于获取 MMM 数据的广告账号。若想确认这一点,需调用 /bc/asset/get/ 接口,并将
asset_type设置为ADVERTISER。
如果广告账号返回的advertiser_role不是ADMIN、OPERATOR或ANALYST,表示你无权访问这些广告账号。请联系该商务中心的一位管理员与你共享广告账号,并通过 /bc/asset/assign/ 接口授予权限。商务中心管理员需将asset_type指定为ADVERTISER,并将advertiser_role指定为ADMIN、OPERATOR或ANALYST。
步骤
- 使用 /mmm/api/create/ 接口创建 MMM 数据请求。
示例
请求
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/mmm/api/create/' \
--header 'Access-Token: {{Access-Token}}'
--header 'Content-Type: application/json' \
--data-raw '{
"advertiser_ids": [
"{{advertiser_id}}"
],
"request_info": {
"targets": [
{
"advertiser_id": "{{advertiser_id}}"
}
],
"from_date": "2024-01-01",
"to_date": "2024-01-03",
"country_code": [
"JP","US","CA"
],
"media_type": "All"
},
"email": "{{email}}"
}'
(/code)
返回
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"mmm_request_id": "{{mmm_request_id}}"
}
}
(/code)
- 使用 /mmm/api/check/ 接口查看数据请求状态。
示例
请求
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/mmm/api/check/?mmm_request_id={{mmm_request_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"status": "completed - ready for download"
}
}
(/code)
- 确认数据请求的
status为completed - ready for download后,使用 /mmm/api/download/ 接口获取数据下载 URL。
如需了解可用的 MMM 数据字段,参见 MMM 模板数据结构。
示例
请求
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/mmm/api/download/?mmm_request_id={{mmm_request_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"download_url": "{{download_url}}"
}
}
(/code)