获取商务中心和广告账户的消耗记录
您可以使用本接口获取商务中心和广告账户层级的消耗记录。
注意
- 只有拥有财务经理或财务分析师权限的成员才能获取商务中心的消耗记录。若想设置或更改成员的财务权限,可使用 /bc/member/invite/ 和 /bc/member/update/. - 消耗数据的延迟通常可达 10 小时。API 返回是实时的,但代表约 10 小时前的消耗数据。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/bc/account/cost/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| bc_id {必填}| string| 商务中心 ID。<br><br> 若想获取可访问的商务中心,可使用 [/bc/get/](1737115687501826.html)。 |
| filtering | object | 筛选条件。 |
#| keyword | string | 搜索关键词。 <br><br> 支持模糊搜索。 <br><br> 您可指定广告账户 ID 或名称作为搜索关键词。 |
#| start_date | string | 查询起始日期,格式为 `YYYY-MM-DD` (广告账户时区)。 <br><br> 您可同时指定 `start_date` 和 `end_date` 或不传入 `start_date` 和 `end_date`。 <ul><li> 若同时指定 `start_date` 和 `end_date`,允许的最大时间区间为 365 天。 </li><li> 若不传入 `start_date` 和 `end_date`,将默认返回最近 90 天的数据。 </li></ul> |
#| end_date | string | 查询结束日期,格式为 `YYYY-MM-DD` (广告账户时区)。 <br><br> 您可同时指定 `start_date` 和 `end_date` 或不传入 `start_date` 和 `end_date`。 <ul><li> 若同时指定 `start_date` 和 `end_date`,允许的最大时间区间为 365 天。 </li><li> 若不传入 `start_date` 和 `end_date`,将默认返回最近 90 天的数据。 </li></ul> |
| page | integer | 当前页数。 <br><br> 取值范围 : ≥ 1。 <br> 默认值: 1。 |
| page_size | integer | 分页大小。 <br><br> 取值范围: 1-50。 <br> 默认值: 10。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/bc/account/cost/get/?bc_id={{bc_id}}&filtering={"start_date": "{{start_date}}", "end_date": "{{end_date}}"}&page=1&page_size=50' \
--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| 返回数据。 |
#| cost_list | object[] | 每个广告账户的消耗记录列表。 |
##| advertiser_id | string | 广告账户 ID。 |
##| advertiser_name | string | 广告账户名称。 |
##| amount | number | 广告账户的总消耗金额。 <br><br> 示例: -1376616。 |
##| cash_amount | number | 广告账户的现金消耗金额。 <br><br> 示例: -1376616。 |
##| grant_amount | number | 广告账户的广告赠款消耗金额。 <br><br> 示例: 0。 |
##| tax_amount | number | 广告账户的预估税费。 <br><br> 示例: -68831。 |
##| currency | string | 广告账户的币种。 <br><br> 示例: `USD`。 |
#| transaction_summary | object | 商务中心的消耗记录汇总。 |
##| amount | number | 商务中心的总消耗金额。 <br><br> 示例: -484400000。 |
##| cash_amount | number | 商务中心的现金消耗金额。 <br><br> 示例: -484400000。 |
##| grant_amount | number | 商务中心的广告赠款消耗金额。 <br><br> 示例: 0。 |
##| tax_amount | number | 商务中心的预估税费。 <br><br> 示例: -2400000。 |
##| currency | string | 商务中心的货币。 <br><br> 示例: `USD`。 |
#| page_info | object | 分页信息。 |
##| page | integer | 当前页数。 |
##| page_size | integer | 分页大小。 |
##| total_number | integer | 总结果数。 |
##| total_page | integer | 总页数。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"cost_list": [
{
"advertiser_id": "{{advertiser_id}}",
"advertiser_name": "{{advertiser_name}}",
"amount": {{amount}},
"cash_amount": {{cash_amount}},
"currency": "VND",
"grant_amount": {{grant_amount}},
"tax_amount": {{tax_amount}}
},
{
"advertiser_id": "{{advertiser_id}}",
"advertiser_name": "{{advertiser_name}}",
"amount": {{amount}},
"cash_amount": {{cash_amount}},
"currency": "VND",
"grant_amount": 0,
"tax_amount": {{tax_amount}}
}
],
"page_info": {
"page": 1,
"page_size": 50,
"total_number": 2,
"total_page": 1
},
"transaction_summary": {
"amount": {{amount}},
"cash_amount": {{cash_amount}},
"currency": "VND",
"grant_amount": {{grant_amount}},
"tax_amount": {{tax_amount}}
}
}
}
(/code)