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

获取关键词
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 bidword/get
请求方法 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
filtering
struct[] 过滤条件,若此字段不传或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 255
field*
string 过滤字段
可选值:{ bidword_id, adgroup_id, campaign_id, bidword, match_type, created_time, last_modified_time, delete_time, configured_status, bidword_status }
operator*
enum 操作符
当 field 取值 bidword_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 adgroup_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 campaign_id 时,枚举列表:{ EQUALS, IN }
当 field 取值 bidword 时,枚举列表:{ EQUALS, CONTAINS, IN }
当 field 取值 match_type 时,枚举列表:{ EQUALS, IN }
当 field 取值 created_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 last_modified_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 delete_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 configured_status 时,枚举列表:{ EQUALS, IN }
当 field 取值 bidword_status 时,枚举列表:{ EQUALS, IN }
values*
string[] 字段取值
当 field 取值 match_type 时,
枚举列表:{ EXACT_MATCH, WIDE_MATCH, WORD_MATCH, PHRASE_MATCH }

当 field 取值 created_time 时,
字段长度为 10 字节

当 field 取值 last_modified_time 时,
字段长度为 10 字节

当 field 取值 delete_time 时,
字段长度为 10 字节

当 field 取值 configured_status 时,
枚举列表:{ KEYWORD_STATUS_NORMAL, KEYWORD_STATUS_SUSPEND }

当 field 取值 bidword_status 时,
枚举列表:{ BIDWORD_STATUS_APPROVAL_PASSED, BIDWORD_STATUS_APPROVAL_PENDING, BIDWORD_STATUS_APPROVAL_DENIED, BIDWORD_STATUS_BID_PRICE_LOWER, BIDWORD_STATUS_BID_PRICE_PARTIALLY_LOWER, BIDWORD_STATUS_NORMAL, BIDWORD_STATUS_DISPLAY_LIMITED, BIDWORD_STATUS_NORMAL_BUT_NOT_FILL }
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10
最小值 1,最大值 1000
is_deleted
boolean 是否已删除,true:是,false:否
可选值:{ true, false }

请求示例


curl 'https://api.e.qq.com/v1.1/bidword/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[]' \
-d 'page=1' \
-d 'page_size=10' \
-d 'is_deleted=false' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
bidword_id
integer 关键词 id
campaign_id
int64 推广计划 id,当获取广告主维度报表时,该值无意义
adgroup_id
int64 广告组 id,当获取广告主维度、推广计划维度报表时,该值无意义
bidword
string 关键词词面,字段长度最小 1 个等宽字符,长度最大 20 等宽字符(即字段最大长度为 20 个中文字或全角标点,40 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。),同一广告组下的关键词词面不允许重复
bid_price
integer 关键词出价,单位为分,关键词出价规则待补充
match_type
enum 关键词匹配方式,关键词匹配方式包括短语、精确、广泛匹配,[枚举详情]
configured_status
enum 暂停状态,[枚举详情]
bidword_status
enum 关键词状态,[枚举详情]
use_group_price
enum 是否使用组出价,[枚举详情]
audit_msg
string 审核原因
created_time
integer 创建时间(时间戳)
last_modified_time
integer 最后修改时间(时间戳)
pc_landing_page_info
struct[] 落地页列表信息
page_type
enum 落地页类型,[枚举详情]
page_url
string 落地页 URL
mini_program_spec
struct 微信小程序落地页数据结构
mini_program_id
string 小程序 id
mini_program_path
string 小程序路径
deep_link_spec
struct 应用直达落地页数据结构
deep_link_url
string 应用直达页 URL,微信朋友圈卡片广告创意形式需要填写 deeplink_ios_appid 或 deeplink_anroid_appid 以支持双端都能应用直达,应用直达页 URL
universal_link_spec
struct 通用链接落地页数据结构
universal_link_url
string 通用链接页 URL
xijing_spec
struct 蹊径落地页数据结构
page_id
int64 落地页 id
customized_param
string 蹊径落地页自定义参数
lingque_spec
struct 灵鹊落地页数据结构
page_id
int64 落地页 id
mobile_landing_page_info
struct[] 落地页列表信息
page_type
enum 落地页类型,[枚举详情]
page_url
string 落地页 URL
mini_program_spec
struct 微信小程序落地页数据结构
mini_program_id
string 小程序 id
mini_program_path
string 小程序路径
deep_link_spec
struct 应用直达落地页数据结构
deep_link_url
string 应用直达页 URL,微信朋友圈卡片广告创意形式需要填写 deeplink_ios_appid 或 deeplink_anroid_appid 以支持双端都能应用直达,应用直达页 URL
universal_link_spec
struct 通用链接落地页数据结构
universal_link_url
string 通用链接页 URL
xijing_spec
struct 蹊径落地页数据结构
page_id
int64 落地页 id
customized_param
string 蹊径落地页自定义参数
lingque_spec
struct 灵鹊落地页数据结构
page_id
int64 落地页 id
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "campaign_id": "<CAMPAIGN_ID>",
                "adgroup_id": "<ADGROUP_ID>",
                "created_time": 1491019858,
                "last_modified_time": 1491098468,
                "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": []
                    }
                ]
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具