Campaign management

定位标准

在 Postman 中运行 ❯

GET accounts/:account_id/targeting_criteria

检索与当前账号的行项目关联的部分或所有定位标准的详细信息。

资源 URL

https://ads-api.twitter.com/10/accounts/:account_id/targeting_criteria

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
line_item_ids
必需

通过指定以逗号分隔的标识符列表，将响应范围限定为指定行项目下的定位标准。最多可提供 200 个 ID。

类型：string

示例：8u94t
count
可选

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

类型：int

默认值：200
最小值、最大值：1、1000
cursor
可选

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

类型：string

示例：8x7v00oow
lang
可选

ISO-639-1 语言代码。传递后，将在响应具有可用本地化名称的对象时返回另一个 localized_name 属性。

类型：string

示例：fr
sort_by
可选

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

类型：string

示例：created_at-asc
targeting_criterion_ids
可选

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

类型：string

示例：dpl3a6
with_deleted
可选

在请求中包含已删除的结果。

类型：boolean

默认值：false
可能值：true、false
with_total_count
可选

包含 total_count 响应属性。

注意：不包含此参数和 cursor。

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

类型：boolean

默认值：false
可能值：true、false

请求示例

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t

响应示例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "line_item_ids": [
        "8u94t"
      ]
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8u94t",
      "name": "Custom audience targeting",
      "id": "dpl3a6",
      "operator_type": "EQ",
      "created_at": "2017-05-26T03:29:35Z",
      "targeting_value": "249yj",
      "updated_at": "2017-05-26T03:29:35Z",
      "deleted": false,
      "targeting_type": "CUSTOM_AUDIENCE"
    }
  ]
}

GET accounts/:account_id/targeting_criteria/:targeting_criterion_id

检索与当前账号关联的特定定位标准。

资源 URL

https://ads-api.twitter.com/10/accounts/:account_id/targeting_criteria/:targeting_criterion_id

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
targeting_criterion_id
必需

请求中对正在操作的定位标准的引用。

类型：string

示例：eijd4y
lang
可选

ISO-639-1 语言代码。传递后，将在响应具有可用本地化名称的对象时返回另一个 localized_name 属性。

类型：string

示例：fr
with_deleted
可选

在请求中包含已删除的结果。

类型：boolean

默认值：false
可能值：true、false

请求示例

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/targeting_criteria/eijd4y

响应示例

{
  "request": {
    "params": {
      "targeting_criterion_id": "eijd4y",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "619jl",
    "name": "🤖",
    "id": "eijd4y",
    "created_at": "2017-07-06T16:51:04Z",
    "targeting_value": "🤖",
    "updated_at": "2017-07-06T16:51:04Z",
    "deleted": false,
    "targeting_type": "BROAD_KEYWORD"
  }
}

POST accounts/:account_id/targeting_criteria

如需查找特定定位类型的 targeting_value，请参阅定位选项页面。我们建议你每周刷新所有数据，以确保你使用的是最新的一系列定位类型值。我们会不定期更改值和可用定位标准；虽然其中大多数不会经常更改，但有些会。我们不保证这些值不会更改。

使用 BROAD_KEYWORD、EXACT_KEYWORD、PHRASE_KEYWORD 或 UNORDERED_KEYWORD 定位类型，并在 targeting_value 中指定关键词。使用设置为 NE 的 operator_type 请求参数可排除关键词。请参见定位关键词类型，查看各种类型的详细说明。

注意：每个行项目只能定位一个年龄段。

注意：若要对自定义受众进行定位，该受众必须是可定位的，即 targerable 必须等于 true。

注意：使用定位类型 TV_SHOW 时，在设置 TV_SHOW 定位之前，行项目必须至少有一个 LOCATION 定位标准，并且所有 LOCATION 必须与所定位的 TV_SHOW 处于同一区域内。

资源 URL

https://ads-api.twitter.com/10/accounts/:account_id/targeting_criteria

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
line_item_id
必需

请求中对正在操作的行项目的引用。

类型：string

示例：69ob
operator_type
必需

指出定位标准应该具备的关系。例如，要排除关键词，应使用 operator_type=NE。

类型：enum

可能值：EQ、NE、GTE、LT
targeting_type
必需

将应用于此行项目的定位类型。

非基于关键词的可能值包括：AGE、DEVICE、EVENT、CAMPAIGN_ENGAGEMENT、CAMPAIGN_ENGAGEMENT_LOOKALIKE、CONVERSATION、ENGAGEMENT_TYPE、FOLLOWERS_OF_USER、GENDER、INTEREST、LANGUAGE、LIVE_TV_EVENT、LOCATION、NETWORK_ACTIVATION_DURATION、NETWORK_OPERATOR、PLATFORM、PLATFORM_VERSION、SIMILAR_TO_FOLLOWERS_OF_USER、TV_SHOW、USER_ENGAGEMENT、USER_ENGAGEMENT_LOOKALIKE、WIFI_ONLY

注意：每个行项目只能定位一个 AGE 段。

基于关键词的可能值包括：BROAD_KEYWORD、EXACT_KEYWORD、PHRASE_KEYWORD、UNORDERED_KEYWORD

自定义受众的可能值包括：CUSTOM_AUDIENCE、CUSTOM_AUDIENCE_EXPANDED

已安装应用商店类别的可能值：APP_STORE_CATEGORY、APP_STORE_CATEGORY_LOOKALIKE

可能的 Twitter 受众平台 (TAP) 应用排除：APP_LIST（只能与 operator_type=NE 一起使用）
targeting_value
必需

根据所选的 targeting_type，指定此定位将应用于哪个用户、哪种兴趣、哪个位置、哪个事件，哪个平台、哪个平台版本、哪个设备、哪个关键词或短语、哪种性别、哪些自定义受众、哪个应用商店类别或哪个排除应用列表。

类型：string

示例：174958347

请求示例

POST https://ads-api.twitter.com/10/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology

响应示例

{
  "data": {
    "line_item_id": "619jl",
    "name": "technology",
    "id": "fbyjlr",
    "created_at": "2017-09-06T07:31:21Z",
    "targeting_value": "technology",
    "updated_at": "2017-09-06T07:31:21Z",
    "deleted": false,
    "targeting_type": "BROAD_KEYWORD"
  },
  "request": {
    "params": {
      "line_item_id": "619jl",
      "targeting_type": "BROAD_KEYWORD",
      "targeting_value": "technology",
      "account_id": "18ce54d4x5t"
    }
  }
}

POST batch/accounts/:account_id/targeting_criteria

允许使用单个请求批量创建新的定位标准。

批量请求

  • 目前最大批量大小为 500。
  • 所有参数都在请求正文中发送，并且需要 application/json 的 Content-Type。
  • 无论失败或成功，批量请求均作为一个整体，并且错误和成功的所有 API 响应都保留初始请求的项目顺序。

批量响应

批量 API 响应返回已排序的项目集合。否则，其结构将与相应的单项目端点相同。

批量错误

  • 请求级别的错误（例如，超过最大批量大小）会显示在 errors 对象下的响应中。
  • 项目级别的错误（例如，缺少必需的定位标准参数）会显示在 operation_errors 对象下的响应中。

资源 URL

https://ads-api.twitter.com/10/batch/accounts/:account_id/targeting_criteria

参数

名称 说明
operation_type
必需

正在执行的每个项目操作类型。

类型：enum

可能值：Create、Delete
params
必需

包含定位标准对象的所有参数的 JSON 对象。如需查看必需和可选定位标准参数的列表，请点击此处。

此外，此端点支持 operator_type 参数，该参数与某些 targeting_type 值配合使用。此参数的可能值为：EQ 表示等于、GTE 表示大于或等于、LT 表示小于、NE 表示不等于。

请求示例

POST https://ads-api.twitter.com/10/batch/accounts/18ce54d4x5t/targeting_criteria

[
  {
    "operation_type":"Create",
    "params":{
      "line_item_id":"6f9an",
      "targeting_type":"LOCATION",
      "targeting_value":"5122804691e5fecc"
    }
  },
  {
    "operation_type":"Delete",
    "params":{
      "targeting_criterion_id":"al2rua"
    }
  }
]

响应示例

{
  "data_type": "targeting_criterion",
  "data": [
    {
      "line_item_id": "6f9an",
      "name": "San Francisco-Oakland-San Jose CA, US",
      "id": "al7vt2",
      "location_type": "CITY",
      "operator_type": "EQ",
      "created_at": "2016-11-11T22:59:50Z",
      "targeting_value": "5122804691e5fecc",
      "updated_at": "2016-11-11T22:59:50Z",
      "deleted": false,
      "targeting_type": "LOCATION"
    },
    {
      "line_item_id": "6keuo",
      "name": "accounts",
      "id": "al2rua",
      "operator_type": "EQ",
      "created_at": "2016-11-11T17:50:19Z",
      "targeting_value": "accounts",
      "updated_at": "2016-11-11T22:59:50Z",
      "deleted": true,
      "targeting_type": "BROAD_KEYWORD"
    }
  ],
  "request": [
    {
      "params": {
        "line_item_id": "6f9an",
        "targeting_type": "LOCATION",
        "targeting_value": "5122804691e5fecc",
        "account_id": "18ce54d4x5t"
      },
      "operation_type": "Create"
    },
    {
      "params": {
        "targeting_criterion_id": "al2rua",
        "account_id": "18ce54d4x5t"
      },
      "operation_type": "Delete"
    }
  ]
}

DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id

删除属于当前账号的指定定位标准。

资源 URL

https://ads-api.twitter.com/10/accounts/:account_id/targeting_criteria/:targeting_criterion_id

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
targeting_criterion_id
必需

请求中对正在操作的定位标准的引用。

类型：string

示例：dpl3a6

请求示例

DELETE https://ads-api.twitter.com/10/accounts/18ce54d4x5t/targeting_criteria/dpl3a6

响应示例

{
  "data": {
    "line_item_id": "8u94t",
    "name": "Custom audience targeting",
    "id": "dpl3a6",
    "created_at": "2017-05-26T03:29:35Z",
    "targeting_value": "249yj",
    "updated_at": "2017-08-30T18:38:58Z",
    "deleted": true,
    "targeting_type": "CUSTOM_AUDIENCE"
  },
  "request": {
    "params": {
      "targeting_criterion_id": "dpl3a6",
      "account_id": "18ce54d4x5t"
    }
  }
}