接口文档SDK业务专题开发者工具

创建关键词
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 bidword/add
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
list*
struct[] 关键词列表
数组最小长度 1,最大长度 1000
campaign_id*
int64 推广计划 id
adgroup_id*
int64 广告组 id
bidword*
string 关键词词面,字段长度最小 1 个等宽字符,长度最大 20 等宽字符(即字段最大长度为 20 个中文字或全角标点,40 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。),同一广告组下的关键词词面不允许重复
字段长度最小 1 字节,长度最大 60 字节
bid_price
integer 关键词出价,单位为分,关键词出价规则待补充
最小值 1,最大值 99999
use_group_price
enum 是否使用组出价,[枚举详情]
枚举列表:{ USE_GROUP_PRICE, NOT_USE_GROUP_PRICE }
match_type*
enum 关键词匹配方式,关键词匹配方式包括短语、精确、广泛匹配,[枚举详情]
枚举列表:{ EXACT_MATCH, WIDE_MATCH, WORD_MATCH, PHRASE_MATCH }
configured_status
enum 暂停状态,[枚举详情]
枚举列表:{ KEYWORD_STATUS_NORMAL, KEYWORD_STATUS_SUSPEND }
pc_landing_page_info
struct[] 落地页数据结构对象
page_type
enum 落地页类型,[枚举详情]
枚举列表:{ PAGE_TYPE_DEFAULT }
page_url
string 关键词落地页 URL
字段长度最小 0 字节,长度最大 1024 字节
mini_program_spec
struct 微信小程序落地页数据结构
mini_program_id
string 小程序 id
字段长度最小 1 字节,长度最大 384 字节
mini_program_path
string 小程序路径
字段长度最小 1 字节,长度最大 2048 字节
deep_link_spec
struct 应用直达落地页数据结构
deep_link_url
string 应用直达页 URL,微信朋友圈卡片广告创意形式需要填写 deeplink_ios_appid 或 deeplink_anroid_appid 以支持双端都能应用直达,应用直达页 URL
字段长度最小 0 字节,长度最大 2048 字节
universal_link_spec
struct 通用链接落地页数据结构
universal_link_url
string 通用链接页 URL
字段长度最小 0 字节,长度最大 2048 字节
xijing_spec
struct 蹊径落地页数据结构
page_id
int64 落地页 id
customized_param
string 蹊径落地页自定义参数
字段长度最小 0 字节,长度最大 1024 字节
lingque_spec
struct 灵鹊落地页数据结构
page_id
int64 落地页 id
mobile_landing_page_info
struct[] 落地页数据结构对象
page_type
enum 落地页类型,[枚举详情]
枚举列表:{ PAGE_TYPE_DEFAULT }
page_url
string 关键词落地页 URL
字段长度最小 0 字节,长度最大 1024 字节
mini_program_spec
struct 微信小程序落地页数据结构
mini_program_id
string 小程序 id
字段长度最小 1 字节,长度最大 384 字节
mini_program_path
string 小程序路径
字段长度最小 1 字节,长度最大 2048 字节
deep_link_spec
struct 应用直达落地页数据结构
deep_link_url
string 应用直达页 URL,微信朋友圈卡片广告创意形式需要填写 deeplink_ios_appid 或 deeplink_anroid_appid 以支持双端都能应用直达,应用直达页 URL
字段长度最小 0 字节,长度最大 2048 字节
universal_link_spec
struct 通用链接落地页数据结构
universal_link_url
string 通用链接页 URL
字段长度最小 0 字节,长度最大 2048 字节
xijing_spec
struct 蹊径落地页数据结构
page_id
int64 落地页 id
customized_param
string 蹊径落地页自定义参数
字段长度最小 0 字节,长度最大 1024 字节
lingque_spec
struct 灵鹊落地页数据结构
page_id
int64 落地页 id

请求示例


curl 'https://api.e.qq.com/v1.1/bidword/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'list=[
    {
        "campaign_id": "<CAMPAIGN_ID>",
        "adgroup_id": "<ADGROUP_ID>",
        "pc_landing_page_info": [
            {
                "mini_program_spec": [],
                "deep_link_spec": [],
                "universal_link_spec": [],
                "xijing_spec": [],
                "lingque_spec": []
            }
        ],
        "mobile_landing_page_info": [
            {
                "mini_program_spec": [],
                "deep_link_spec": [],
                "universal_link_spec": [],
                "xijing_spec": [],
                "lingque_spec": []
            }
        ]
    }
]' 
					

应答字段

名称 类型 描述
success_list
struct[] 返回成功的关键词列表
index
number 整数
bidword_id
integer 关键词 id
bidword
string 关键词词面,字段长度最小 1 个等宽字符,长度最大 20 等宽字符(即字段最大长度为 20 个中文字或全角标点,40 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。),同一广告组下的关键词词面不允许重复
bid_price
integer 关键词出价,单位为分,关键词出价规则待补充
match_type
enum 关键词匹配方式,关键词匹配方式包括短语、精确、广泛匹配,[枚举详情]
configured_status
enum 暂停状态,[枚举详情]
error_msg
string 错误信息
approval_status
integer 审核状态
error_list
struct[] 返回失败的关键词列表
index
number 整数
bidword_id
integer 关键词 id
bidword
string 关键词词面,字段长度最小 1 个等宽字符,长度最大 20 等宽字符(即字段最大长度为 20 个中文字或全角标点,40 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。),同一广告组下的关键词词面不允许重复
bid_price
integer 关键词出价,单位为分,关键词出价规则待补充
match_type
enum 关键词匹配方式,关键词匹配方式包括短语、精确、广泛匹配,[枚举详情]
configured_status
enum 暂停状态,[枚举详情]
error_msg
string 错误信息
approval_status
integer 审核状态

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "success_list": [],
        "error_list": []
    }
}

可视化调试工具