自定义受众权限

GET accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

检索与指定自定义受众相关的部分或所有权限的详细信息。

资源 URL

https://ads-api.twitter.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

tailored_audience_id
必需

请求中对正在操作的自定义受众的引用。

类型:string

示例:1nmth

count
可选

指定每个不同请求尝试检索的记录数量。

类型:int

默认值:200
最小值、最大值:11000
cursor
可选

指定光标以获取下一页结果。参阅分页了解更多信息。

类型:string

示例:8x7v00oow

granted_account_ids
可选

通过指定以逗号分隔的标识符列表,将响应范围限定为所需的账号。最多可提供 200 个 ID。

类型:string

示例:18ce54aymz3

sort_by
可选

根据支持的属性,按升序或降序排序。参阅排序了解更多信息。

类型:string

示例:created_at-asc

tailored_audience_permission_ids
可选

通过指定以逗号分隔的标识符列表,将响应范围限定为所需的自定义受众权限。最多可提供 200 个 ID。

类型:string

示例:ri

with_total_count
可选

包含 total_count 响应属性。

注意:不包含此参数和 cursor

注意:包含 total_count 的请求速率限制较低,目前设置为每 15 分钟 200 次。

类型:boolean

默认值:false
可能值:truefalse

请求示例

GET https://ads-api.twitter.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions

响应示例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "tailored_audience_id": "1nmth"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "tailored_audience_id": "1nmth",
      "permission_level": "READ_ONLY",
      "id": "ri",
      "created_at": "2017-06-08T23:17:59Z",
      "granted_account_id": "18ce54aymz3",
      "updated_at": "2017-06-08T23:17:59Z",
      "deleted": false
    }
  ]
}

POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

创建新的权限对象,以便与给定账号共享指定受众。

注意:创建或修改自定义受众的权限要求尝试修改权限的账号拥有受众。你可以通过在给定受众响应中查看 is_owner 响应属性,检查自定义受众的所有权。

注意:仅可在同一业务下的广告账号之间共享受众,或在拥有受众的广告账号具有 SHARE_AUDIENCE_OUTSIDE_BUSINESS 账号功能时共享受众。

资源 URL

https://ads-api.twitter.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

granted_account_id
必需

希望向其授予自定义受众权限的账号。

类型:string

示例:18ce54aymz3

permission_level
必需

访问自定义受众时,granted_account_id 应具有的访问权限类型。

类型:enum

可能值:READ_ONLYREAD_WRITE

tailored_audience_id
必需

请求中对正在操作的自定义受众的引用。

类型:string

示例:2906h

请求示例

POST https://ads-api.twitter.com/5/accounts/18ce54d4x5t/tailored_audiences/2906h/permissions?granted_account_id=18ce54aymz3&permission_level=READ_ONLY

响应示例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "granted_account_id": "18ce54aymz3",
      "permission_level": "READ_ONLY",
      "tailored_audience_id": "2906h"
    }
  },
  "data": {
    "tailored_audience_id": "2906h",
    "permission_level": "READ_ONLY",
    "id": "14m",
    "created_at": "2017-09-12T23:49:34Z",
    "granted_account_id": "18ce54aymz3",
    "updated_at": "2017-09-12T23:49:34Z",
    "deleted": false
  }
}

DELETE accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id

撤销指定的自定义受众共享权限。

注意:创建或修改自定义受众的权限要求尝试修改权限的账号拥有受众。你可以通过在给定受众响应中查看 is_owner 响应属性,检查自定义受众的所有权。

撤销后,我们保证获得授权的账号 (granted_account_id) 无法在将来的广告活动中定位受众。现有的广告活动会继续向共享的受众开展;广告活动不会停止,也不会将受众从广告活动中移除。受众共享权限撤销后,此广告活动将无法复制。

资源 URL

https://ads-api.twitter.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

tailored_audience_id
必需

请求中对正在操作的自定义受众的引用。

类型:string

示例:1nmth

tailored_audience_permission_id
必需

请求中对正在操作的自定义受众权限的引用。

类型:string

示例:ri

请求示例

DELETE https://ads-api.twitter.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions/ri

响应示例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "tailored_audience_permission_id": "ri",
      "tailored_audience_id": "1nmth"
    }
  },
  "data": {
    "tailored_audience_id": "1nmth",
    "permission_level": "READ_ONLY",
    "id": "ri",
    "created_at": "2017-06-08T23:17:59Z",
    "granted_account_id": "18ce54aymz3",
    "updated_at": "2017-08-30T18:29:35Z",
    "deleted": true
  }
}