获取客户标签人群文件

开发环境

GET

/v1.3/custom_tag_files/get

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id
filtering	struct[]	过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件]
field*	string	过滤字段可选值：{ tag_id, custom_tag_file_id }
operator*	enum	操作符当 field 取值 tag_id 时，枚举列表：{ EQUALS } 当 field 取值 custom_tag_file_id 时，枚举列表：{ EQUALS}
values*	string[]	字段取值，values 数组的个数限制与 operator 的取值相关，详见 [过滤条件] 当 field 取值 tag_id 时，数组的值转成整数后必须大于 0 当 field 取值 custom_tag_file_id 时，数组的值转成整数后必须大于 0
page	integer	当前页码，默认 1 最小值 1，最大值 2147483647
page_size	integer	分页大小，默认 10 最小值 1，最大值 100

应答字段

名称	类型	描述
list	struct[]	返回数组列表
tag_id	integer	标签 id
custom_tag_file_id	integer	数据文件 id
name	string	文件名称
user_id_type	enum	号码包用户 id 类型，[枚举详情]
operation_type	enum	文件操作类型，如果不填则默认为 APPEND，[枚举详情]
open_app_id	string	微信/QQ 手机版 appid，当且仅当数据文件中的用户 id 类型为 'WECHAT_OPENID'（WX_OPENID）或 'MOBILE_QQ_OPENID' 时有效
process_status	integer	文件状态 0:正常
process_code	integer	处理完成后的状态码，0 表示成功，非 0 失败。
error_message	string	错误具体信息
line_count	integer	文件总行数
valid_line_count	integer	文件中没有格式错误的行数
user_count	integer	文件包含的用户数
created_time	string	创建时间，格式为 yyyy-MM-dd HH:mm:ss，如 2016-11-01 10:42:56
page_info	struct	分页信息
page	integer	当前页码
page_size	integer	分页大小
total_number	integer	总行数
total_page	integer	总页数

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/v1.3/custom_tag_files/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=111111111' \
--data-urlencode 'filtering=[
    {
        "values": []
    }
]' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=10'

响应示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "tag_id": "<TAG_ID>",
                "custom_tag_file_id": 10019012,
                "user_id_type": "IMEI",
                "created_time": 1491019858
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

请求参数

Header 参数

access_token

string

必需

以Query Parameter方式在请求路径中传递。授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节。

默认值:

<ACCESS_TOKEN>

timestamp

string

必需

以Query Parameter方式在请求路径中传递。当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59

默认值:

nonce

string

必需

以Query Parameter方式在请求路径中传递。随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性。

默认值:

<NONCE>

fields

string

必需

指定返回的字段列表，为选填字段，如不填写，则根据默认值进行返回

Body 参数application/x-www-form-urlencoded

account_id

integer

必需

推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id

示例值:

111111111

filtering

string

必需

过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件]

示例值:

[ { "values": [] } ]

page

integer

可选

当前页码，默认 1
最小值 1，最大值 2147483647

示例值:

page_size

integer

可选

分页大小，默认 10
最小值 1，最大值 100

示例值:

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

list

array [object {4}]

返回数组列表

必需

page_info

object

分页信息

必需

修改于 2023-11-08 02:43:06

上传客户标签人群数据文件

创建用户属性数据源

获取客户标签人群文件

请求参数#

应答字段#

请求参数

返回响应

请求参数

应答字段