沙箱账户

通过使用 TikTok API for Business 沙箱账户，您可以轻松地进行调试，而不会影响您真实的TikTok广告账户。

注意
如果您在2020年11月4日之前创建了一个沙箱账户，您必须再创建一个新的沙箱账户，因为旧的广告主ID和访问令牌不再有效。

拥有 TikTok 沙箱账户的开发人员具有以下能力：

在沙箱环境中使用大部分 TikTok API for Business 生产环境下的接口。点击此处了解沙箱账户中支持的接口。
使用报表接口获取模拟报表数据。
开发人员可以为创建的每个开发者应用创建沙箱账户。

注意

您在应用级别拥有的权限将自动反映为沙箱账户的权限。
在沙箱环境中，每个接口的调用频次限制如下：秒级调用限制（QPS）为1、分钟级调用限制（QPM）为30、天级调用限制（QPD）为1000。例如，若您向五个不同的接口发出请求，则可以在一秒内发送最多5个请求（每个接口一个请求）。

沙箱环境基础URL格式

TikTok API for Business接口地址格式为： <base_url>/<api_version>/<endpoint>/

沙箱环境下接口的基础地址是https://sandbox-ads.tiktok.com/open_api

生产环境下的接口基础地址是https://business-api.tiktok.com/open_api

接口页面中的地址使用的是生产环境的基础地址。如果需要使用沙箱环境的接口，需要将基础地址更换为沙箱环境的基础地址。

在设置好沙箱账户后，您可以向相应的接口发送请求。

设置您的沙箱账户

设置沙箱账户很容易。如上所述，您可以通过TikTok API for Business为您创建的每个应用程序创建沙箱账户。要创建沙箱账户，请按照以下说明进行操作。 1. 进入TikTok API for Business主页，点击跳转至应用管理。

点击您要在其下创建沙箱账户的开发者应用。

点击创建沙箱广告账户。

输入沙箱账户名，国家/地区，货币和时区。点击创建。

创建后，开发人员就可以生成和撤销访问令牌并查看您的广告主ID。

用于同步报表的模拟数据

为方便开发者测试，我们在沙箱账户里提供有限的模拟数据报表功能。您可以向https://sandbox-ads.tiktok.com/open_api/v1.3/report/integrated/get/接口发起GET请求来获取虚拟的数据报表。

虚拟数据非真实投放数据，我们保证接口返回的数据格式和线上数据一致，但不保证数据完全符合真实逻辑。如：获取受众分析报表时，虚拟数据返回的有消耗的国家地区代码，可能和广告设置的投放地区不一致。

推荐您在沙箱账户中创建至少一个推广系列，一个广告组，和一个广告。虚拟数据可能会为请求的指标仅返回默认值（例如"0"）或返回空结果（"list": []）。

支持的报表设置

请求时间范围： 2020/12/08 - 2020/12/19。
service_type：AUCTION。
report_type：BASIC, AUDIENCE。
data_level：AUCTION_CAMPAIGN, AUCTION_ADGROUP, AUCTION_AD。
dimensions：对应report_type下所有dimensions均可请求。
metrics：对应report_type下所有metrics均可请求。某些metrics可能会返回0或-。
filters：对应report_type下所有filters均可筛选。
lifetime：支持查询true的数据。
order_field& order_type：不支持排序功能。

示例

请求

(code curl http)
curl --location --request POST 'https://sandbox-ads.tiktok.com/open_api/v1.3/report/integrated/get/?advertiser_id={{advertiser_id}}&report_type=BASIC&dimensions=["adgroup_id"]&service_type=AUCTION&data_level=AUCTION_ADGROUP&start_date=2022-12-11&end_date=2023-12-11&metrics=["spend"]&page_size=1' \
--header 'Access-Token: {{Access-Token}}'
(/code)

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "page_info": {
            "total_number": 1,
            "page": 1,
            "page_size": 1,
            "total_page": 1
        },
        "list": [
            {
                "metrics": {
                    "spend": "0"
                },
                "dimensions": {
                    "adgroup_id": "{{adgroup_id}}"
                }
            }
        ]
    }
}
(/code)

沙箱账户中支持的接口

下表总结了沙箱账户中目前支持的接口。

注意
沙箱环境正在升级中，未来沙箱账户将支持所有接口。

| 沙箱账户中支持的接口 |
|---|
|/ad/create/|
|/ad/get/ |
| /ad/update/|
| /ad/status/update/|
|/adgroup/create/|
| /adgroup/get/|
| /adgroup/update/|
| /adgroup/status/update/|
| /campaign/create/ |
| /campaign/get/ |
| /campaign/update/ |
| /campaign/status/update/|
| /file/image/ad/upload/ |
| /file/video/ad/upload/ |
| /report/integrated/get/ (GET) |
| /term/check/ |
| /term/confirm/ |
| /term/get/ |
| /user/info/ |
| /identity/create/ |
| /identity/get/ |
| /identity/delete/ |