Campaign management

推广推文

在 Postman 中运行 ❯

GET accounts/:account_id/promoted_tweets

检索对与当前账号下行项目关联的推文的引用。

使用 GET accounts/:account_id/tweets 端点可获取推文对象。使用 tweet_id 值表示每个 promoted_tweets 对象。

注意：当父行项目被删除时，只有请求中指定了 with_deleted=true，才会返回 promoted_tweets 实体。但实际上这些 promoted_tweets 实体并不会被删除（响应中包含 "deleted": false）。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
count
可选

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

类型：int

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

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

类型：string

示例：8x7v00oow
line_item_ids
可选

通过指定以逗号分隔的标识符列表，将响应范围限定为与特定行项目关联的推文。最多可提供 200 个 ID。

类型：string

示例：96uzp
promoted_tweet_ids
可选

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

类型：string

示例：1efwlo
sort_by
可选

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

类型：string

示例：created_at-asc
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/promoted_tweets?promoted_tweet_ids=1efwlo

响应示例

{
  "request": {
    "params": {
      "promoted_tweet_ids": [
        "1efwlo"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "96uzp",
      "id": "1efwlo",
      "entity_status": "ACTIVE",
      "created_at": "2017-06-29T05:06:57Z",
      "updated_at": "2017-06-29T05:08:46Z",
      "approval_status": "ACCEPTED",
      "tweet_id": "880290790664060928",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/promoted_tweets/:promoted_tweet_id

检索对与当前账号下行项目关联的推文的特定引用。

注意：当父行项目被删除时，只有请求中指定了 with_deleted=true，才会返回 promoted_tweets 实体。但实际上这些 promoted_tweets 实体并不会被删除（响应中包含 "deleted": false）。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
promoted_tweet_id
必需

请求中对正在操作的推广推文的引用。

类型：string

示例：1efwlo
with_deleted
可选

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

类型：boolean

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

请求示例

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/promoted_tweets/1efwlo

响应示例

{
  "request": {
    "params": {
      "promoted_tweet_id": "1efwlo",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "96uzp",
    "id": "1efwlo",
    "entity_status": "ACTIVE",
    "created_at": "2017-06-29T05:06:57Z",
    "updated_at": "2017-06-29T05:08:46Z",
    "approval_status": "ACCEPTED",
    "tweet_id": "880290790664060928",
    "deleted": false
  }
}

POST accounts/:account_id/promoted_tweets

将一篇或多篇推文与指定行项目相关联。并非所有推文都适合推广，具体取决于广告活动的目标。参阅基于目标的广告活动了解更多信息。

使用 PROMOTED_ACCOUNT 产品类型时，将推文与 line_item 关联会在移动设备上添加时间线位置和标准 PROMOTED_ACCOUNT 位置。

注意：无法更新 (PUT) 推广的推文实体。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
line_item_id
必需

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

类型：string

示例：8v7jo
tweet_ids
必需

与特定推文对应的逗号分隔标识符列表。最多可提供 50 个 ID。

类型：long

示例：822333526255120384

请求示例

POST https://ads-api.twitter.com/10/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384

响应示例

{
  "data": [
    {
      "line_item_id": "8v7jo",
      "id": "1e8i2k",
      "entity_status": "ACTIVE",
      "created_at": "2017-06-24T04:21:36Z",
      "updated_at": "2017-06-24T04:21:36Z",
      "approval_status": "ACCEPTED",
      "tweet_id": "822333526255120384",
      "deleted": false
    }
  ],
  "request": {
    "params": {
      "line_item_id": "8v7jo",
      "tweet_ids": [
        822333526255120384
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "total_count": 1
}

DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id

取消推文与指定行项目的关联。

注意：已删除的 promoted_tweets 实体将在 ads.twitter.com UI 中显示为“已暂停”状态。同样，在 UI 中选择“暂停”将使推文与其行项目取消关联。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
promoted_tweet_id
必需

此标识符代表与行项目关联的推广推文的实例。它来自 GET accounts/:account_id/promoted_tweets 的响应项目的 id 字段，而不是相关推文的 tweet_id。在资源路径中提供。

类型：string

示例：1gp8a5

请求示例

DELETE https://ads-api.twitter.com/10/accounts/18ce54d4x5t/promoted_tweets/1gp8a5

响应示例

{
  "data": {
    "line_item_id": "9pl99",
    "id": "1gp8a5",
    "entity_status": "ACTIVE",
    "created_at": "2017-08-17T17:02:21Z",
    "updated_at": "2017-08-18T06:43:48Z",
    "approval_status": "ACCEPTED",
    "tweet_id": "844796297743757315",
    "deleted": true
  },
  "request": {
    "params": {
      "promoted_tweet_id": "1gp8a5",
      "account_id": "18ce54d4x5t"
    }
  }
}