更新广告组
您可以使用本接口更新广告组。部分内容无法更新(比如版位)。
重要
本接口使用的是全量更新模式。即使您只想要更新一个字段,也需要传入所有的必填字段。注意
若您已在推广系列层级设置special_industries,需确保该推广系列中的广告组满足对于的定向要求,参见使用特殊广告分类的推广系列中广告组的定向要求。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/adgroup/update/|/v1.3/adgroup/update/|
|请求参数名称|<br>`age`<br>`operation_system`<br>`connection_type`<br>`device_price`<br>`android_osv`<br>`ios_osv`<br>`ios_target_device`<br>`bid`<br>`conversion_bid` <br>`deep_cpabid`<br>`daily_retention_ratio`<br>`action_v2`<br>`user_actions`<br>`include_custom_actions` <br>`exclude_custom_actions`<br>`dpa_retargeting_type`<br>`dpa_retargeting_actions_days`<br>`enable_expansion`<br>`ad_app_profile_page_type`|<br>`age_groups`<br> `operating_systems`<br> `network_types`<br>`device_price_ranges`<br>`min_android_version`<br>`min_ios_version`<br>`ios14_targeting`<br>`bid_price`<br>`conversion_bid_price`<br>`deep_cpa_bid`<br>`next_day_retention`<br>`actions`<br>`video_user_actions`<br>`included_custom_actions` <br>`excluded_custom_actions` <br>`shopping_ads_retargeting_type`<br>` shopping_ads_retargeting_actions_days`<br> `expansion_enabled`<br> `adgroup_app_profile_page_state`|
|请求参数类型|`advertiser_id`: number<br>`adgroup_id`: number|`advertiser_id`: string <br>`adgroup_id`: string|
|请求参数名称和类型|`is_comment_disable`: number<br> `audience`: number[]<br> `excluded_audience`: number[] <br>`location`: number[]<br>`interest_category_v2`: number[]<br>`interest_keywords`: number[]<br>`device_models`: number[]<br>`carriers_v2`: number[]<br> `pangle_block_app_list_id`: number[]<br> `action_categories`: number[]<br> `pangle_audience_package_include`: number[]<br> `pangle_audience_package_exclude`: number[]<br>`catalog_authorized_bc`: number<br>`automated_targeting`: string|`comment_disabled`: boolean<br> `audience_ids`: string[]<br> `excluded_audience_ids`: string[]<br> `location_ids`: string[]<br>`interest_category_ids`: string[]<br>` interest_keyword_ids `: string[]<br>` device_model_ids `: string[]<br>`carrier_ids`: string[]<br> `blocked_pangle_app_ids`: <br>string[]<br> `action_category_ids`: string[]<br> ` included_pangle_audience_package_ids`: string[]<br> ` excluded_pangle_audience_package_ids`: string[]<br>`catalog_authorized_bc_id`: string<br>`auto_targeting_enabled`: boolean|
|废弃请求参数|/ |`carriers`|
|新增请求参数 |/|`contextual_tag_ids`<br> `purchase_intention_keyword_ids`<br>`spending_power` <br>`share_disabled` <br>`zipcode_ids`<br> `isp_ids`<br>`shopping_ads_retargeting_custom_audience_relation`<br>`saved_audience_id`<br>`smart_audience_enabled`<br>`smart_interest_behavior_enabled`<br>`brand_safety_type`<br>`category_exclusion_ids`<br>`vertical_sensitivity_id`<br>`exclude_age_under_eighteen` <br> `deep_funnel_optimization_status` <br>`deep_funnel_event_source` <br> `deep_funnel_event_source_id` <br>`deep_funnel_optimization_event`<br> `search_result_enabled`<br> `search_keywords`<br> `automated_keywords_enabled` <br> `is_lhf_compliance`|
|返回参数|/ | 在v1.3中,系统将返回广告实体的完整信息。详情请参阅本页面的返回部分。|
|废弃返回参数|/ |`need_audit`|
请求
地址 https://business-api.tiktok.com/open_api/v1.3/adgroup/update/
方法 POST
Header
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求消息类型<br>允许值: `""application/json""`。 |
参数
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|advertiser_id {必填}|string|广告主ID|
|adgroup_id {必填}|string| 广告组ID |
|adgroup_name |string|广告组名,长度小于 512 字符,不能包含emoji。|
|catalog_authorized_bc_id {+条件必填}|string| 如果要操作的是已经资产化的商品库,本字段会返回相应的商务中心ID。<br><br><p><span style="color:darkred"><b>注意</b></span>:自 2024 年 6 月 30 日起,将不再支持更新 `product_source` 为 `STORE` 的购物广告的 `catalog_authorized_bc_id`,传入的 `catalog_authorized_bc_id` 字段将被忽略。若您更新存量的 `product_source` 为 `STORE` 的购物广告组,且广告组已绑定 `catalog_authorized_bc_id` ,则绑定的 `catalog_authorized_bc_id` 将清空且该`catalog_authorized_bc_id` 字段将不再返回。|
| deep_funnel_optimization_status| string | 仅当 `promotion_type` 为 `LEAD_GENERATION` 时本字段生效 。 <br> <br> 深层漏斗优化的状态。 <br> 深层漏斗优化同时优化浅层和深层漏斗事件。您可以在主要优化事件之外再选择一个次要事件,这有助于提升推广系列的效果。 <br> <br> 枚举值: <ul><li>`ON` :启用深层漏斗优化。 </li><li>`OFF`:不启用深层漏斗优化。 </li></ul> 默认值:`OFF`。 <br><br>若想了解如何在线索广告中配置深层漏斗优化,可查看[创建优化位置为即时表单的线索广告](1774482920012801.html)和[创建优化位置为落地页的线索广告](1774482976097281.html)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>使用 CRM 事件组的深层漏斗优化目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li><li>使用 Pixel 或线下事件组的深层漏斗优化已全量发布。</li></ul> |
| deep_funnel_event_source {+条件必填} | string | `deep_funnel_optimization_status` 为 `ON` 时本字段必填。 <br><br> 事件源类型。 <br><br>枚举值: <ul><li> `PIXEL`:Pixel。</li><li>`OFFLINE`:线下事件组。</li><li>`CRM`:CRM 事件组。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>:深层漏斗优化已启用时,不支持更新 `deep_funnel_event_source`、`deep_funnel_event_source_id` 和`deep_funnel_optimization_event`。|
| deep_funnel_event_source_id{+条件必填} | string | `deep_funnel_optimization_status` 为 `ON` 时本字段必填。<br><br> 事件源 ID。 <br><br><ul><li> `deep_funnel_event_source` 为 `PIXEL` 时,通过本字段指定一个 Pixel ID。<ul><li>若想获取 Pixel 列表,可使用 [/pixel/list/](1740858697598978.html)。</li></ul></li><li>`deep_funnel_event_source` 为 `OFFLINE` 时,通过本字段指定一个线下事件组 ID。<ul><li>若想获取线下事件组 ID 列表,可使用 [/offline/get](1765596808589313.html)。 </li></ul></li><li>当`deep_funnel_event_source`为`CRM`时,通过本字段指定一个 CRM 事件组。<ul><li>若想获取 CRM 事件组 ID 列表,可使用[/crm/list/](1780896521680898.html)。</li></ul></li></ul><br><p><span style="color:darkred"><b>注意</b></span>:深层漏斗优化已启用时,不支持更新 `deep_funnel_event_source`、`deep_funnel_event_source_id` 和`deep_funnel_optimization_event`。|
| deep_funnel_optimization_event {+条件必填} | string | `deep_funnel_optimization_status` 为 `ON` 时 本字段必填。 <br><br> 深层漏斗优化事件。 <br><br><ul><li>若想获取 Pixel、线下事件组和 CRM 事件组支持的标准事件值,可查看[ Pixel 事件类型](1739585696931842.html)中的“<b>用于广告创编的事件名称</b>”列。</li><li>若想获取某个 Pixel 的优化事件,可使用 [/pixel/list/](1740858697598978.html) 并查看返回的 `optimization_event`。</li></ul> <br>示例: `SHOPPING`。 <br><br><p><span style="color:darkred"><b>注意</b></span>:深层漏斗优化已启用时,不支持更新 `deep_funnel_event_source`、`deep_funnel_event_source_id` 和`deep_funnel_optimization_event`。 |
|search_result_enabled|boolean|是否在搜索广告中展示您的广告,即当用户在 TikTok 上搜索您的业务相关信息时,系统是否向他们展示您的广告。<br><br>仅支持满足以下条件时使用本字段:<ul><li>推广目标:推广目标 (`objective_type`) 为以下目标之一: `APP_PROMOTION`,`WEB_CONVERSIONS` (`is_search_campaign` 需为 `false`),`TRAFFIC`,和 `LEAD_GENERATION`。<ul><li>当 `objective_type` 为 `LEAD_GENERATION` 时,`promotion_type` 需设置为 `LEAD_GENERATION`。</li></ul></li><li>版位:`placement_type` 为 `PLACEMENT_TYPE_AUTOMATIC`,或 `placement_type` 为 `PLACEMENT_TYPE_NORMAL` 且 `placements` 的值中包含 `PLACEMENT_TIKTOK`。</li><li>您想将本字段的值从 `false` 更新为 `true`。</li></ul><br>若 `is_search_campaign` 为 `true`,不支持将本字段从 `false` 设置为 `true`。<br><br>若想了解搜索广告详情,请查看[自动搜索广告位](1771747626094593.html)。
|automated_keywords_enabled|boolean|仅在满足推广系列层级 `is_search_campaign` 为 `true` 时生效。<br><br>是否启用自动关键词,即在添加广告后,让系统自动生成关键词。这样可以拓展优质流量,以便提升成效。在报表中查看成效出色的自动关键词。<br><br>支持的值:`true`,`false`。<br>默认值:`false`。<br><br><p><span style="color:darkred"><b>注意</b></span>: <ul><li>搜索广告推广系列中启用自动关键词目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li></ul>|
|search_keywords|object[]|仅支持在搜索广告推广系列中使用。<br><br>搜索关键词列表,即用于与人们搜索的词语匹配,以展示您的广告的一组搜索关键词,可以是词或词组。<br><br>最大数量:1,000。<br><br>若想确认某一推广系列是否为搜索广告推广系列,可使用[/campaign/get/](1739315828649986.html)并查看为该推广系列返回的 `is_search_campaign`。<br><br>若想了解搜索广告推广系列详情,请查看[创建搜索广告推广系列](1815394136739841.html)。<br><br><p><span style="color:darkred"><b>注意</b></span>: <ul><li>支持为单个广告组配置最多 1,000 个搜索关键词。</li><li>若更新了搜索关键词或定向地域,搜索关键词将重新进入审核。</li></ul>|
#|keyword{+条件必填}|string|传入 `search_keywords` 时,需至少提供一个 `keyword` 及对应的 `match_type`。<br><br>搜索关键词。<br><br>长度限制:80 个字符。<br>名称中不可使用表情符号和以下特殊字符:`!` `#` `$` `%` `&` `(` `)` `*` `-` `/` `:` `;` `<` `>` `?` `@` `\` `^` `_` `¥` `……`。否则会出现报错提示。<br><br>若想获取搜索关键词的审核结果,需调用[/adgroup/get/](1739314558673922.html),检查返回的对象数组 `search_keywords` 中的 `audit_status` 字段。<br><br><p><span style="color:DarkRed"><b>重要</b></span>: 搜索关键词必须遵守 TikTok 的[广告投放条款](https://ads.tiktok.com/help/article/advertising-on-tiktok-first-things-to-note)和社区守则。 <ul><li>若您的关键词被全部判定为违反这些守则,相应的推广系列将不会投放。</li><li>若您的部分关键词未通过审核,请使用[/adgroup/update/](1739586761631745.html)删除违规关键词或更换为恰当的替代关键词。您的推广系列将使用通过审核的关键词继续投放。</li></ul>|
#|match_type{+条件必填}|string|传入 `search_keywords` 时,需至少提供一个 `keyword` 及对应的 `match_type`。<br><br>搜索关键词对应的匹配类型。<br><br>枚举值:<ul><li>`PRECISE_WORD`:精确匹配。您的广告将会在用户的搜索词与这些关键词完全匹配时展示。</li><li>`PHRASE_WORD`:词组匹配。您的广告将会在用户以相同词序搜索这些关键词时展示。</li><li>`BROAD_WORD`:广泛匹配。您的广告将会在用户搜索这些关键词中的任意词时展示,无论词序是否相同。</li></ul>|
#|keyword_bid_type|string|关键词和匹配类型组合的出价类型。<br><br>枚举值:<ul><li>`FOLLOW_ADGROUP`:使用广告组层级的出价(`bid_price`)作为 `keyword_bid`。</li><li>`CUSTOM`:通过 `keyword_bid` 自定义出价。</li></ul><br>默认值:`FOLLOW_ADGROUP`。<br><br>仅当满足以下条件时支持使用枚举值 `CUSTOM`:<ul><li>推广系列层级:<ul><li>`objective_type` 为 `TRAFFIC`</li><li>`is_search_campaign` 为 `true`。</li></ul></li><li>广告组层级:<ul><li>`bid_type` 为 `BID_TYPE_CUSTOM`</li><li>`bid_price` 被指定。</li></ul></li></ul>|
#|keyword_bid{+条件必填}|float|<ul><li>仅当 `keyword_bid_type` 为 `CUSTOM` 时本字段生效且必填。</li><li>`keyword_bid_type` 为 `FOLLOW_ADGROUP` 时忽略本字段。</li></ul><br>关键词和匹配类型组合的出价。<br><br>取值范围:>0。|
|comment_disabled |boolean|是否允许用户在 TikTok 上评论您的广告。|
| share_disabled|boolean|是否禁止将本广告组中的广告分享到第三方平台。仅当以下条件均满足时 `True`的值会生效:<ul><li>推广系列层级的`objective_type` 设置为以下推广目标之一: `APP_PROMOTION`,`WEB_CONVERSIONS`, `REACH`, `TRAFFIC`,`VIDEO_VIEWS`,`ENGAGEMENT`, `LEAD_GENERATION`。</li><li>版位:<ul><li>`placement_type`设置为 `PLACEMENT_TYPE_AUTOMATIC` 或</li><li>`placement_type`设置为`PLACEMENT_TYPE_NORMAL`且 `placements` = `PLACEMENT_TIKTOK`</li></ul></li></ul><br><p><span style="color:darkred"><b>注意</b></span>:本字段支持增量更新。|
|blocked_pangle_app_ids |string[]| Pangle 媒体屏蔽列表 ID,可通过[查询 Pangle 媒体屏蔽列表](https://ads.tiktok.com/marketing_api/docs?id=1740039957181441)接口返回的 `app_package_id` 字段获取。仅当版位中含有 Pangle 时生效。 |
|audience_type{+条件必填} |string| <ul><li>仅当推广系列层级 `app_promotion_type` 设置为 `APP_RETARGETING` 时,本字段生效且必填。<br></li><li>推广系列层级 `app_promotion_type` 未设置为 `APP_RETARGETING` 时,不支持本字段。</li></ul><br>应用再营销受众类型。<br><br>设置需要与创建广告组时相同。<br><br>枚举值:`NEW_CUSTOM_AUDIENCE` (再营销自定义受众)。<br><br><ul><li>若您想为应用再营销广告指定空自定义受众,则无需传入 `audience_ids` 和 `excluded_audience_ids`。</li><li>若您想为应用再营销广告指定非空自定义受众,您可以通过 `audience_ids` 仅指定包含受众,或通过`excluded_audience_ids` 仅指定排除受众,或通过 `audience_ids` 和 `excluded_audience_ids` 同时指定包含受众和排除受众。<ul><li> 如果`audience_ids`和`excluded_audience_ids`同时传入,这两个字段不能包含同样的受众 ID。</li></ul></li></ul>|
|audience_rule|object| 受众规则,仅支持`objective_type`为 `TRAFFIC` 或 `APP_PROMOTION`。见[广告管理-广告组-App 受众规则](https://ads.tiktok.com/marketing_api/docs?id=1739566532187138) |
|saved_audience_id |string | 以下情形支持该字段:<ul><li>您的推广系列未选择房地产,就业,信贷行业类型(`specical_industries`)。</li><li><b>且</b>您的推广系列的推广目标(`objective_type`) 不为商品销量(`PRODUCT_SALES`)。</li><li><b>且</b>您的广告组选择TikTok广告位(即`placement_type`设置为`PLACEMENT_TYPE_AUTOMATIC`;<b>或</b>`placement_type`设置为`PLACEMENT_TYPE_NORMAL`且`placements`包含`PLACEMENT_TIKTOK`)。</li><li><b>且</b>您的广告组未使用自动定向(即 `auto_targeting_enabled` 未设置为`true`)。</li></ul><br>已保存受众ID。<br>在使用此字段之前,请调用[/dmp/saved_audience/create/](1780154541898754.html)创建已保存受众,并在返回中获取已保存受众ID。与您的已保存受众关联的广告主ID应与广告组中的广告主ID相同。否则,将会出现错误。<br>如果您使用`saved_audience_id`创建广告组,将返回已保存受众ID和包含在已保存受众中的定向选项。 <br>请参阅[创建已保存受众](1780156510696449.html)以了解详细的流程和代码示例。 <br><span style="color:darkred"><b>注意</b></span>:<ul><li>通过[/dmp/saved_audience/create/](1780154541898754.html)创建已保存受众时,您可以指定`gender`等定向选项。但是,如果您使用已保存受众创建广告组,则必须避免同时设置`saved_audience_id`和已保存受众中已有的定向选项(如`gender`)。否则,将会出现错误。</li><li>如果您的已保存受众的设备设置与广告组的设备设置冲突,则会出现错误。例如:<ul><li> 当您的已保存受众的操作系统为Android时,但在创建广告组时,您将`ios14_targeting`设置为`IOS14_PLUS`。</li><li>当您在广告组中使用Android应用程序的App ID,且将`objective_type`字段指定为`APP_PROMOTION`,但您的已保存受众操作系统为iOS。</li></ul></li><li>如果您的API请求引发与已保存受众配置和广告组配置之间冲突相关的错误,则当前错误消息将指示问题涉及您的受众定向选项。为解决此问题,建议使用[/dmp/saved_audience/list/](1780154541898754.html)检查相应定向选项的详细信息,以确定问题的来源,必要时创建新的已保存受众。</li><li>若`saved_audience_id` 创建时设置了`age_groups`, [TikTok 广告的新增年龄定向限制](1788755983247362.html)中针对不同推广目标的年龄限制规定将也适用于该保存受众。在广告组中使用保存受众前,请确保其年龄定向合法。</li></ul>|
|auto_targeting_enabled{-即将废弃}|boolean|是否开启自动定向。<br><br><p><span style="color:darkred"><b>注意</b></span>:自 2024 年 6 月起,您将无法为广告组开启自动定向或定向扩量。为保证流畅的 API 体验,我们建议您使用[智能定向](1783164662979586.html)。|
| shopping_ads_retargeting_type | string | 当`shopping_ads_type` 设置为 `VIDEO` 且 `product_source` 设置为 `CATALOG` 时有效。<br><br>购物广告受众再营销类型。<br><br>枚举值:<ul><li>`LAB1` : 对浏览过商品或者将商品加过购物车,但未购买过商品的受众进行再营销。 </li><li>`LAB2`:对将商品加过购物车,但未购买过商品的受众进行再营销。</li><li>`LAB3` : 使用自定义条件组合对受众进行再营销。</li><li>`OFF` : 不进行受众再营销。</li></ul> |
| shopping_ads_retargeting_actions_days{+条件必填} | number | `shopping_ads_retargeting_type` 为`LAB1`或`LAB2`时必填。 <br><br>所指定的受众行为的有效时间范围。在该时间范围内完成所指定行为的受众将成为购物广告受众再营销的对象。<br><br>取值范围:1,2,3,7, 14,30,60,90,180。|
| included_custom_actions {+条件必填} | object[] | 当 `shopping_ads_retargeting_type` 为`LAB3`时,您需要传入`included_custom_actions` 和 `excluded_custom_actions` 其中之一。<br><br>作为包含条件筛选购物广告受众再营销对象的自定义行为。|
#| code | string | 用于筛选出受众再营销对象的自定义行为。<br><br>枚举值:<ul><li>`VIEW_PRODUCT`:受众浏览过商品。</li><li>`ADD_TO_CART` : 受众将商品加过购物车。</li><li>`PURCHASE` : 受众购买过商品。</li></ul>|
#| days | integer | 用于筛选出完成了自定义行为的受众的时间区间。<br><br>取值范围:[1,180]。|
| excluded_custom_actions {+条件必填} | object[] |当 `shopping_ads_retargeting_type` 为`LAB3`时,您需要传入`included_custom_actions` 和 `excluded_custom_actions` 其中之一。<br><br>作为排除条件筛选购物广告受众再营销对象的自定义行为。|
#| code | string | 用于筛选出受众再营销对象的自定义行为。<br><br>枚举值:<ul><li>`VIEW_PRODUCT`:受众浏览过商品。</li><li>`ADD_TO_CART` : 受众将商品加过购物车。</li><li>`PURCHASE` : 受众购买过商品。</li></ul>|
#| days | integer | 用于筛选出未完成自定义行为的受众的时间区间。<br><br>取值范围:[1,180]。|
| shopping_ads_retargeting_custom_audience_relation | string | 仅当以下条件均满足时生效: <ul><li>`shopping_ads_type` 设置为 `VIDEO`。</li><li>`product_source`设置为 `CATALOG`。</li><li>传入`shopping_ads_retargeting_type` 且将其设置为`LAB1`,`LAB2` 或 `LAB3`。</li><li>传入`audience_ids` 。</li></ul><br>由 `shopping_ads_retargeting_type` 字段指定的视频购物广告重定向受众与由 `audience_ids` 指定的自定义受众间的逻辑关系。<br><br>枚举值:<ul><li> `OR`:取视频购物广告重定向受众和自定义受众的并集构建定向受众。定向受众中包含属于视频购物广告重定向受众或自定义受众的人群。</li><li> `AND`:取视频购物广告重定向受众和自定义受众的交集构建定向受众。定向受众中仅包含同时属于视频购物广告重定向受众和自定义受众的人群。</li></ul> <br><br><p><span style="color:darkred"><b>注意</b></span>:若您指定了`shopping_ads_retargeting_custom_audience_relation`字段后又移除了自定义受众,则本字段将会自动设置为 null 值。 |
|location_ids |string[]|您想要定向的地域ID列表。<br>您可传入`location_ids`或`zipcode_ids`,或同时传入`location_ids`和`zipcode_ids`。<br><br>最大数量:3,000。若同时传入 `location_ids` 和 `zipcode_ids`,则单个广告组中地域 ID 和邮政编码 ID 的数量之和不可超过 3,000。<br><br>您可以使用[/tool/targeting/search/](https://ads.tiktok.com/marketing_api/docs?id=1761236883355649) 或 [/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713)接口,根据您的版位和推广目标来查询您可以投放的地区以及相应 ID。ID列表也可以通过 [附录-地域定向](https://ads.tiktok.com/marketing_api/docs?id=1739311040498689)查看。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>定向地域不允许重叠。例如,不支持同时定向美国和加利福尼亚州。</li><li> 若您在创建广告组时通过 `location_ids` 或 `zipcode_ids` 定向了美国地域,您可随后将定向地域更新为美国的其他地域,但不允许从定向地域中完全去除美国地域,从而只定向非美国地域。</li><li>若您创建的广告组的 `tiktok_subplacements` 值中包含 `TIKTOK_LITE`,则不允许更新广告组时从定向地域(`location_ids`)中完全去除日本和韩国地域。</li><li>若您想清除广告组定向的所有地域 ID,需将本字段设置为空数组(`[]`)。需注意广告组中定向地域为必填信息,因此,若您建广告组时仅指定了地域 ID 且想清除这些 ID,需将 `location_ids` 设置为空数组(`[]`)同时通过`zipcode_ids`指定要定向的邮政编码 ID。</li></ul>|
| zipcode_ids |string[]|您想要定向的地域的邮政编码ID。<br>您可传入`location_ids`或`zipcode_ids`,或同时传入`location_ids`和`zipcode_ids`。<br><br>最大数量:3,000。若同时传入 `location_ids` 和 `zipcode_ids`,则单个广告组中地域 ID 和邮政编码 ID 的数量之和不可超过 3,000。<br><br>您可以通过[/tool/targeting/search/](https://ads.tiktok.com/marketing_api/docs?id=1761236883355649) 返回的`geo_id`(对应的`geo_type` 为`ZIP_CODE`)获取可投地域的邮政编码ID,返回结果基于您设置的版位,推广目标和关键词。<br><p><span style="color:darkred"><b>注意</b></span>:<ul><li> 邮政编码定向目前仅支持定向美国、加拿大、巴西、印度尼西亚、泰国、越南的地域。</li><li>巴西、印度尼西亚、泰国、越南的邮政编码定向目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li><li>不支持在启用了特殊广告分类(`special_industries`)的推广系列中使用邮政编码定向。</li><li>不支持在 `objective_type` 为 `RF_REACH` 的推广系列中使用邮政编码定向。</li><li>邮政编码定向仅支持 TikTok 版位。因此,`placements` 的值中不包含 `PLACEMENT_TIKTOK`。</li><li>定向地域不允许重叠。例如,不支持同时定向美国和加利福尼亚州。</li><li> 若您在创建广告组时通过 `location_ids` 或 `zipcode_ids` 定向了美国地域,您可随后将定向地域更新为美国的其他地域,但不允许从定向地域中完全去除美国地域,从而只定向非美国地域。</li><li>若您想清除广告组定向的所有邮政编码 ID,需将本字段设置为空数组(`[]`)。需注意广告组中定向地域为必填信息,因此,若您建广告组时仅指定了邮政编码 ID 且想清除这些 ID,需将 `zipcode_ids` 设置为空数组(`[]`)同时通过`location_ids`指定要定向的地域 ID。</li><li>本字段支持增量更新。</li></ul>|
|languages |string[]|受众语言。<br>枚举值:详见[枚举值-受众语言](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br>您可通过[/tool/language/](https://ads.tiktok.com/marketing_api/docs?id=1737188554152962)获取语言代码。若您不想限制受众语言,可为本字段传空值或不传入本字段。|
|gender |string|定向受众性别。<br>枚举值: `GENDER_FEMALE`,`GENDER_MALE`,`GENDER_UNLIMITED`。|
|age_groups |string[]|定向受众年龄区间。<br><br>枚举值详见[枚举值-受众年龄区间](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138#item-link-受众年龄区间)。<br><br><ul><li>在某些场景下,不允许创建定向美国、拉丁美洲、欧洲经济区、英国、瑞士或加拿大 13-17 年龄区间(`AGE_13_17`)受众的广告组。若想了解详情,请查看 [TikTok 广告的新增年龄定向限制](1788755983247362.html)。</li><li>若您受该限制影响,则在将 `age_groups` 设置为 `[]` 或不传入字段 `age_groups`,且 `exclude_age_under_eighteen` 未设置为 `true` 时,将出现报错。 <ul><li>若您定向美国、拉丁美洲、欧洲经济区、英国、瑞士或加拿大 13-17 年龄区间(`AGE_13_17`)受众且通常将 `age_groups` 设置为 `[]` 或不传入字段 `age_groups`,推荐您同时将 `exclude_age_under_eighteen` 设置为 `true` ,从而避免发生报错。</li></ul></li></ul>|
| exclude_age_under_eighteen | boolean | 是否排除 18 岁以下受众。 <br>请仅在不支持定向美国、拉丁美洲、欧洲经济区、英国、瑞士或加拿大 13-17 年龄区间(`AGE_13_17`)受众时使用本字段,其他场景下该字段无效。详情参考`age_groups` 字段的描述。 <br><br>枚举值:`true`, `false`。 默认值:`false`。 |
|spending_power|string|消费能力。<br><br>枚举值:`ALL`, `HIGH`。<br>如果设为`HIGH`,您就可以定向和普通用户相比 TikTok 广告投入支出通常更多的高消费能力用户。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>本字段不支持推广目标`PRODUCT_SALES`和`RF_REACH`。</li><li>本字段支持自动版位和包含 TikTok 的手动版位。因此,您需将 `placement_type`设置为 `PLACEMENT_TYPE_AUTOMATIC`,或在`placements`的值中包含`PLACEMENT_TIKTOK`。需注意,即使您指定了 Pangle 版位,消费能力定向也不会在 Pangle 版位生效。</li><li>如果在广告组层级,`auto_targeting_enabled` 设为 `true`,那么该字段会自动设为`ALL`。</li></ul>|
|household_income| string[]| 您想定向的收入群体。枚举值:`TOP5`(家庭收入群体的前5%), `TOP10`(家庭收入群体的前10%),`TOP10_25`(家庭收入群体的前10-25%), `TOP25_50`(家庭收入群体的前25-50%). <br>注意: <ul><li> 该字段仅支持竞价广告。参考[推广目标](https://ads.tiktok.com/marketing_api/docs?id=1737585562434561)了解详情。</li><li> 该字段仅支持美国TikTok版位。</li></ul> |
|audience_ids|string[]|受众 ID 列表。您可以使用[/dmp/custom_audience/list/](https://ads.tiktok.com/marketing_api/docs?id=1739940506015746)接口获取受众ID。|
| smart_audience_enabled | boolean | 是否启用智能受众。 <br><br>枚举值: `true`, `false`。 <br><br>若想了解智能受众详情及如何启用智能受众,请查看[智能定向](1783164662979586.html)。 |
|excluded_audience_ids|string[]|排除受众 ID 列表。您可以通过[/dmp/custom_audience/list/](https://ads.tiktok.com/marketing_api/docs?id=1739940506015746)接口进获取受众ID。|
|interest_category_ids |string[]|用于定向受众的一般兴趣分类 ID 列表。<br><br><ul><li>若想搜索或列举一般兴趣分类 ID,可使用[/targeting/search/](1796638342793218.html)(推荐)或 [/tool/interest_category/](https://ads.tiktok.com/marketing_api/docs?id=1737174348712961)。</li><li>若想获取基于您所在行业的推荐兴趣分类 ID 列表,可使用[/tool/targeting_category/recommend/](1736275204260866.html)。</li></ul>|
|interest_keyword_ids|string[]|用于定向受众的其他兴趣分类 ID 列表。<br><br>若想搜索其他兴趣分类 ID,可使用[/targeting/search/](1796638342793218.html)(推荐)或[/tool/interest_keyword/recommend/](https://ads.tiktok.com/marketing_api/docs?id=1763590884474882)。|
|purchase_intention_keyword_ids|string[]| 购买意向分类 ID 列表,用于定向近期行为表明其可能会购买某内容类别相关产品的受众。 <br><br>若想搜索或列举购买意向分类 ID,可使用[/targeting/search/](1796638342793218.html)。<br><br><p><span style="color:darkred"><b>注意</b></span>:本接口支持`purchase_intention_keyword_ids`的增量更新。|
|actions| object[] |用于定向的行为分类对象数组。 |
#|action_scene |string| 用于定向的用户行为种类。<br><br>枚举值:<ul><li>`VIDEO_RELATED`:视频互动。</li><li>`CREATOR_RELATED`:创作者互动。</li><li>`HASHTAG_RELATED`:话题互动。</li></ul> |
#|action_period |number| 选择n天内发生的行为。<br><br>枚举值: `0`,`7`, `15`。如果`action_scene`为`CREATOR_RELATED`或`HASHTAG_RELATED`,不论您传入何值,系统将默认使用`0`。`0`表示不设置行为发生的明确时间范围。 <br><br><span style="color:darkred"><b>注意</b></span>:目前,通过<b>TikTok广告管理平台</b>更新带有视频互动定向(`action_scene`= `VIDEO_RELATED`)广告组时,您无法更新行为时间范围(`action_period`)。但是,通过<b>API</b>更新广告组时,仍然可以传入`0`,`7`或`15`。|
#|video_user_actions |string[]| 所选用户行为种类下想要定向的的具体用户行为。<br><br><ul><li>若`action_scene`为`VIDEO_RELATED`,枚举值为:`WATCHED_TO_END`(完播),`LIKED`(点赞),`COMMENTED`(评论),`SHARED`(分享)。 </li><li>若`action_scene`为`CREATOR_RELATED`,枚举值为:`FOLLOWING`(关注),`VIEW_HOMEPAGE`(浏览主页)。</li><li>若`action_scene`为`HASHTAG_RELATED`,枚举值为: `VIEW_HASHTAG`(浏览话题标签)。</li></ul> <br><p><span style="color:darkred"><b>注意</b></span>:目前,通过<b>TikTok广告管理平台</b>更新广告组时,您无法更新用户行为种类 (`video_user_actions`)。但是,通过<b>API</b>更新广告组时,您可以传入您想要的枚举值组合,例如:当`action_scene`=`VIDEO_RELATED`时传入`["LIKED","COMMENTED"]` 。|
#|action_category_ids |string[]| 仅当仅选择 TikTok 版位投放时生效。<br><br>用于定向受众的视频互动分类 ID、创作者互动分类 ID、话题标签 ID 或话题包 ID 列表。<br><br><ul><li>若想搜索或列举视频互动分类 ID 或创作者互动分类 ID,可使用[/targeting/search/](1796638342793218.html)(推荐)或 [/tool/action_category/](https://ads.tiktok.com/marketing_api/docs?id=1737166752522241) 。</li><li>若想获取话题标签 ID 或话题包 ID,可使用[/targeting/search/](1796638342793218.html)(推荐)或 [/tool/hashtag/recommend/](https://ads.tiktok.com/marketing_api/docs?id=1736271339521025)。</li><li>若想获取基于您所在行业的推荐视频互动分类 ID、创作者互动分类 ID、话题标签 ID 或话题包 ID 列表,可使用[/tool/targeting_category/recommend/](1736275204260866.html)。</li></ul>|
| smart_interest_behavior_enabled | boolean | 是否启用智能型兴趣和行为。<br><br>枚举值: `true`, `false`。 <br><br>若想了解智能型兴趣和行为详情及如何启用智能型兴趣和行为,请查看[智能定向](1783164662979586.html)。 |
|included_pangle_audience_package_ids |string[]| 包含 Pangle 流量包 ID。您可以使用接口[/pangle_audience_package/get/](https://ads.tiktok.com/marketing_api/docs?id=1740040177229826)获取受众ID (`package_id`) 。`bind_type`设置为`INCLUDE`。请不要同时传入该字段和`excluded_pangle_audience_package_ids`。|
|excluded_pangle_audience_package_ids |string[]| 排除 Pangle 流量包 ID。您可以使用接口[/pangle_audience_package/get/](https://ads.tiktok.com/marketing_api/docs?id=1740040177229826)获取受众ID (`package_id`) 。`bind_type`设置为`EXCLUDE`。请不要同时传入该字段和`included_pangle_audience_package_ids`。 |
|operating_systems{+条件必填}|string[]|受众操作系统。<br><br>仅支持传入一个值。<br><br>枚举值:`ANDROID`, `IOS`。<br><br>本字段在以下场景必填: <ul><li>`objective_type` 为 `APP_PROMOTION`时</li><li>`objective_type` 为`TRAFFIC` 且 `promotion_type` 为 `APP_IOS` 或 `APP_ANDROID` 时</li></ul>|
|min_android_version|string|受众最低Android版本。枚举值:详见[枚举值-最低Android版本](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
|ios14_targeting{+条件必填}|string|推广系列的`campaign_type`为 `IOS14_CAMPAIGN` 时, 本字段必填,且必须设置为 `IOS14_PLUS`。<br><br>您想定向的iOS设备版本。<br><br>枚举值:<ul><li>`UNSET`: 运行 iOS 14.4 及更早版本的设备。</li><li>`IOS14_MINUS`: 不受 iOS 14 新的 ATT 框架影响的iOS设备(运行比 iOS 14.0 更早版本的设备)。</li><li>`IOS14_PLUS`: 运行 iOS 14.5 及之后版本、已执行 ATT 框架的 iOS 设备。此值仅支持在专属推广系列中使用。若想创建 iOS 14 推广系列,需将`ios14_targeting`字段设置为`IOS14_PLUS`,每个 iOS 14 推广系列允许存在最多 2 个启用状态的广告组。</li><li>`ALL`:运行 iOS 14.5 及之后版本的设备。此值仅支持在 iOS 应用再营销广告或 iOS 重定向类型的视频购物广告(商品来源为商品库且优化位置为应用)中使用。<ul><li>若想在应用再营销广告中定向 iOS 14.5 及以后版本的设备,需将`ios14_targeting`设置为 `ALL` 且将 `min_ios_version` 设置为`14.5`或之后版本。</li><li>若想在应用再营销广告中定向 iOS 14.4 及更早版本的设备,无需传入`ios14_targeting`。</li></ul></li> </ul><br>对于以下两种场景,将忽略您的传参,并将本字段设置为 `ALL`。<ul><li>iOS 应用再营销广告:<ul><li>`app_promotion_type` 为 `APP_RETARGETING`</li><li>且 `promotion_type` 为 `APP_IOS`</li></ul></li><li>iOS 重定向类型的视频购物广告(商品来源为商品库且优化位置为应用):<ul><li>`shopping_ads_type` 为 `VIDEO`</li><li> `product_source` 为 `CATALOG`</li><li> `promotion_type` 为 `APP_IOS`</li><li>且 `shopping_ads_retargeting_type` 非 `OFF`</li></ul></li></ul>对于其他场景,默认值为 `UNSET`。<br><br> 本字段设置为 `IOS14_PLUS` 后不允许更新,且需满足以下条件:<ul><li>广告组层级:<ul><li>`app_id` 字段设置为 iOS App 的 ID。<br>若想获取iOS App 的 ID,可使用[/app/list/](1740859313270786.html)。 iOS App 对应的`platform` 为 `IOS` 。 </li><li>`operating_systems` 字段设置为` ["IOS"]`。</li><li>传入 `min_ios_version` 字段,且字段值与`ios14_targeting` 字段的值相匹配。</li><li>`optimization_goal` 字段设置为 `CLICK`,`INSTALL`,`IN_APP_EVENT`或`VALUE` 。</li><li>不传入以下字段:<ul><li> `min_android_version`</li><li>`shopping_ads_retargeting_type` </li><li>`shopping_ads_retargeting_actions_days`</li></ul> </li></ul> </li><li>广告层级:<ul><li> `deeplink_type` 字段不可设置为 `DEFERRED_DEEPLINK` 。</li></ul></li></ul>|
|min_ios_version{+条件必填}|string|传入 `ios14_targeting` 时,本字段必填。<br><br>受众最低 iOS 版本。<br><br>枚举值详见[枚举值-最低iOS版本](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
|device_model_ids| string[]| 设备机型ID列表。可参考[/tool/device_model/](https://ads.tiktok.com/marketing_api/docs?id=1737172880570369)获取设备机型ID和状态的更多信息。创建广告时需确保对应设备处于活跃状态( [/tool/device_model/](https://ads.tiktok.com/marketing_api/docs?id=1737172880570369) 接口返回中`is_active` 为 `True`)。 <br><p><span style="color:darkred"><b>注意</b></span>: 不可同时设置设备机型 (`device_model_ids`) 和设备价格(`device_price_ranges`) 。|
|network_types|string[]|网络类型。<br>枚举值:`WIFI`,`2G`,`3G`,`4G`详见[枚举值-受众网络类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
|carrier_ids |string[]| 运营商ID。 只有当运营商`in_use`字段为`true`时生效。获取详细信息,参阅[获取运营商列表](https://ads.tiktok.com/marketing_api/docs?id=1737168013095938)。|
| isp_ids | string[] | 想定向的互联网服务提供商的ID。<br>仅当同时通过`location_ids`传入有效的国家或地区层级的地域ID时生效。<br>您可通过[/tool/targeting/list/](https://ads.tiktok.com/marketing_api/docs?id=1762962378261506)获取地域ID对应的可定向的互联网服务提供商ID。<br><p><span style="color:darkred"><b>注意</b></span>:若传入 `isp_ids`,不支持将版位设置为仅全球化应用组合(`placements` =`PLACEMENT_GLOBAL_APP_BUNDLE`)。|
|device_price_ranges |number[]|设备价格区间(10000代表1000+)。该数字必须是50的倍数。<br><b><span style="color: darkred">重要提示</span></b>: 最终的实际上限将在您设定的上限基础上增加50,您可以在TikTok广告管理平台的广告组设置中看到实际上限。例如,如果您设置的价格区间是[0, 250],实际区间则为[0, 300]。|
|targeting_expansion{-即将废弃}| object | 定向扩量设置。<br><br><p><span style="color:darkred"><b>注意</b></span>:自 2024 年 6 月起,您将无法为广告组开启自动定向或定向扩量。为保证流畅的 API 体验,我们建议您使用[智能定向](1783164662979586.html)。|
#|expansion_enabled|boolean| 是否开启定向扩量。 |
#|expansion_types {+条件必填}|string[]| 您想要进行扩量的定向受众类型。当`expansion_enabled`为`true`时必传。可进行扩量的受众条件必须已设定值(不能为无限制)。枚举值: <ul><li>`AGE`</li><li>`GENDER`</li><li>`INTEREST_AND_BEHAVIOR`: 本类型包括`ad_tag_v2`, `video_action`, `action_days`, `action_categories`和`action_scene`。</li><li>`CUSTOM_AUDIENCE`: 本类型包括`retargeting_tags`和`retargeting_tags_exclude`。 </li></ul>|
|contextual_tag_ids |string[] | 内容相关定向标签ID列表。您可使用 [/tool/contextual_tag/get/](https://ads.tiktok.com/marketing_api/docs?id=1747747118654465) 获取可用的内容相关定向标签。请查看[内容相关定向](https://ads.tiktok.com/marketing_api/docs?id=1745292519923713)了解如何使用内容相关定向。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>本字段目前为白名单功能。如需使用此功能,请联系您的TikTok销售代表。</li><li>仅支持推广系列的推广目标为`REACH` 和 `VIDEO_VIEWS` 。</li><li>不支持同时将`brand_safety_type` 设置为`THIRD_PARTY` 。</li></ul>|
|brand_safety_type|string|若想了解更新本字段的前提条件,请查看[更新出价前品牌安全筛选设置的前提条件](https://business-api.tiktok.com/portal/docs?id=1739381752981505#item-link-更新出价前品牌安全筛选设置的前提条件)。<br><br>品牌安全类型。<br><br>枚举值: <ul><li>`EXPANDED_INVENTORY`:使用TikTok的品牌安全解决方案,即使用<b>扩展库存</b>。您的广告将不会出现在不当内容或包含成人主题的内容后面。在下个API版本中`EXPANDED_INVENTORY`将替代`NO_BRAND_SAFETY`,并成为默认的品牌安全选项。</li><li>`STANDARD_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>标准库存</strong>。您的广告将展示在适合大多数品牌的内容周围。 </li><li>`LIMITED_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>有限库存</strong>。您的广告将展示在不包含成人主题的内容周围。</li></ul>您可以使用[/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713)接口查询品牌安全设置对应的广告可投放国家或地区。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>更新品牌安全设置(包括`brand_safety_type`,`category_exclusion_ids` 和 `vertical_sensitivity_id`)目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li><li>在使用`APP_PROMOTION`,`WEB_CONVERSIONS`,`TRAFFIC`,`LEAD_GENERATION`,或 `PRODUCT_SALES`推广目标的竞价广告中应用出价前第一方品牌安全解决方案目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li><li> 请查看[品牌安全](https://ads.tiktok.com/marketing_api/docs?id=1739381752981505),了解出价前品牌安全筛选的支持推广目标,支持市场以及简要介绍。</li></ul>|
|category_exclusion_ids|string[]|仅支持满足以下任意条件时更新本字段:<ul><li>未到广告组的排期开始时间(`schedule_start_time`)。</li><li>已到广告组的排期开始时间(`schedule_start_time`),但`operation_status`为`DISABLE` 且消耗为 0 。若想获取广告组的`schedule_start_time` 和 `operation_status`,可使用[/adgroup/get/](1739314558673922.html)。</li></ul><br>内容排除类别 ID 列表。 <br>您可以使用[/tool/content_exclusion/get/](1769738074686465.html)来获取内容类别 ID 列表(`excluded_category_list`),ID可以用于指定某内容类别,避免您的广告出现在该内容类型周围。<br><br><p><span style="color:darkred"><b>注意</b></span>:更新品牌安全设置(包括`brand_safety_type`,`category_exclusion_ids` 和 `vertical_sensitivity_id`)目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。</li>|
|vertical_sensitivity_id|string|仅支持满足以下任意条件时更新本字段:<ul><li>未到广告组的排期开始时间(`schedule_start_time`)。</li><li>已到广告组的排期开始时间(`schedule_start_time`),但`operation_status`为`DISABLE` 且 消耗为 0 。若想获取广告组的`schedule_start_time` 和 `operation_status`,可使用[/adgroup/get/](1739314558673922.html)。</li></ul><br>行业敏感内容控制类别 ID。<br>您可以使用[/tool/content_exclusion/get/](1769738074686465.html) 获取包含敏感内容的行业类别(`vertical_sensitivity_list`),防止某类别出现在您的广告周围。<br><br><p><span style="color:darkred"><b>注意</b></span>:更新品牌安全设置(包括`brand_safety_type`,`category_exclusion_ids` 和 `vertical_sensitivity_id`)目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。|
|budget |float|广告预算类型 。<br>当开启推广系列预算优化时,本字段不可修改。<br>欲了解最低预算以及如何设置预算类型,请参阅[预算](https://ads.tiktok.com/marketing_api/docs?id=1739381246298114)。欲直接获取某一币种对应的每日预算取值范围,请参阅[币种-每日预算取值范围](https://ads.tiktok.com/marketing_api/docs?id=1737585839634433)。<br><p><span style="color:darkred"><b>注意</b></span>:新预算需至少为当前消耗的105%。您可以请求[同步报表](https://ads.tiktok.com/marketing_api/docs?id=1740302848100353)或[异步报表](https://ads.tiktok.com/marketing_api/docs?id=1740302766489602),通过基础数据指标`spend`获取消耗数据。|
|schedule_type |string|广告投放时间类型。<br><br>枚举值: `SCHEDULE_FROM_NOW`,`SCHEDULE_START_END`。<ul><li>如果您选择了`SCHEDULE_START_END`,您需要明确投放开始和结束时间。</li><li>如果您选择了`SCHEDULE_FROM_NOW`,您只需要明确投放开始时间,结束时间将自动设置为开始时间十年后的时间。</li></ul> |
|schedule_start_time {+条件必填}|datetime| 传入`schedule_type`时必填。<br><br>广告投放起始时间(UTC+0),格式为`"YYYY-MM-DD HH:MM:SS"`。起始时间可以早于目前时间,但是最多只能早12个小时且不得晚于 `"2028-01-01 00:00:00"`。<br><br><p><span style="color:darkred"><b>注意</b></span>:若广告组的 `schedule_start_time` 早于当前时间,则不支持更新本字段。|
|schedule_end_time {+条件必填}|datetime|当 `schedule_type` 为 `SCHEDULE_START_END` 时必填。<br><br>广告投放结束时间 (UTC+0),格式为`"YYYY-MM-DD HH:MM:SS"`。<br><br>结束时间不可晚于`"2038-01-01 00:00:00"`。|
|dayparting |string|广告投放安排。格式为48x7的字符串。字符只能为0或者1。0代表不投放,1代表投放。每个字符对应一个30分钟的时间段。第一个字符对应的是周一的凌晨0:01-0:30,第二个字符对应0:31-1:00,依次类推。最后一个字符代表周日23:31-0:00。<br><span style="color: darkred"><b>注意:</b></span><br>不设置,全部设置为0,或者全部都设置为1都代表了要进行全时投放。|
|frequency |number| 频次,与`frequency_schedule`共同构成用户看到广告的频次上限(仅适用于`REACH`广告)。<br>需要满足以下两个条件:<ul><li>1 <= `frequency` <= 1000</li><li>1 <= `frequency_schedule` <= 30</li></ul>例如:`frequency` = 2 且 `frequency_schedule` = 3 表示每 3 天至多 2 次展示。 |
|frequency_schedule |number| 频次天数,与`frequency`共同构成用户看到广告的频次上限(仅适用于`REACH`广告)。详见`frequency`字段说明。|
|secondary_optimization_event|string|当优化目标为`INSTALL`或`VALUE`时的次要优化目标。枚举值:详见[转化事件-App深度转化事件类型](https://ads.tiktok.com/marketing_api/docs?id=1739361474981889)。<br><p><span style="color:darkred"><b>注意</b></span>:若设置了 `secondary_optimization_event`,则需同时传入 `deep_bid_type` 。|
|bid_type |string|竞价策略。 竞价策略将决定系统的单次成效费用管理方式、预算支出方式以及广告投放方式。详见[枚举值-竞价策略](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br>当开启了推广系列预算优化(CBO)时,本字段无法修改。|
|bid_price |float|仅当`bid_type` 为 `BID_TYPE_CUSTOM` 且 `billing_event` 为 `CPC`,`CPM` 或 `CPV` 时,本字段生效。<br><br>出价。想尽可能达到的平均单次成效成本。<br><br>当推广系列预算优化开启(`budget_optimize_on`)时,建议同一个推广系列下所有广告组出价保持一致。<br><br>`bid_price`需小于您在推广系列层级和广告组层级设置的`budget`金额。请查看[出价-出价限制](https://ads.tiktok.com/marketing_api/docs?id=1745292444424193)了解出价校验机制。|
|conversion_bid_price |float|仅当`bid_type` 为 `BID_TYPE_CUSTOM` 且 `billing_event` 为 `OCPM` 时,本字段生效。<br><br>oCPM转化出价。<br><br>`conversion_bid_price`需小于您在推广系列层级和广告组层级设置的`budget`金额。请查看[出价-出价限制](https://ads.tiktok.com/marketing_api/docs?id=1745292444424193)了解出价校验机制。|
|deep_bid_type {+条件必填}|string|深度事件出价类型。<br><br>枚举值详见[枚举值-深度事件出价类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br><br><p><span style="color:darkred"><b>注意</b></span>:若设置了 `secondary_optimization_event`,则需同时传入 `deep_bid_type` 。|
|roas_bid {+条件必填}|float|当`deep_bid_type`为`VO_MIN_ROAS`时必填。<br><br>用于价值优化的ROAS目标值。<br><br>取值范围: <ul><li>对于应用内广告收入场景(`objective_type` 为 `APP_PROMOTION`, `optimization_goal` 为 `VALUE`,且 `optimization_event` 为 `AD_REVENUE_VALUE`):0.01-10。</li><li>对于商品来源为 TikTok Shop 的商品购物广告场景(`shopping_ads_type` 为 `PRODUCT_SHOPPING_ADS` 且 `product_source` 为 `STORE`):0.01-20。</li><li>对于其他场景:0.01-1,000。</li></ul>|
|deep_cpa_bid |float|当您为app内事件选择出价策略后,您需要在该字段中传入出价价格。|
|next_day_retention| float | 次日留存率。公式:`next_day_retention` = `conversion_bid_price`/`deep_cpa_bid`。取值范围 (0,1]。仅当版位`placements`为`PLACEMENT_PANGLE`且深度转化事件`secondary_optimization_event`为`NEXT_DAY_OPEN`时生效。<br><span style="color:DarkRed"><b>注意</b></span>:如果您想要使用此字段,请同时传入`conversion_bid_price`,`deep_cpa_bid`,和 `next_day_retention`这三个字段,并确保传入的值符合计算公式。否则可能会导致不符合预期的错误。 |
|pacing |string| 广告投放速度类型。您可以选择`PACING_MODE_SMOOTH`(在预定的时间内平均分配预算)和`PACING_MODE_FAST`(尽快消耗预算并产出结果)。当您开启推广系列预算优化(`budget_optimize_on`)时,该字段将自动设置为为`PACING_MODE_SMOOTH`。否则您需要填写该字段。|
|is_hfss |boolean|推广内容是否为 HFSS(高脂高盐和高糖)产品/品牌。<br><br>如果您的广告宣传或重点展示的产品/品牌为高脂高盐和高糖食品,需将此字段设置为 `true`。<br><br>在受监管地区,HFSS 广告必须仅针对 18 岁以上用户定向投放。<br><br>当您的定向地区包括英国、澳大利亚、新西兰和欧盟国家或地区时,您可以将此字段设置为 `true`。<br><br>支持的值:`true`,`false`。|
| is_lhf_compliance | boolean | 推广内容是否符合 LHF(较不健康食品)合规要求。<br><br>将 `is_lhf_compliance` 设置为 `true`,即表示您确认在英国 TikTok 上推广的任何食品或饮料均符合 [2024 年较不健康食品法规](https://www.legislation.gov.uk/uksi/2024/1266/made)以及其他所有适用法律。<br><br>支持的值:`true`,`false`。<br><br><p><span style="color:darkred"><b>注意</b></span>:自 2026 年 1 月 1 日起,当广告定向到英国地域且 `is_hfss` 为 `true` 时,`is_lhf_compliance` 必填,且必须设置为 `true`。</p> |
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/adgroup/update/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"adgroup_id": "{{adgroup_id}}",
"adgroup_name": "{{adgroup_name}}"
}'
(/code)
返回
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述,可见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097) 。|
|message |string|返回信息。更多信息可见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data |object|返回数据 |
#|advertiser_id |string| 广告主 ID。 |
#|campaign_id |string| 推广系列 ID。 |
#|campaign_name|string| 该广告组所属的推广系列的名称。 |
#|adgroup_id |string| 广告组 ID。 |
#|adgroup_name|string| 广告组名称。 |
#| create_time | string | 广告组创建时间。格式为`"YYYY-MM-DD HH:MM:SS"`。 <br><br>示例:`"2023-01-01 00:00:01"`。 |
#| modify_time | string | 广告组修改时间。格式为`"YYYY-MM-DD HH:MM:SS"`。<br><br>示例:`"2023-01-01 00:00:01"`。 |
#|shopping_ads_type|string|当对应的推广系列 `objective_type` 为 `PRODUCT_SALES` 时返回。<br><br>购物广告类型。<br><br>枚举值:<ul><li>`VIDEO`:视频购物广告。</li><li>`LIVE`:直播购物广告。</li><li>`PRODUCT_SHOPPING_ADS`:商品购物广告。</li><li>`CATALOG_LISTING_ADS`:产品目录广告。</li><li> `UNSET`:未设置。</li></ul>|
#|identity_id |string|当 `shopping_ads_type` 为 `VIDEO` 且 `product_source` 为 `SHOWCASE` 或 `shopping_ads_type` 为 `LIVE` 时返回。<br><br>认证身份 ID。|
#|identity_type|string|当 `shopping_ads_type` 为 `VIDEO` 且 `product_source` 为 `SHOWCASE` 或 `shopping_ads_type` 为 `LIVE` 时返回。<br><br>认证身份类型。枚举值: `AUTH_CODE` (授权码认证), `TT_USER` (TikTok商务用户), `BC_AUTH_TT`(已添加到商务中心的TikTok用户)。参阅[认证身份](https://ads.tiktok.com/marketing_api/docs?id=1738958351620097)获取详细信息。 |
#|identity_authorized_bc_id|string|当`identity_type` 为 `BC_AUTH_TT`时返回。<br><br>与添加到商务中心的TikTok用户这一认证身份绑定的商务中心的ID。|
#|product_source|string|仅视频购物广告和商品购物广告返回本字段。<br><br>商品来源,即您要推广的商品的来源。<br><br>枚举值:`UNSET` ,`CATALOG`(商品库),`STORE` (TikTok Shop 店铺),`SHOWCASE`(TikTok 橱窗)。|
#|catalog_id|string| 以下任意场景下返回:<ul><li> `product_source` 设置为 `CATALOG` 或 `STORE`。</li><li> `shopping_ads_type` 设置为 `LIVE` 且请求中传入了本字段。</li></ul><br>商品库 ID。<br><br><p><span style="color:darkred"><b>注意</b></span>:自 2024 年 6 月 30 日起,将不再为新创建的 `product_source` 为 `STORE` 的购物广告返回 `catalog_id`,传入的 `catalog_id` 字段将被忽略。存量的 `product_source` 为 `STORE` 的购物广告若未被更新,则不受影响。若您更新存量的这类广告组,且广告组已绑定 `catalog_id` ,则绑定的 `catalog_id` 将清空且该 `catalog_id` 字段将不再返回。|
#|catalog_authorized_bc_id |string| 以下任意场景下返回:<ul><li>`shopping_ads_type` 设置为 `VIDEO` 且 `product_source` 设置为 `CATALOG` 或 `STORE`。 </li><li>`shopping_ads_type` 设置为 `LIVE` 且请求中传入了本字段。</li></ul>如果要操作的是已经资产化的商品库,本字段会返回相应的商务中心 ID。<br><br><p><span style="color:darkred"><b>注意</b></span>:自 2024 年 6 月 30 日起,将不再为新创建的 `product_source` 为 `STORE` 的购物广告返回 `catalog_authorized_bc_id`,传入的 `catalog_authorized_bc_id` 字段将被忽略。存量的 `product_source` 为 `STORE` 的购物广告若未被更新,则不受影响。若您更新存量的这类广告组,且广告组已绑定 `catalog_authorized_bc_id` ,则绑定的 `catalog_authorized_bc_id` 将清空且该 `catalog_authorized_bc_id` 字段将不再返回。|
#|store_id |string|以下任意场景下返回:<ul><li>`shopping_ads_type` 设置为 `VIDEO` 且 `product_source` 设置为 `STORE`。</li><li>`shopping_ads_type` 设置为 `PRODUCT_SHOPPING_ADS` 且 `product_source` 设置为 `STORE`。 </li><li>`shopping_ads_type` 设置为`LIVE` 且请求中传入了本字段。</li></ul><br> TikTok Shop 店铺 ID。|
#|store_authorized_bc_id |string|请求中传入 `store_id` 时返回。<br><br>有权管理该商店 (`store_id`)的商务中心的 ID。|
#|promotion_type |string|推广对象类型(优化位置)。您可以使用该字段决定在哪里投放广告。详情见[枚举值-推广对象类型 ](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|promotion_target_type |string|推广目标线索收集的专属推广对象类型。<br>枚举值: <ul><li> `INSTANT_PAGE`:即时表单(线索表单)。创建可快速加载的应用内 TikTok 即时表单来收集更多线索。</li><li> `EXTERNAL_WEBSITE`:第三方网站表单。使用包含第三方网站表单的落地页,或使用会重定向至包含第三方网站表单网站的TikTok即时体验页面来收集更多线索。</li><li>`UNSET`。</li></ul> |
#| messaging_app_type | string | 即时通讯广告组中使用的即时通讯应用或自定义 URL。<br><br>枚举值:<ul><li>`MESSENGER`:Messenger。</li><li>`WHATSAPP`:WhatsApp。</li><li>`ZALO`: Zalo。</li><li>`LINE`: Line。</li><li>`IM_URL`:即时通讯 URL。</li></ul>|
#| messaging_app_account_id | string | 即时通讯应用账号 ID。<ul><li>`messaging_app_type` 为 `MESSENGER` 时,本字段代表 Facebook 公共主页编号。</li><li> `messaging_app_type` 为 `LINE` 时,本字段代表 LINE Business ID。</li><li>`messaging_app_type` 为 `WHATSAPP` 时,本字段代表根据指定的`phone_region_code`、`phone_region_calling_code` 和 `phone_number` 自动填充的 WhatsApp 电话号码。</li></ul> |
#| phone_region_code | string | WhatsApp 或 Zalo 电话号码的地区代码。 <br><br>示例:`US`。 |
#| phone_region_calling_code | string | WhatsApp 或 Zalo 电话号码的区号。<br><br> 示例:`+1`。 |
#| phone_number | string | WhatsApp 或 Zalo 电话号码。 |
#|promotion_website_type|string|广告组中的 TikTok 即时体验页面类型。<br>枚举值:<ul><li>`UNSET`:不使用TikTok 即时体验页面。</li><li>`TIKTOK_NATIVE_PAGE`:使用 TikTok 即时体验页面。|
#|app_id |string|推广的应用的 ID。|
#|app_type |string| 推广的App的的类型。枚举值:`APP_ANDROID`(Android),`APP_IOS`(iOS)。|
#|app_download_url |string|App下载链接|
#|pixel_id |string|Pixel ID,仅对落地页生效。|
#|optimization_event |string|广告组转化事件。参阅[转化事件](https://ads.tiktok.com/marketing_api/docs?id=1739361474981889) ,获取详细信息。|
#| app_config | object[] | 推广系列层级 `sales_destination` 为 `WEB_AND_APP` 时返回本字段。<br><br>推广的应用详情。 |
##| app_id | string | 推广的应用的 ID。 |
#|custom_conversion_id|string|广告组中使用的自定义转化的 ID。|
#| deep_funnel_optimization_status | string | 深层漏斗优化的状态。 <br>深层漏斗优化同时优化浅层和深层漏斗事件。您可以在主要优化事件之外再选择一个次要事件,这有助于提升推广 系列的效果。 <br><br> 枚举值:<ul><li>`ON` :启用深层漏斗优化。</li><li>`OFF`:不启用深层漏斗优化。</li></ul> |
#| deep_funnel_event_source | string | `deep_funnel_optimization_status` 为 `ON` 时返回本字段。 <br><br> 事件源类型。 <br><br> 枚举值: <ul><li> `PIXEL`:Pixel。</li><li>`OFFLINE`:线下事件组。 </li><li>`CRM`:CRM 事件组。</li></ul> |
#| deep_funnel_event_source_id | string | `deep_funnel_optimization_status` 为 `ON` 时返回本字段。 <br><br> 事件源 ID。 <br><br> <ul><li>`deep_funnel_event_source` 为 `PIXEL` 时,本字段代表 Pixel ID。</li><li>`deep_funnel_event_source` 为 `OFFLINE` 时,本字段代表线下事件组 ID。</li><li>`deep_funnel_event_source`为`CRM`时,本字段代表 CRM 事件组 ID。</li></ul> |
#| deep_funnel_optimization_event | string | `deep_funnel_optimization_status` 为 `ON` 时返回本字段。 <br><br> 深层漏斗优化事件。 <br><br>示例: `SHOPPING`。 |
#|placement_type |string|版位类型。 <br>枚举值: `PLACEMENT_TYPE_AUTOMATIC`(自动版位),`PLACEMENT_TYPE_NORMAL` (编辑版位)。|
#|placements |string[]|投放版位。详情见[枚举值-版位](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br><p><span style="color:darkred"><b>注意</b></span>:<ul><li> 当`placement_type`为`PLACEMENT_TYPE_AUTOMATIC`(自动版位)时,本字段返回指定的推广目标下实际支持的版位。例如,若实际仅支持 TikTok版位,本字段返回的值将为`PLACEMENT_TIKTOK` 。<ul><li>若指定的推广目标支持 `PLACEMENT_GLOBAL_APP_BUNDLE` 版位,但您未申请全球化应用组合版位的白名单,则本字段的值将不会包含`PLACEMENT_GLOBAL_APP_BUNDLE`。</li></ul></li><li>当 `placement_type` 为 `PLACEMENT_TYPE_NORMAL`(手动版位)时,本字段通常将返回您在请求中通过`placements`字段指定的版位。<ul><li>唯一的例外是您在请求中通过 `placements` 字段指定了 `PLACEMENT_GLOBAL_APP_BUNDLE` 版位 ,但是您未申请 `PLACEMENT_GLOBAL_APP_BUNDLE` 的白名单,则本字段的返回值中将筛除 `PLACEMENT_GLOBAL_APP_BUNDLE` 。例如,若您在请求中将 `placements` 设置为`["PLACEMENT_TIKTOK", "PLACEMENT_GLOBAL_APP_BUNDLE"]`,但是未申请全球化应用组合版位的白名单,本字段的返回值将为`["PLACEMENT_TIKTOK"]`。 </li></ul></li></ul>|
#| tiktok_subplacements | string[] | TikTok 子版位,用于选择广告出现的具体位置。 <br><br> 枚举值:<ul><li>`IN_FEED`:信息流。广告将投放在“推荐”动态中,可能投放在“个人资料页”和“关注”推荐内容中。</li><li>`SEARCH_FEED`:搜索推荐内容。</li><li>`TIKTOK_LITE`:TikTok Lite,占用内容更小、视频加载速度更快的精简版 TikTok 应用。TikTok Lite 子版位仅支持定向日本或韩国时使用。</li><li>`LEMON8`:Lemon8,一款生活方式内容社区应用,内容包含真实生活体验分享、小贴士、指南和商品测评。如果在子版位中包含 Lemon8,广告将展示在其推荐页信息流、搜索信息流和沉浸式视频信息流中。 [了解 Lemon8 的详情](https://ads.tiktok.com/help/article/about-lemon8-in-tiktok-ads-manager)。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>:若创建广告组时未指定 `tiktok_subplacements`,本字段将为空列表(`[]`)。 |
#| search_result_enabled | boolean | 是否在搜索广告中展示您的广告,即当用户在 TikTok上搜索您的业务相关信息时,系统是否向他们展示您的广告。 |
#|automated_keywords_enabled|boolean|是否启用自动关键词,即在添加广告后,让系统自动生成关键词。这样可以拓展优质流量,以便提升成效。在报表中查看成效出色的自动关键词。<br><br>支持的值:`true`,`false`。|
#|search_keywords|object[]|仅为搜索广告推广系列返回。<br><br>搜索关键词列表,即用于与人们搜索的词语匹配,以展示您的广告的一组搜索关键词,可以是词或词组。|
##|keyword|string|搜索关键词。|
##|match_type|string|搜索关键词对应的匹配类型。<br><br>枚举值:<ul><li>`PRECISE_WORD`:精确匹配。您的广告将会在用户的搜索词与这些关键词完全匹配时展示。</li><li>`PHRASE_WORD`:词组匹配。您的广告将会在用户以相同词序搜索这些关键词时展示。</li><li>`BROAD_WORD`:广泛匹配。您的广告将会在用户搜索这些关键词中的任意词时展示,无论词序是否相同。</li></ul>|
##|keyword_bid_type|string|关键词和匹配类型组合的出价类型。<br><br>枚举值:<ul><li>`FOLLOW_ADGROUP`:使用广告组层级的出价(`bid_price`)作为 `keyword_bid`。</li><li>`CUSTOM`:通过 `keyword_bid` 自定义出价。</li></ul>|
##|keyword_bid|float|关键词和匹配类型组合的出价。|
##|audit_status|string|搜索关键词的审核状态。<br><br>枚举值:<ul><li>`AUDITING`:关键词在审核中。</li><li>`PASS`:关键词已通过审核,可用于投放。</li><li>`REJECTED`:关键词未通过审核,不可用于投放。</li></ul>|
##|reject_info|object[]|仅当 `audit_status` 为 `REJECTED` 时返回。<br><br>拒审详情。|
###|forbidden_location|string|未通过审核的定向地域。<br><br>枚举值参见[附录 - 地区代码](1737585867307010.html)。|
###|reject_reasons|object[]|拒审原因列表。|
####|reason|string|拒审原因。|
#|comment_disabled |boolean|是否允许用户在TikTok上评论您的广告。|
#|video_download_disabled |boolean| 用户是否可以在 TikTok 上下载您的广告视频。|
#|share_disabled|boolean|本广告组中的广告是否禁止分享到第三方平台。|
#|blocked_pangle_app_ids|string[]| Pangle 媒体屏蔽列表 ID。 |
#|audience_type |string| 应用重定向受众类型。枚举值可见[枚举值 - 应用重定向受众类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)|
#|audience_rule |object| 受众规则。 |
#|saved_audience_id |string | 当您在请求中指定了`saved_audience_id`时,将返回此信息。<br>已保存受众ID。|
#|auto_targeting_enabled{-即将废弃}|boolean|是否开启自动定向。|
#| shopping_ads_retargeting_type | string |`shopping_ads_type` 设置为 `VIDEO` 且 `product_source` 设置为 `CATALOG` 时返回。<br><br>购物广告受众再营销类型。<br><br>枚举值:<ul><li>`LAB1` : 对浏览过商品或者将商品加过购物车,但未购买过商品的受众进行再营销。 </li><li>`LAB2`:对将商品加过购物车,但未购买过商品的受众进行再营销。</li><li>`LAB3` : 使用自定义条件组合对受众进行再营销。</li><li>`OFF` : 不进行受众再营销。</li></ul> |
#| shopping_ads_retargeting_actions_days | number | 所指定的受众行为的有效时间范围。在该时间范围内完成所指定行为的受众将成为购物广告受众再营销的对象。<br><br>取值范围:1,2,3,7, 14,30,60,90,180。|
#| included_custom_actions | object[] | 作为包含条件筛选购物广告受众再营销对象的自定义行为。|
##| code | string | 用于筛选出受众再营销对象的自定义行为。<br><br>枚举值:<ul><li>`VIEW_PRODUCT`:受众浏览过商品。</li><li>`ADD_TO_CART` : 受众将商品加过购物车。</li><li>`PURCHASE` : 受众购买过商品。</li></ul>|
##| days | integer | 用于筛选出完成了自定义行为的受众的时间区间。<br><br>取值范围:[1,180]。|
#| excluded_custom_actions | object[] |作为排除条件筛选购物广告受众再营销对象的自定义行为。|
##| code | string | 用于筛选出受众再营销对象的自定义行为。<br><br>枚举值:<ul><li>`VIEW_PRODUCT`:受众浏览过商品。</li><li>`ADD_TO_CART` : 受众将商品加过购物车。</li><li>`PURCHASE` : 受众购买过商品。</li></ul>|
##| days | integer | 用于筛选出未完成自定义行为的受众的时间区间。<br><br>取值范围:[1,180]。|
#| shopping_ads_retargeting_custom_audience_relation | string | 由 `shopping_ads_retargeting_type` 字段指定的视频购物广告重定向受众与由 `audience_ids` 指定的自定义受众间的逻辑关系。<br><br>枚举值:<ul><li> `OR`:取视频购物广告重定向受众和自定义受众的并集构建定向受众。定向受众中包含属于视频购物广告重定向受众或自定义受众的人群。</li><li> `AND`:取视频购物广告重定向受众和自定义受众的交集构建定向受众。定向受众中仅包含同时属于视频购物广告重定向受众和自定义受众的人群。</li></ul> |
#|location_ids |string[]|定向地域的ID。使用[/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713) 获取定向地域ID。|
#| zipcode_ids|string[]|定向地域的邮政编码ID。|
#|languages |string[]|受众语言。<br>枚举值:详见[枚举值-受众语言](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|gender |string|定向受众性别 <br>枚举值: `GENDER_FEMALE`,`GENDER_MALE`,`GENDER_UNLIMITED`。 |
#|age_groups |string[]|定向受众年龄<br>枚举值:详见[枚举值-受众年龄区间](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|spending_power|string|消费能力。枚举值:`ALL`, `HIGH`。如果设为`HIGH`,您就可以定向和普通用户相比 TikTok 广告投入支出通常更多的高消费能力用户。|
#|household_income| string[]| 您想定向的收入群体。枚举值:`TOP5`(家庭收入群体的前5%), `TOP10`(家庭收入群体的前10%),`TOP10_25`(家庭收入群体的前10-25%), `TOP25_50`(家庭收入群体的前25-50%)。 |
#|audience_ids|string[]|受众 ID 列表。 |
#| smart_audience_enabled | boolean | 是否已启用智能受众。<br><br>枚举值: `true`, `false`。 |
#|excluded_audience_ids|string[]|排除受众 ID 列表。 |
#|interest_category_ids |string[]|用于定向受众的一般兴趣分类 ID 列表。|
#|interest_keyword_ids|string[]|用于定向受众的其他兴趣分类 ID 列表。|
#|purchase_intention_keyword_ids|string[]|购买意向分类 ID 列表,用于定向近期行为表明其可能会购买某内容类别相关产品的受众。 |
#|actions| object[] | 用于定向的行为分类对象数组。|
##|action_scene |string| 用于定向的用户行为种类。<br><br>枚举值:<ul><li>`VIDEO_RELATED`:视频互动。</li><li>`CREATOR_RELATED`:创作者互动。</li><li>`HASHTAG_RELATED`:话题互动。</li></ul> |
##|action_period |number| 选择n天内发生的行为。|
##|video_user_actions |string[]| 所选用户行为种类下想要定向的的具体用户行为。<br><br><ul><li>若`action_scene`为`VIDEO_RELATED`,枚举值为:`WATCHED_TO_END`(完播),`LIKED`(点赞),`COMMENTED`(评论),`SHARED`(分享)。 </li><li>若`action_scene`为`CREATOR_RELATED`,枚举值为:`FOLLOWING`(关注),`VIEW_HOMEPAGE`(浏览主页)。</li><li>若`action_scene`为`HASHTAG_RELATED`,枚举值为: `VIEW_HASHTAG`(浏览话题标签)。</li></ul>|
##|action_category_ids |string[]| 用于定向受众的视频互动分类 ID、创作者互动分类 ID、话题标签 ID 或话题包 ID 列表。|
#| smart_interest_behavior_enabled | boolean | 是否已启用智能型兴趣和行为。<br><br>枚举值: `true`, `false`。 |
#|included_pangle_audience_package_ids |string[]| 包含 Pangle 流量包 ID。您可以使用接口[/pangle_audience_package/get/](https://ads.tiktok.com/marketing_api/docs?id=1740040177229826)获取受众ID (`package_id`) 。`bind_type`设置为`INCLUDE`。请不要同时传入该字段和`excluded_pangle_audience_package_ids`。|
#|excluded_pangle_audience_package_ids |string[]| 排除 Pangle 流量包 ID。您可以使用接口[/pangle_audiene_package/get/](https://ads.tiktok.com/marketing_api/docs?id=1740040177229826)获取受众ID (`package_id`) 。`bind_type`设置为`EXCLUDE`。请不要同时传入该字段和`included_pangle_audience_package_ids`。 |
#|operating_systems |string[]|受众操作系统,枚举值:`ANDROID`, `IOS`。|
#|min_android_version|string|受众最低Android版本。枚举值:详见[枚举值-最低Android版本](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|ios14_targeting |string|您想定向的 iOS 设备版本。枚举值:<ul><li>`UNSET`:运行 iOS 14.4 及更早版本的设备。</li><li>`IOS14_MINUS`:不受 iOS 14 新的 ATT 框架影响的 iOS 设备(运行 iOS 14.0 及更早的设备)。</li><li>`IOS14_PLUS`:运行 iOS 14.5 及之后版本、已执行 ATT 框架的 iOS 设备。此值仅支持在专属推广系列中使用。</li><li>`ALL`:运行 iOS 14.5 及之后版本、已执行 ATT 框架的 iOS 设备。此值仅支持在 iOS 应用再营销广告或 iOS 重定向类型的视频购物广告(商品来源为商品库且优化位置为应用)中使用。 </li></ul>|
#|min_ios_version|string|受众最低iOS版本。枚举值详见[枚举值-最低iOS版本](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|ios14_quota_type|string|本推广系列是否占用iOS14专属推广系列配额。枚举值:`OCCUPIED`(占用), `UNOCCUPIED`(不占用)。对于非覆盖和频次推广系列,如果`ios14_targeting`设为 `IOS14_PLUS`, 本字段会自动设为`OCCUPIED`。|
#|device_model_ids| string[]| 设备机型ID列表。关于设备机型更多信息,可参考[获取设备型号列表](https://ads.tiktok.com/marketing_api/docs?id=1737172880570369)。|
#|network_types|string[]|网络类型。<br>详见[枚举值-网络类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|carrier_ids |string[]| 运营商ID。 只有当运营商`in_use`字段为`true`时生效。获取详细信息,参阅[获取运营商列表](https://ads.tiktok.com/marketing_api/docs?id=1737168013095938)。|
#| isp_ids | string[] | 定向的互联网服务提供商的ID。|
#|device_price_ranges|number[]|设备价格区间(10000代表1000+)。该数字必须是50的倍数。<br><b><span style="color: darkred">重要提示</span></b>: 最终的实际上限将在您设定的上限基础上增加50,您可以在TikTok广告管理平台的广告组设置中看到实际上限。例如,如果您设置的价格区间是[0, 250],实际区间则为[0, 300]。|
#|targeting_expansion{-将被废弃}| object | 定向扩量设置|
##|expansion_enabled|boolean| 是否开启定向扩量|
##|expansion_types |string[]| 要进行扩量的定向受众类型|
#|contextual_tag_ids |string[] | 内容相关定向标签ID列表。|
#|brand_safety_type|string|品牌安全类型。枚举值: <ul><li>`NO_BRAND_SAFETY`:不使用任何品牌安全解决方案,即使用<strong>全部库存</strong>。您的广告可能会在某些包含成人主题的内容周围展示。</li><li>`EXPANDED_INVENTORY`:使用TikTok的品牌安全解决方案,即使用<b>扩展库存</b>。您的广告将不会出现在不当内容或包含成人主题的内容后面。在下个API版本中`EXPANDED_INVENTORY`将替代`NO_BRAND_SAFETY`,并成为默认的品牌安全选项。</li><li>`STANDARD_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>标准库存</strong>。您的广告将展示在适合大多数品牌的内容周围。 </li><li>`LIMITED_INVENTORY`:使用TikTok的品牌安全解决方案中的<strong>有限库存</strong>。您的广告将展示在不包含成人主题的内容周围。</li><li>`THIRD_PARTY`:使用第三方品牌安全解决方案。</li></ul>您可以使用[/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713)接口查询品牌安全设置对应的广告可投放国家或地区。|
#|brand_safety_partner|string|品牌安全合作伙伴。只有在品牌安全为第三方(`brand_safety` = `THIRD_PARTY`)时有效。枚举值:`IAS`, `OPEN_SLATE`(该合作伙伴在TikTok广告管理平台的对应名称为<strong>DoubleVerify</strong>,因为该合作伙伴已被DoubleVerify收购)。您可以使用[/tool/region/](https://ads.tiktok.com/marketing_api/docs?id=1737189539571713)接口,并根据自己的品牌安全设置获取可投放的国家和地区。您需要传入品牌安全类型和品牌安全合作伙伴。<br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>出价前第三方品牌安全解决方案目前为白名单功能。如需使用此功能,请联系您的TikTok销售代表。 </li></ul>|
#|inventory_filter_enabled|boolean|库存筛选(筛选安全视频,如果不安全则不展示),仅对于 `PLACEMENT_TIKTOK` 版位有效,true表示筛选,false表示不筛选。|
#|category_exclusion_ids|string[]|内容排除类别ID。|
#|vertical_sensitivity_id|string|行业敏感内容控制类型ID。|
#|budget_mode |string|广告预算类型。如果开启了推广系列预算优化(`budget_optimize_on` ), 将返回`BUDGET_MODE_INFINITE`。枚举值及设置详见[预算](https://ads.tiktok.com/marketing_api/docs?id=1739381246298114) 。|
#|budget |float|广告预算。当开启了推广系列预算优化(`budget_optimize_on`)时,返回0.0。|
#|scheduled_budget|float|表示隔日预算值。若是非0则表示设置了隔日预算并表示了隔日预算的数值;若是为0则表示未设置隔日预算。|
#|schedule_type |string|广告投放时间类型<br>枚举值: `SCHEDULE_FROM_NOW`,`SCHEDULE_START_END`。如果您选择了`SCHEDULE_START_END`,您需要明确投放开始和结束时间。 如果您选择了`SCHEDULE_FROM_NOW`,您只需要明确投放开始时间。|
#|schedule_start_time |datetime|广告投放起始时间 (UTC+0),形式如:2017-01-01 00:00:00。|
#|schedule_end_time |datetime|广告投放结束时间 (UTC+0),形式如:2017-01-01 00:00:00。|
#|delivery_mode |string|覆盖和频次广告组中广告投放的排序与排期策略。<br><br> 枚举值: <ul><li>`STANDARD`:标准投放。每个广告均匀投放,预计会获得大致相同的访问量。</li><li>`SCHEDULE`:计划投放。为每个广告设置投放的特定时间段。</li><li>`SEQUENCE`:顺序投放。为广告设置特定的投放顺序。</li><li>`OPTIMIZE`(<span style="color:red">已废弃</span> ):优选投放。</li></ul>|
#|dayparting |string|广告投放安排。格式为48x7的字符串。字符只能为0或者1。0代表不投放,1代表投放。每个字符对应一个30分钟的时间段。第一个字符对应的是周一的凌晨0:01-0:30,第二个字符对应0:31-1:00,依次类推。最后一个字符代表周日23:31-0:00。<br><span style="color: darkred"><b>注意:</b></span><br>不设置,全部设置为0,或者全部都设置为1都代表了要进行全时投放。|
#|optimization_goal|string|优化目标 <br>枚举值详见[枚举值-优化目标](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|secondary_optimization_event|string|当优化目标为`INSTALL`或`VALUE`时的次要优化目标。枚举值详见[转化事件-App深度转化事件类型](https://ads.tiktok.com/marketing_api/docs?id=1739361474981889)。|
#| message_event_set_id | string | 即时通讯广告组中使用的消息事件集的 ID。<br><br>若广告组设置中的即时通讯应用账号匹配到了唯一消息事件集,无论是通过 `messaging_app_account_id` 手动指定的 Messenger 账号还是基于指定的`phone_region_code`、`phone_region_calling_code` 和 `phone_number` 填充的 WhatsApp 账号,则本字段将<b>自动填充</b>为与所选即时通讯应用账号绑定的唯一消息事件集。 |
#|frequency |number| 频次,与 `frequency_schedule`共同构成控制用户看到广告的频次上限(仅适用于覆盖人数广告)。如: frequency = 2 frequency_schedule = 3 表示每 3 天至多 2 次展示 |
#|frequency_schedule|number| 频次天数,与`frequency`共同构成控制用户看到广告的频次上限(仅适用于覆盖人数广告)。见 frequency 字段说明 |
#|bid_type |string|竞价策略。 <br> 详见[枚举值-竞价策略](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|bid_price |float|出价。想尽可能达到的平均单次成效成本。|
#|conversion_bid_price |float|oCPM转化出价|
#|deep_bid_type |string|深度事件出价类型<br>枚举值: 详见[枚举值-深度事件出价类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|roas_bid|float|用于价值优化的ROAS目标值。|
#| vbo_window | string |为[广告收入价值优化](1739381743067137.html)或[应用内购价值优化](1739381743067137.html)指定的竞价策略的时间窗口期。 <br><br>枚举值: <ul><li>`SEVEN_DAYS`:前 7 天。</li><li>`ZERO_DAY`:第 0 天(当天)。</li></ul> |
#|bid_display_mode|string|每次浏览成本的计算和测算模式。|
#|deep_cpa_bid |float|当您为app内事件选择出价策略后,您需要在该字段中传入出价价格。|
#|cpv_video_duration |string|优化目标之视频播放时长<br>枚举值: `SIX_SECONDS`(视频播放6秒),`TWO_SECONDS`(视频播放2秒) |
#| next_day_retention | float | 次日留存率。计算公式:`daily_retention_ratio` = `conversion_bid_price`/`deep_cpa_bid`,范围 (0,1]。仅当版位`placements`为`PLACEMENT_PANGLE`且深度转化事件`secondary_optimization_event`为`NEXT_DAY_OPEN`时生效。 |
#| click_attribution_window | string | 广告组的点击归因窗口期。该窗口期指用户从点击广告到采取行动之间的时间间隔。<br><br>枚举值:<ul><li>`OFF`:不启用。 </li><li> `ONE_DAY`:1天(点击)。</li><li>`SEVEN_DAYS`:7天(点击)。 </li><li>`FOURTEEN_DAYS`:14天(点击)。</li><li> `TWENTY_EIGHT_DAYS`:28天(点击)。 </li></ul>|
#| engaged_view_attribution_window | string | 广告组的深度互动观看归因窗口期。该窗口期指用户从观看视频广告 6 秒到采取行动之间的时间间隔。<br><br>枚举值:<ul><li>`ONE_DAY`:1天(深度互动观看)。</li><li>`SEVEN_DAYS`:7天(深度互动观看)。 </li></ul>|
#| view_attribution_window | string | 广告组的展示归因窗口期。该窗口期指用户从查看广告到采取行动之间的时间间隔。<br><br>枚举值:<ul><li>`OFF`:不启用。</li><li>`ONE_DAY`:1天(展示)。</li><li>`SEVEN_DAYS`:7天(展示)。 </li></ul>|
#| attribution_event_count | string | 广告组的事件统计方式(统计类型)。<br>统计用户在查看或点击了广告后采取操作的次数的方式。<br><br>枚举值: <ul><li>`UNSET` :未设置。 </li><li> `EVERY`:每一次。某位用户进行的多个购买事件将分别计入转化量。</li><li> `ONCE`:仅一次。某位用户进行的多个事件将只算作 1 次转化。</li></ul>|
#|billing_event |string| 计费事件。<br>枚举值: 详见[枚举值-计费事件](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138#item-link-计费事件)。|
#|pacing |string| 广告投放速度类型。您可以选择`PACING_MODE_SMOOTH`(在预定的时间内平均分配预算)和`PACING_MODE_FAST`(尽快消耗预算并产出结果)。|
#|operation_status |string|广告组的操作状态。<ul><li>`ENABLE`:广告组处于启用(“开”)状态。</li><li>`DISABLE`:广告组处于未启用(“关”)状态。</li><li>`FROZEN`:广告组处于冻结状态,无法再次启用。</li></ul> |
#|secondary_status |string|广告组状态<br>枚举值:详见[枚举值-广告组状态](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|statistic_type |string|转化事件出价统计类型。枚举值 `EVERYTIME`(每一次计费广告),`NONE`(仅一次计费广告)。 |
#| is_hfss |boolean| 推广内容是否为 HFSS(高脂高盐和高糖)产品/品牌。<br><br>支持的值:`true`,`false`。|
#| is_lhf_compliance | boolean | 推广内容是否符合 LHF(较不健康食品)合规要求。<br><br>将 `is_lhf_compliance` 设置为 `true`,即表示您确认在英国 TikTok 上推广的任何食品或饮料均符合 [2024 年较不健康食品法规](https://www.legislation.gov.uk/uksi/2024/1266/made)以及其他所有适用法律。<br><br>支持的值:`true`,`false`。 |
#|creative_material_mode |string|创意投放方式。<br>枚举值: `CUSTOM`(自定义),`DYNAMIC`(<span style="color:red">已废弃</span>)(程序化创意),`SMART_CREATIVE`(智能创意)。|
#|adgroup_app_profile_page_state|string|该广告组是否使用了App中间页。枚举值:`INVALID`, `UNSET`, `ON`, `OFF`。|
#|feed_type |string| 信息流类型。枚举值: `STANDARD_FEED`, `TOP_FEED`。|
#|rf_purchased_type |string| 覆盖和频次广告购买方式,详见[枚举值 - 覆盖和频次广告购买方式](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br><p><span style="color:darkred"><b>注意</b></span>:本字段的值始终返回null。|
#|purchased_impression |number| 覆盖和频次广告购买的展示量。<br><p><span style="color:darkred"><b>注意</b></span>:本字段的值始终返回null。|
#|purchased_reach|number| 覆盖和频次广告购买的触达人数。<br><p><span style="color:darkred"><b>注意</b></span>:本字段的值始终返回null。 |
#|rf_estimated_cpr |number| 覆盖和频次广告预测的千人覆盖成本。<br><p><span style="color:darkred"><b>注意</b></span>:本字段的值始终返回null。 |
#|rf_estimated_frequency |number| 覆盖和频次广告预测的人均展示频次。<br><p><span style="color:darkred"><b>注意</b></span>:本字段的值始终返回null。 |
#|is_new_structure |boolean| 推广系列是否是新结构。 |
#|skip_learning_phase |boolean|是否跳过学习阶段。|
#|conversion_window {-已废弃}|string|转化窗口,您希望用户从点击或观看广告到最终发生转化的时间周期,广告平台将使用该时间周期内的数据优化您的广告投放效果。该设置不会影响到投放数据归因设置。枚举值详见[枚举值-广告管理-转化窗口期](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
#|page_info |object|分页信息 |
##|page |number|当前页数 |
##|page_size |number|分页大小 |
##|total_number |number|总数,符合条件的广告组总数 |
##|total_page |number|总页数 |
|request_id |string|请求的日志id,唯一标识一个请求 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"purchased_reach": null,
"budget_mode": "BUDGET_MODE_TOTAL",
"conversion_bid_price": 0,
"adgroup_app_profile_page_state": null,
"search_result_enabled": false,
"create_time": "{{create_time}}",
"rf_purchased_type": null,
"comment_disabled": false,
"category_id": "0",
"statistic_type": null,
"brand_safety_type": "NO_BRAND_SAFETY",
"promotion_type": "WEBSITE",
"modify_time": "{{modify_time}}",
"pixel_id": null,
"secondary_status": "ADGROUP_STATUS_CREATE",
"is_hfss": false,
"excluded_audience_ids": [],
"actions": [],
"gender": "GENDER_UNLIMITED",
"adgroup_name": "{{adgroup_name}}",
"adgroup_id": "{{adgroup_id}}",
"app_download_url": null,
"optimization_goal": "CLICK",
"frequency": null,
"deep_cpa_bid": 0,
"inventory_filter_enabled": false,
"audience_ids": [],
"auto_targeting_enabled": false,
"deep_bid_type": null,
"brand_safety_partner": null,
"campaign_name": "{{campaign_name}}",
"operating_systems": [
"ANDROID"
],
"network_types": [],
"is_new_structure": true,
"scheduled_budget": 0,
"schedule_end_time": "{{schedule_end_time}}",
"placement_type": "PLACEMENT_TYPE_NORMAL",
"video_download_disabled": false,
"app_type": null,
"category_exclusion_ids": [],
"age_groups": null,
"location_ids": [
"{{location_id}}"
],
"placements": [
"PLACEMENT_TIKTOK"
],
"optimization_event": null,
"interest_keyword_ids": [],
"campaign_id": "{{campaign_id}}",
"bid_price": 0,
"dayparting": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"ios14_quota_type": "UNOCCUPIED",
"delivery_mode": null,
"secondary_optimization_event": null,
"app_id": null,
"creative_material_mode": "CUSTOM",
"share_disabled": false,
"purchased_impression": null,
"rf_estimated_frequency": null,
"operation_status": "ENABLE",
"next_day_retention": null,
"schedule_type": "SCHEDULE_START_END",
"frequency_schedule": null,
"schedule_infos": null,
"keywords": null,
"bid_type": "BID_TYPE_NO_BID",
"bid_display_mode": "CPMV",
"skip_learning_phase": false,
"billing_event": "CPC",
"interest_category_ids": [],
"rf_estimated_cpr": null,
"isp_ids": [],
"pacing": "PACING_MODE_SMOOTH",
"feed_type": null,
"schedule_start_time": "{{schedule_start_time}}",
"languages": [],
"conversion_window": null,
"budget": {{budget}},
"advertiser_id": "{{advertiser_id}}",
"device_price_ranges": null,
"need_audit": false
}
}
(/code);