获取广告账户余额和预算
您可以使用本接口获取商务中心下的广告账户余额,或获取自动分配模式下商务中心的广告账户的预算。
本接口只返回该商务中心对广告账户具有管理员权限的广告账户。
代理商商务中心和直客商务中心都能执行资金管理相关操作。
注意
- 只有拥有财务经理或财务分析师权限的用户才能在商务中心执行资金管理和发票的相关操作。您可以使用/bc/member/invite/ 和 /bc/member/update/设置或更改成员权限。
- 合约广告账户无法使用月度预算,日预算或自定义预算进行余额共享。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/advertiser/balance/get/| /v1.3/advertiser/balance/get/|
|请求参数类型|bc_id: number|bc_id: string|
|请求参数名称|advertiser_show_status|advertiser_status|
|新增请求参数|/|fields<br>payment_portfolio_id|
|返回参数类型|advertiser_id: number|advertiser_id: string|
|返回参数名称|list<br>account_days<br>first_recharge_cash|advertiser_account_list<br>advertiser_open_days<br>first_recharge_amount|
|新增返回参数|/|transferable_amount<br>budget_remaining<br>budget_frequency_restriction<br>budget_amount_restriction<br>min_transferable_amount<br>payment_portfolio_id<br>payment_portfolio_name<br>max_transferable_amount<br>balance_info<br>payment_portfolio_type`|
## 请求
**地址**https://business-api.tiktok.com/open_api/v1.3/advertiser/balance/get/
**方法** GET
**Header**
```xtable
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权access_token,可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|bc_id {必填}|string| 商务中心 ID。 |
| fields | string[] | 返回的额外字段。<br><br>支持的值:<ul><li>`budget_remaining`:剩余预算。</li><li>`budget_frequency_restriction`:对当天修改预算次数的限制。</li><li>`budget_amount_restriction`:对修改预算金额的限制。</li><li>`min_transferable_amount`:可转入该广告账户的最小金额。</li><li>`max_transferable_amount`:可从广告账户转入商务中心的最大金额详情。</li><li>`balance_info`:广告账户余额详情。</li></ul></ul><br><ul><li>若不传入本字段,将返回除 `budget_remaining`、`budget_frequency_restriction`、`budget_amount_restriction`、`min_transferable_amount`、`max_transferable_amount` 和 `balance_info` 外的所有信息。</li><li>若想获取其他信息的同时也获取额外的字段(`budget_remaining`,`budget_frequency_restriction`,`budget_amount_restriction`、`min_transferable_amount`、`max_transferable_amount` 和 `balance_info`),需将 `fields` 设置为 `["budget_remaining", "budget_frequency_restriction", "budget_amount_restriction", "min_transferable_amount", "max_transferable_amount", "balance_info"]`并将 `page_size` 设置为 1。</li></ul> |
|filtering |object|筛选条件。 |
#|keyword |string| 关键词,可以搜索广告账户名或者广告账户 ID。|
#|advertiser_status|string[]| 广告账户展示状态。<br><br>枚举值:<ul><li>`SHOW_ACCOUNT_STATUS_NOT_APPROVED`:未通过。</li><li> `SHOW_ACCOUNT_STATUS_APPROVED`:已通过。</li><li> `SHOW_ACCOUNT_STATUS_IN_REVIEW`:审核中。</li><li> `SHOW_ACCOUNT_STATUS_PUNISHED`:惩罚中。</li></ul>|
#|payment_portfolio_id|string|仅当您启用多财务资产组合时可用。<br><br>用于筛选结果的财务资产组合 ID。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>单客户的多财务资产组合目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li><li>若传入本字段,返回中的余额信息将为与该财务资产组合(`payment_portfolio_id`)关联的广告账户的余额。</li></ul>|
|page |number|当前页数。<br><br>默认值: `1`,取值范围: ≥ 1。|
|page_size |number|分页大小。<br><br>默认值: `10`,取值范围: 1-50。|
示例
(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "bc_id=BC_ID" \
--data-urlencode "filtering={\"keyword\": \"KEYWORD\", \"status\": [\"STATUS\"]}" \
--data-urlencode "page=PAGE" \
--data-urlencode "page_size=PAGE_SIZE" \
https://business-api.tiktok.com/open_api/v1.3/advertiser/balance/get/
(/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|返回数据。 |
#|advertiser_account_list |object[]| 广告账户余额列表。 <br><br><p><span style="color:darkred"><b>注意</b></span>:若广告账户所属的商务中心已启用财务资产组合,下列参数将返回财务资产组合而非广告账户的数据: <ul><li>`account_balance`</li><li>`valid_account_balance`</li><li>`frozen_balance`</li><li>`tax`</li><li> `cash_balance`</li><li>`valid_cash_balance` </li><li>`transferable_amount` </li><li>`payment_portfolio_type`</li></ul>|
##|advertiser_id|string| 广告账户 ID。 |
##|advertiser_name |string| 广告账户名称。 |
##|advertiser_status |string| 广告账户展示状态。<br><br>枚举值:<ul><li>`SHOW_ACCOUNT_STATUS_NOT_APPROVED`:未通过。</li><li> `SHOW_ACCOUNT_STATUS_APPROVED`:已通过。</li><li> `SHOW_ACCOUNT_STATUS_IN_REVIEW`:审核中。</li><li> `SHOW_ACCOUNT_STATUS_PUNISHED`:惩罚中。</li></ul>|
##|advertiser_type |string| 广告账户类型。<br><br>枚举值:`AUCTION`(竞价), `RESERVATION`(合约)。 |
##|timezone |string| 广告账户时区。<br><br>枚举值参见[附录-时区信息](https://ads.tiktok.com/marketing_api/docs?id=1737586324313089)。 |
##|currency |string| 广告账户币种。<br><br>枚举值参见[附录-币种](https://ads.tiktok.com/marketing_api/docs?id=1737585839634433)。 |
##|account_open_days |number| 广告账户开户天数。 |
##|balance_reminder |boolean| 余额撞线,当余额撞线为是时,意味着您应该给广告主账号进行加款。 |
##|company |string| 广告账户公司名称。 |
##|contact_name |string| 广告账户联系人姓名。 |
##|contact_email |string| 广告账户联系人邮箱。 |
##|create_time |string| 广告账户开户时间(UTC+0)。<br><br>示例:`2017-01-01 00:00:00`。 |
##|first_recharge_amount{-已废弃}|number| 首次充值金额,保留两位小数。 |
##|first_recharge_time{-已废弃}|string| 首次充值时间(UTC+0)。<br><br>示例:`2017-01-01 00:00:00`。 |
##|latest_recharge_time{-已废弃}|string| 最近一次充值时间(UTC+0)。<br><br>示例:`2017-01-01 00:00:00`。 |
##|recharge_amount{-已废弃}|number| 充值总金额,保留两位小数。 |
##|recharge_count{-已废弃}|number| 充值总次数。 |
##|account_balance |number| 广告账户总余额,保留两位小数。 |
##|valid_account_balance |number| 广告账户有效账户余额,保留两位小数。 |
##|frozen_balance |number| 广告账户冻结余额,保留两位小数。 |
##|tax |number| 广告账户税费,保留两位小数。默认值为`0`。 |
##|cash_balance |number| 广告账户现金余额,保留两位小数。 |
##|valid_cash_balance |number| 广告账户有效现金余额,保留两位小数。 |
##|grant_balance |number| 广告账户赠款余额,保留两位小数。 |
##|valid_grant_balance |number| 广告账户有效赠款余额,保留两位小数。 |
##|payment_portfolio_id|number|仅对启用了财务资产组合的商务中心返回。<br><br>与该广告账户关联的财务资产组合的 ID。|
##|payment_portfolio_name|string|仅对启用了财务资产组合的商务中心返回。<br><br>与该广告账户关联的财务资产组合的名称。|
##|payment_portfolio_type|string|仅对启用了财务资产组合的商务中心返回。<br><br>财务资产组合类型。<br><br>枚举值:<ul><li>`SHARED`:高级财务资产组合。对于高级财务资产组合,资金为集中管理,由所有关联的广告账号共同使用。</li><li>`NON_SHARED`:标准财务资产组合。对于标准财务资产组合,每个关联的广告账号的资金均为单独管理。</li></ul>|
##| transferable_amount |number| 广告账户可转金额,对应币种为广告账户币种,保留两位小数。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>可转金额不包括冻结金额(`frozen_balance`)和广告投放保证金。因此, `transferable_amount` 的值可能比 `valid_cash_balance` 和 `valid_account_balance` 小。为防止广告投放出现中断,建议您的转出金额不高于`transferable_amount`。</li><li>本字段仅在`total_number` 为 1 时返回。</li></ul> |
##|max_transferable_amount|object|可从广告账户转入商务中心的最大金额的详细信息。|
###|cash_amount|number|可从广告账户转入商务中心的最大现金金额,金额基于您的广告账户的币种,保留两位小数。|
###|grant_amount|number|可从广告账户转入商务中心的最大赠款金额,金额基于您的广告账户的币种,保留两位小数。|
##|balance_info|object|广告账户余额详情。|
###|account_balance|number|广告账户总余额,保留两位小数。<br><br>公式:`account_balance` = `valid_account_balance` + `frozen_balance` + `tax`。|
###|frozen_balance|number|广告账户的冻结余额,保留两位小数。|
###|valid_account_balance|number|广告账户的可用余额,保留两位小数。|
###|tax|number|广告账户税费,保留两位小数。|
###|cash_balance|number|广告账户的总现金余额,保留两位小数。|
###|frozen_cash_balance|number|广告账户的冻结现金余额,保留两位小数。|
###|cash_tax|number|广告账户的现金税费,保留两位小数。|
###|valid_cash_balance|number|广告账户的可用现金余额,保留两位小数。<br><br>公式:`valid_cash_balance` = `cash_balance` - (`frozen_cash_balance` + `cash_tax`)。|
###|grant_balance|number|广告账户的总赠款余额,保留两位小数。|
###|valid_grant_balance|number|广告账户的可用赠款余额,保留两位小数。|
###|frozen_grant_balance|number|广告账户的冻结赠款余额,保留两位小数。|
###|credit_balance|number|广告账户的总信用余额,保留两位小数。|
###|valid_credit_balance|number|广告账户的可用信用余额,保留两位小数。|
###|frozen_credit_balance|number|广告账户的冻结信用余额,保留两位小数。|
##|budget_mode |string| 广告账户预算模式。<br><br>枚举值:<ul><li>`UNLIMITED`:广告账户无预算限制。</li><li> `MONTHLY_BUDGET`:广告主账号在月度预算内消耗信用额度。</li><li> `DAILY_BUDGET`:广告主账号在日预算内消耗信用额度。</li><li> `CUSTOM_BUDGET`:广告主账号在单次自定义预算内消耗信用额度。</li></ul><p><span style="color:darkred"><b>注意</b></span>:<ul><li> 如果商务中心处于人工付款模式,则返回值始终为`UNLIMITED`。</li><li>除非您定制了预算模式,否则广告账户的默认预算模式为`UNLIMITED`。|
##|budget|float| <ul><li>若`budget_mode`为`MONTHLY_BUDGET`,则会返回广告主账户的月度预算。</li><li>若`budget_mode`为`DAILY_BUDGET`,则会返回广告主账户的日预算。</li><li>若`budget_mode`为`CUSTOM_BUDGET`,则会返回广告主账户的单次自定义预算。</li><li> 若`budget_mode`为`UNLIMITED`,则返回`0`。</li></ul> |
##|budget_cost|float| <ul><li>若`budget_mode`=`MONTHLY_BUDGET`/`DAILY_BUDGET`/`CUSTOM_BUDGET`,则会返回广告账户已花费的预算。</li><li>若`budget_mode`=`UNLIMITED`,则返回`0`。</li></ul> |
##| budget_remaining | float | 剩余预算。<br><br>本字段的计算公式为:`budget_remaining` = `budget` - `budget_cost`。 |
##| budget_frequency_restriction | object | 对当天修改预算次数的限制。<br><br>您每天可最多修改 10 次预算,包括同时修改广告账户预算类型和预算金额的修改以及仅修改广告账户预算金额的修改。 |
###| total_count | number | 允许的最大预算修改次数。<br><br>示例:10。 |
###| used_count | number | 已使用的修改次数。<br><br>示例:0。 |
###| remaining_count | number | 剩余的修改次数。<br><br>示例:10。 |
###| effective_start_time | string | 该限制开始生效的时间,格式为 `YYYY-MM-DD HH:MM:SS` (UTC + 0 时间)。<br><br>示例:`2025-01-01 00:00:01`。 |
###| effective_end_time | string | 该限制停止生效的时间,格式为 `YYYY-MM-DD HH:MM:SS` (UTC + 0 时间)。<br><br>示例:`2025-01-01 23:59:59`。 |
##| budget_amount_restriction | object | 对修改预算金额的限制。 |
###| minimum_amount | number | 预算的最小修改金额。<br>该金额基于预算周期内已消耗的预算。预算修改金额需大于等于此金额。 |
##| min_transferable_amount | object | 仅当请求中 `page_size` 设置为 1 时返回本字段。<br><br>可转入该广告账户的最小金额详情。 |
###| cash_amount | number | 可转入该广告账户的最小现金金额。 |
###| grant_amount | number | 可转入该广告账户的最小赠款金额。 |
###| credit_amount | number | 可转入该广告账户的最小信用额度金额。 |
#|page_info| object| 分页信息。 |
##|page |number| 当前页数。 |
##|page_size |number| 分页大小。 |
##|total_number |number| 总数。 |
##|total_page |number| 总页数。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "LOG_ID",
"data": {
"page_info": {
"page": 1,
"total_number": 2,
"page_size": 5,
"total_page": 1
},
"advertiser_account_list": [
{
"advertiser_type": "AUCTION",
"frozen_balance": 0,
"grant_balance": 0,
"account_open_days": 282,
"valid_cash_balance": 0,
"company": "tiktok",
"advertiser_id": "ADVERTISER_ID",
"latest_recharge_time": null,
"cash_balance": 0,
"timezone": "Etc/GMT-12",
"balance_reminder": false,
"create_time": "2021-11-02 02:15:32",
"first_recharge_amount": 0,
"contact_name": "CONTACT_NAME",
"account_balance": 0,
"valid_grant_balance": 0,
"recharge_amount": 0,
"valid_account_balance": 0,
"contact_email": ""
"recharge_count": 0,
"currency": "USD",
"advertiser_status": null,
"tax": 0,
"advertiser_name": "ADVERTISER_NAME",
"budget_mode": "UNLIMITED",
"budget": 0,
"budget_cost": 0
}
]
}
}
(/code);