创建 MMM 数据请求

你可以使用本接口创建媒体组合建模 (MMM) 数据请求。

创建数据请求后，需最多等待 24 小时，直到数据处理完成。然后，使用 /mmm/api/check/ 接口查看数据请求状态。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/mmm/api/create/

方法 POST

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。|
|Content-Type {必填}|string|请求信息类型。<br>允许格式：`application/json`。  |

参数

|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
| advertiser_ids {必填} | string[] | 请求获取其 MMM 数据的广告主 ID 列表。<br><br>建议广告主 ID 的数量不超过 5 个。<br><br>若想获取你有权访问的商务中心内的广告账号列表，需使用 [/bc/asset/get/](1739432717798401.html) 接口并将 `asset_type` 设置为 `ADVERTISER`。 |
| request_info {必填} | object | 数据请求的详细信息。 |
#| targets {必填} | object[] | 广告账号和推广系列的详细信息。<br><br>`targets` 内的 `advertiser_id` 值应与传入的 `advertiser_ids` 相对应。 |
##| advertiser_id {必填} | string | 广告主 ID。 |
##| campaign_ids| string[] | 广告账号内推广系列的 ID 列表，用于筛选数据。<br><br>如果不传入 `campaign_ids`，将返回广告账号内所有推广系列的数据。<br><br>若想获取广告账号内的推广系列列表，需使用 [/campaign/get/](1739315828649986.html) 接口。|
##| brand | string | 品牌。<br>你可以使用此字段来区分不同品牌的数据请求。<br><br>如果传入此字段，其值将填充到数据文件的“品牌”列中。 |
##| sub_brand | string | 子品牌。<br>你可以使用此字段来区分不同子品牌的数据请求。<br><br>如果传入此字段，其值将填充到数据文件的“子品牌”列中。 |
#| from_date {必填} | string | 开始日期，格式为 `YYYY-MM-DD`（UTC+0 时间）。<br><br>开始日期不得早于 4 年前。 |
#| to_date {必填} | string | 结束日期，格式为 `YYYY-MM-DD`（UTC+0 时间）。 |
#| country_code | string[] | 2 个字母的国家或地区代码。<br><br>枚举值参见 <a href="#item-link-country_code 值列表">`country_code`值列表</a>。<br><br>如果不传入此字段，将返回所有国家和地区的数据。<br><br>示例：`US`。 |
#| media_type | string | 媒体类型。<br><br>枚举值： <ul><li>`All`（推荐）：付费媒体和口碑媒体。</li><li> `Paid`：付费媒体。你直接付费投放的广告，例如电视广告、社交媒体广告。</li><li>`Earned`：口碑媒体。通过自然方式获得的广告曝光，例如社交媒体提及。</li></ul>默认值：`All`。|
| email | string | 在数据可供下载时用于接收通知的电子邮箱地址。 |

country_code 值列表

| 值{30%} | 描述{70%} |
|---|---|
| `AD` | 安道尔 |
| `AE` | 阿拉伯联合酋长国 |
| `AF` | 阿富汗 |
| `AG` | 安提瓜和巴布达 |
| `AI` | 安圭拉 |
| `AL` | 阿尔巴尼亚 |
| `AM` | 亚美尼亚 |
| `AO` | 安哥拉 |
| `AQ` | 南极洲 |
| `AR` | 阿根廷 |
| `AS` | 美属萨摩亚 |
| `AT` | 奥地利 |
| `AU` | 澳大利亚 |
| `AW` | 阿鲁巴 |
| `AX` | 奥兰群岛 |
| `AZ` | 阿塞拜疆 |
| `BA` | 波斯尼亚和黑塞哥维那 |
| `BB` | 巴巴多斯 |
| `BD` | 孟加拉国 |
| `BE` | 比利时 |
| `BF` | 布基纳法索 |
| `BG` | 保加利亚 |
| `BH` | 巴林 |
| `BI` | 布隆迪 |
| `BJ` | 贝宁 |
| `BL` | 圣巴泰勒米 |
| `BM` | 百慕大 |
| `BN` | 文莱 |
| `BO` | 玻利维亚 |
| `BQ` | 荷属加勒比地区 |
| `BR` | 巴西 |
| `BS` | 巴哈马国 |
| `BT` | 不丹 |
| `BV` | 布韦岛 |
| `BW` | 博茨瓦纳 |
| `BY` | 白俄罗斯 |
| `BZ` | 伯利兹 |
| `CA` | 加拿大 |
| `CC` | 科科斯群岛（基灵群岛） |
| `CD` | 刚果民主共和国 |
| `CF` | 中非共和国 |
| `CG` | 刚果共和国 |
| `CH` | 瑞士 |
| `CI` | 科特迪瓦 |
| `CK` | 库克群岛 |
| `CL` | 智利 |
| `CM` | 喀麦隆 |
| `CN` | 中国大陆 |
| `CO` | 哥伦比亚 |
| `CR` | 哥斯达黎加 |
| `CU` | 古巴 |
| `CV` | 佛得角 |
| `CX` | 圣诞岛 |
| `CY` | 塞浦路斯 |
| `CZ` | 捷克共和国 |
| `DE` | 德国 |
| `DJ` | 吉布提 |
| `DK` | 丹麦 |
| `DM` | 多米尼克 |
| `DO` | 多米尼加共和国 |
| `DZ` | 阿尔及利亚 |
| `EC` | 厄瓜多尔 |
| `EE` | 爱沙尼亚 |
| `EG` | 埃及 |
| `EH` | 西撒哈拉 |
| `ER` | 厄立特里亚 |
| `ES` | 西班牙 |
| `ET` | 埃塞俄比亚 |
| `FI` | 芬兰 |
| `FJ` | 斐济 |
| `FK` | 福克兰群岛 |
| `FM` | 密克罗尼西亚 |
| `FO` | 法罗群岛 |
| `FR` | 法国 |
| `GA` | 加蓬 |
| `GB` | 英国 |
| `GD` | 格林纳达 |
| `GE` | 格鲁吉亚 |
| `GF` | 法属圭亚那 |
| `GG` | 根西岛 |
| `GH` | 加纳 |
| `GI` | 直布罗陀 |
| `GL` | 格陵兰 |
| `GM` | 冈比亚 |
| `GN` | 几内亚 |
| `GP` | 瓜德罗普 |
| `GQ` | 赤道几内亚 |
| `GR` | 希腊 |
| `GS` | 南乔治亚岛和南桑威奇群岛 |
| `GT` | 危地马拉 |
| `GU` | 关岛 |
| `GW` | 几内亚比绍 |
| `GY` | 圭亚那 |
| `HK` | 中国香港 |
| `HM` | 赫德岛和麦克唐纳群岛 |
| `HN` | 洪都拉斯 |
| `HR` | 克罗地亚 |
| `HT` | 海地 |
| `HU` | 匈牙利 |
| `ID` | 印度尼西亚 |
| `IE` | 爱尔兰 |
| `IL` | 以色列 |
| `IM` | 马恩岛 |
| `IN` | 印度 |
| `IO` | 英属印度洋领地 |
| `IQ` | 伊拉克 |
| `IR` | 伊朗 |
| `IS` | 冰岛 |
| `IT` | 意大利 |
| `JE` | 泽西岛 |
| `JM` | 牙买加 |
| `JO` | 约旦 |
| `JP` | 日本 |
| `KE` | 肯尼亚 |
| `KG` | 吉尔吉斯斯坦 |
| `KH` | 柬埔寨 |
| `KI` | 基里巴斯 |
| `KM` | 科摩罗 |
| `KN` | 圣克里斯托弗和尼维斯 |
| `KP` | 朝鲜 |
| `KR` | 韩国 |
| `KW` | 科威特 |
| `KY` | 开曼群岛 |
| `KZ` | 哈萨克斯坦 |
| `LA` | 老挝 |
| `LB` | 黎巴嫩 |
| `LC` | 圣卢西亚 |
| `LI` | 列支敦士登 |
| `LK` | 斯里兰卡 |
| `LR` | 利比里亚 |
| `LS` | 莱索托 |
| `LT` | 立陶宛 |
| `LU` | 卢森堡 |
| `LV` | 拉脱维亚 |
| `LY` | 利比亚 |
| `MA` | 摩洛哥 |
| `MC` | 摩纳哥 |
| `MD` | 摩尔多瓦 |
| `ME` | 黑山 |
| `MG` | 马达加斯加 |
| `MH` | 马绍尔群岛 |
| `MK` | 北马其顿 |
| `ML` | 马里 |
| `MM` | 缅甸 |
| `MN` | 蒙古 |
| `MO` | 中国澳门 |
| `MP` | 北马里亚纳群岛 |
| `MQ` | 马提尼克 |
| `MR` | 毛里塔尼亚 |
| `MS` | 蒙特塞拉特 |
| `MT` | 马耳他 |
| `MU` | 毛里求斯 |
| `MV` | 马尔代夫 |
| `MW` | 马拉维 |
| `MX` | 墨西哥 |
| `MY` | 马来西亚 |
| `MZ` | 莫桑比克 |
| `NA` | 纳米比亚 |
| `NC` | 新喀里多尼亚 |
| `NE` | 尼日尔 |
| `NF` | 诺福克岛 |
| `NG` | 尼日利亚 |
| `NI` | 尼加拉瓜 |
| `NL` | 荷兰 |
| `NO` | 挪威 |
| `NP` | 尼泊尔 |
| `NR` | 瑙鲁 |
| `NU` | 纽埃 |
| `NZ` | 新西兰 |
| `OM` | 阿曼 |
| `PA` | 巴拿马 |
| `PE` | 秘鲁 |
| `PF` | 法属波利尼西亚 |
| `PG` | 巴布亚新几内亚 |
| `PH` | 菲律宾 |
| `PK` | 巴基斯坦 |
| `PL` | 波兰 |
| `PM` | 圣皮埃尔和密克隆 |
| `PN` | 皮特凯恩群岛 |
| `PR` | 波多黎各 |
| `PS` | 巴勒斯坦 |
| `PT` | 葡萄牙 |
| `PW` | 帕劳 |
| `PY` | 巴拉圭 |
| `QA` | 卡塔尔 |
| `RE` | 留尼汪 |
| `RO` | 罗马尼亚 |
| `RS` | 塞尔维亚 |
| `RU` | 俄罗斯 |
| `RW` | 卢旺达 |
| `SA` | 沙特阿拉伯 |
| `SB` | 所罗门群岛 |
| `SC` | 塞舌尔 |
| `SD` | 苏丹 |
| `SE` | 瑞典 |
| `SG` | 新加坡 |
| `SH` | 圣赫勒拿 |
| `SI` | 斯洛文尼亚 |
| `SJ` | 斯瓦尔巴和扬马延 |
| `SK` | 斯洛伐克 |
| `SL` | 塞拉利昂 |
| `SM` | 圣马力诺 |
| `SN` | 塞内加尔 |
| `SO` | 索马里 |
| `SR` | 苏里南 |
| `SS` | 南苏丹 |
| `ST` | 圣多美和普林西比 |
| `SV` | 萨尔瓦多 |
| `SY` | 叙利亚 |
| `SZ` | 斯威士兰 |
| `TC` | 特克斯和凯科斯群岛 |
| `TD` | 乍得 |
| `TF` | 法属南部和南极领地 |
| `TG` | 多哥 |
| `TH` | 泰国 |
| `TJ` | 塔吉克斯坦 |
| `TK` | 托克劳 |
| `TL` | 东帝汶 |
| `TM` | 土库曼斯坦 |
| `TN` | 突尼斯 |
| `TO` | 汤加 |
| `TR` | 土耳其 |
| `TT` | 特立尼达和多巴哥 |
| `TV` | 图瓦卢 |
| `TW` | 中国台湾 |
| `TZ` | 坦桑尼亚 |
| `UA` | 乌克兰 |
| `UG` | 乌干达 |
| `UM` | 美国本土外小岛屿 |
| `US` | 美国 |
| `UY` | 乌拉圭 |
| `UZ` | 乌兹别克斯坦 |
| `VA` | 梵蒂冈城 |
| `VC` | 圣文森特和格林纳丁斯 |
| `VE` | 委内瑞拉 |
| `VG` | 英属维尔京群岛 |
| `VI` | 美属维尔京群岛 |
| `VN` | 越南 |
| `VU` | 瓦努阿图 |
| `WF` | 瓦利斯和富图纳 |
| `WS` | 萨摩亚 |
| `YE` | 也门 |
| `YT` | 马约特岛 |
| `ZA` | 南非 |
| `ZM` | 赞比亚 |
| `ZW` | 津巴布韦 |

示例

(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)

返回

|字段{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|返回数据。|
#| mmm_request_id | string | MMM 数据请求的唯一识别 ID。<br><br>若想查看数据请求状态，需最多等待 24 小时，直到数据处理完成，然后将此字段的值作为 `mmm_request_id` 传入 [/mmm/api/check/](https://business-api.tiktok.com/portal/docs/check-the-status-of-an-mmm-data-request/v1.3) 接口。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "mmm_request_id": "{{mmm_request_id}}"
    }
}
(/code)