查看 MMM 数据请求状态
你可以使用本接口查看媒体组合建模 (MMM) 数据请求状态。
当数据请求的 status 为 completed - ready for download 时,可使用 /mmm/api/download/ 接口获取该数据的下载 URL。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/mmm/api/check/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
| mmm_request_id {必填} | string | MMM 数据请求的唯一识别 ID。<br><br> <ul><li>若想创建 MMM 数据请求并获取数据请求 ID,需使用 [/mmm/api/create/](https://business-api.tiktok.com/portal/docs/create-an-mmm-data-request/v1.3) 接口。</li><li>若想获取 MMM 数据请求历史记录,包括数据请求 ID,需使用 [/mmm/api/history/](https://business-api.tiktok.com/portal/docs/get-the-mmm-data-request-history/v1.3) 接口。 </li></ul>|
示例
(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)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message|string|返回信息。更多信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|request_id |string|请求的日志 ID,唯一标识一个请求。 |
|data |object|返回数据。|
#| status | string | 数据请求的状态。<br><br>枚举值: <ul><li>`request received`:已收到请求,但尚未开始处理数据。</li><li>`in progress`:正在处理数据。</li><li>`completed - ready for download`:数据处理已完成,可下载数据。 <ul><li>若想获取数据下载 URL,需使用 [/mmm/api/download/](https://business-api.tiktok.com/portal/docs/obtain-the-download-url-for-mmm-data/v1.3) 接口。</li></ul></li><li>`failed`:请求失败。</li></ul> |
#| message | string | 仅当 `status` 为 `failed` 时返回。<br><br>数据请求失败的原因。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"status": "completed - ready for download"
}
}
(/code)