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

客户文件人群

客户文件人群(CUSTOMER FILE AUDIENCE)是指您可以将想要用于广告投放的用户的ID以TXT文件或压缩包的形式上传至DMP随后即可在广告投放端对这些用户进行定向投放。目前支持的用户ID类型及说明如下表所示:

用户ID类型 描述
GDT_OPENID 基于 GDT Cookie Mapping 分配的 openid 包
HASH_IDFA 加密后的IDFA,加密前需要格式转化成32位的数字+大写字母,加密后为不计大小写的32位数字字母串,示例:加密前FF1999CD-7177-4937-A474-74937A102630,加密后2c010ed96aef2fc34983e1e7e9176b7e
HASH_IMEI 加密后的IMEI,加密前需要格式转化成14位或15位数字+小写字母串,加密后为不计大小写的32位数字字母串,示例: 加密前a000002c9060f7,加密后 f2d5a650733ca8c27d502b1c08da14e5
HASH_MAC 加密后的 MAC 地址,加密前需要去除分隔符“:”后转为大写,示例:加密前 02:00:00:00:00:00,加密后 e3f5536a141811db40efd6400f1d0a4e
HASH_MOBILE_PHONE 加密后的手机号,加密前为11位的纯数字串,加密后为不计大小写的32位数字字母串
HASH_QQ MD5 加密后的 QQ 号
IDFA 苹果设备ID,32位的数字+大写字母串,用“-”杠分隔,示例:49E2084A-290C-41EF-AD20-E540CD6AE841
IMEI 安卓设备ID,14位或15位的纯数字串,或者14位或15位的数字+小写字母串
MAC 硬件标识符,格式为 6 组 16 进制数,用“:”分隔,示例:08:00:20:0A:8C:6D
MOBILE_QQ_OPENID QQ 手机版的 OPENID
QQ QQ 号码包
WECHAT_OPENID 微信用户的 openid,仅部分开通(原有 WX_OPENID 已升级为 WECHAT_OPENID)

使用Marketing API实现客户文件人群来进行定向投放,您需要完成以下步骤:

接下来,将详细介绍每个步骤的接口调用情况。


1、使用custom_audiences/add 创建一个人群

此时您需要指定人群类型为客户文件人群(CUSTOMER_FILE),例如创建一个名称为“100万加密IMEI”的文件人群,接口调用示例如下:

curl 'https://api.e.qq.com/v1.1/custom_audiences/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -H 'Content-Type: application/json' \
    -d '{
        "account_id" : <ACCOUNT_ID>,
        "name" : "100万加密IMEI",
        "description" : "100万加密IMEI测试",
        "type" : "CUSTOMER_FILE"
    }'

返回示例:

{
    "code": 0,
    "message": "",
    "data": {
        "audience_id": 2837392
    }
}

2、往创建好的文件人群中上传数据文件

你可以调用custom_audience_files/add接口往文件人群中上传数据文件,一个人群可以上传多个数据文件。例如往第1步创建的人群中上传一个加密IMEI号码包文件,请求示例如下:

curl 'https://api.e.qq.com/v1.1/custom_audience_files/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -F "account_id=<ACCOUNT_ID>" \
    -F "audience_id=2837392" \
    -F "user_id_type=HASH_IMEI" \
    -F "file=@<FILE_PATH>"  

注:数据文件上传完成后,需要等待服务端处理,通常情况我们会承诺会在24小时内处理完成。您可以随时通过查看该数据文件的status来了解是否处理完成。只是文件处理完成后,对应的人群覆盖人数才会符合您的预期。

3、将人群用于定向

例如创建一个新的定向,定向条件为前面创建的文件人群,其示例如下:

curl 'https://api.e.qq.com/v1.1/targetings/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -H 'Content-Type: application/json' \
    -d '{
        "account_id":<ACCOUNT_ID>,
        "targeting_name":"使用100万加密IMEI号码包",
        "targeting":{
            "custom_audience":[2837392]
        }
    }'

返回示例:

{
    "code":0,
    "message":"",
    "data": {
        "targeting_id": 12345
    }
}

如果您希望排除前面创建的文件人群,您可以创建如下定向:

curl 'https://api.e.qq.com/v1.1/targetings/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -H 'Content-Type: application/json' \
    -d '{
        "account_id":<ACCOUNT_ID>,
        "targeting_name":"排除使用100万加密IMEI号码包",
        "targeting":{
            "excluded_custom_audience":[2837392]
        }
    }'

返回示例:


{
    "code":0,
    "message":"",
    "data": {
        "targeting_id": 23456
    }
}

最后您可将创建好的定向(targeting_id)应用于一条或多条广告,即可实现广告的精准定向。

有关客户文件人群读写接口的更详细说明,可以参考 接口清单-Audience

有关人群数据文件接口及人群增减的更详细说明,可以参考 接口清单-Custom Audience File

有关人群定向接口的更详细说明,可以参考 接口清单-Targeting