自定义受众用户(已弃用)
注意:此页面上的端点已弃用。它在 v8 中仍然可用,但在 v9 中不可用。
POST accounts/:account_id/tailored_audiences/:tailored_audience_id/users¶
该端点允许合作伙伴从给定的 tailored_audience_id
中添加、更新和删除用户。端点还接受每位用户的多个用户标识符类型。
users
请求字段中提供的所有数据除 partner_user_id
外必须使用 SHA256
进行哈希运算和规范。
批量请求
- 此端点目前最大的批次大小为
2500
。批次大小由每个请求的操作数量 (Update
/Delete
) 决定。例如,如果一个数组中的操作对象超过 2500 个 ({"operation_type": "Update/Delete", [..] }
) ,则会导致错误。 - 此端点可以接受的最大请求 POST 正文大小为
5,000,000
字节。 - 对于每个 1 分钟窗口,此端点的速率限制为 1500
- 所有参数都在请求正文中发送,并且需要
application/json
的Content-Type
。 - 无论失败或成功,批量请求均作为一个整体,并且错误和成功的所有 API 响应都保留初始请求的项目顺序。
批量响应
广告 API 返回的响应包含两个字段:success_count
和 total_count
。这些值必须始终相等,它们是请求中已由后端处理的记录计数。如果请求正文中发送的记录数不等于 success_count
和 total_count
,则应视为错误,需要重试。
批量错误
- 请求级别的错误(例如,超过最大批量大小)会显示在
errors
对象下的响应中。 - 项目级别的错误(例如,缺少必需参数)会显示在
operation_errors
对象下的响应中。 operation_errors
中错误的索引是指输入项目中的索引,内含相应的错误信息
资源 URL¶
https://ads-api.twitter.com/8/accounts/:account_id/tailored_audiences/:tailored_audience_id/users
参数¶
名称 | 说明 |
---|---|
operation_type 必需 |
正在执行的每个 类型:enum 可能值: |
params 必需 |
包含 类型:JSON |
users 必需 |
包含单个用户所有参数的 JSON 对象数组。 类型:JSON |
effective_at 可选 |
自定义受众关联生效时的 UTC 时间。以 ISO 8601 表示。默认为当前日期和时间。 类型:string 示例: |
expires_at 可选 |
自定义受众关联到期时的 UTC 时间。指定的时间必须晚于 类型:string 示例: |
鉴于 users
对象的多键方法,该对象的每个元素都记录在下面:
名称 | 说明 |
---|---|
email 可选 |
用户的电子邮件地址。 类型:Array[String] |
device_id 可选 |
IDFA/AdID/Android ID 类型:Array[String] |
handle 可选 |
属于用户的@用户名 类型:Array[String] |
twitter_id 可选 |
属于用户的 Twitter ID 类型:Array[String] |
partner_user_id 可选 |
合作伙伴系统中用户的 ID。 类型:Array[String] |
请求示例¶
POST https://ads-api.twitter.com/8/accounts/18ce54d4x5t/tailored_audiences/1nmth/users
[
{
"operation_type": "Update",
"params": {
"effective_at": "2018-05-15T00:00:00Z",
"expires_at": "2019-01-01T07:00:00Z",
"users": [
{
"email": [
"4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
],
"handle": [
"7352f353c460e74c7ae226952d04f8aa307b12329c5512ec8cb6f1a0f8f9b2cb",
"49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d"
]
},
{
"email": [
"5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
],
"twitter_id": [
"34d56c7159a7eea941f359653029410f813f65a1d2d13ecc5ccbdd5a8cb755cf",
"00e7b76c9739dec57f4c4a20ec021a20ffcf26bd00f519b17ea00f0ed6048f85"
]
}
]
}
},
{
"operation_type": "Delete",
"params": {
"effective_at": "2018-05-15T00:00:00Z",
"expires_at": "2019-01-01T07:00:00Z",
"users": [
{
"device_id": [
"8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92"
],
"email": [
"4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
],
"handle": [
"461222f5dd690a20651c3d19848015cb0369db3f8e937571ffb775de70750847"
],
"twitter_id": [
"c623c7e163984493b46c547088542e95d0aaa529bc52bbecce3ff91eb6b7843b"
]
},
{
"email": [
"5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
],
"twitter_id": [
"858cdc7f313f84a3f3c48e9a6323307c1ef1bb7439b8e3623e140454b0fd8fa5",
"bb074e154657b91d99bd1bb3757409149670e8ae7a0fe9136fae29a26a7881c8"
]
}
]
}
}
]
响应示例¶
{
"request": {
"params": {
"account_id": "18ce54d4x5t",
"tailored_audience_id": "1nmth"
}
},
"data": {
"success_count": 4,
"total_count": 4
}
}