活跃实体

GET stats/accounts/:account_id/active_entities

检索关于给定时间段内哪些实体的分析指标已更改的详情。

该端点应与我们的分析端点结合使用。该端点的结果指示要请求分析的广告实体。有关使用指南,请参见活跃实体指南

可在小时存储桶中获取变更事件。

  • start_time 值和 end_time 值用于指定要查询的小时存储桶。
  • 返回的 data 数组为每个实体提供一个对象,这些实体应该包含在后续分析请求中。
  • 重要提示:应根据 activity_start_time 值和 activity_end_time 值确定应在后续分析请求中指定的日期。
    • 这些值代表已存储变更事件适用的时间范围。系统将针对每个实体返回此值。

注意:允许的最大时间范围 (end_time - start_time) 为 90 天。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型:string

示例:18ce54d4x5t

end_time
必需

使用以 ISO 8601 表示的指定结束时间限定检索数据的范围。

注意:必须以整小时数(0 分 0 秒)表示。

类型:string

示例:2017-05-26T07:00:00Z

entity
必需

要检索数据的实体类型。

类型:enum

可能值:CAMPAIGNFUNDING_INSTRUMENTLINE_ITEMMEDIA_CREATIVEPROMOTED_ACCOUNTPROMOTED_TWEET

start_time
必需

使用以 ISO 8601 表示的指定开始时间限定检索数据的范围。

注意:必须以整小时数(0 分 0 秒)表示。

类型:string

示例:2017-05-19T07:00:00Z

campaign_ids
可选

通过指定逗号分隔的标识符列表,将响应范围限定为与所需广告活动相关的实体。最多可提供 200 个 ID。

注意:不包括 funding_instrument_idsline_item_ids

类型:string

示例:8wku2

funding_instrument_ids
可选

通过指定逗号分隔的标识符列表,将响应范围限定为与所需支付手段相关的实体。最多可提供 200 个 ID。

注意:不包括 campaign_idsline_item_ids

类型:string

示例:lygyi

line_item_ids
可选

通过指定逗号分隔的标识符列表,将响应范围限定为与所需行项目相关的实体。最多可提供 200 个 ID。

注意:不包括 campaign_idsline_item_ids

类型:string

示例:8v7jo

请求示例

GET https://ads-api.twitter.com/10/stats/accounts/18ce54d4x5t/active_entities?entity=PROMOTED_TWEET&start_time=2019-02-28&end_time=2019-03-01

响应示例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "entity": "PROMOTED_TWEET",
      "start_time": "2019-02-28T08:00:00Z",
      "end_time": "2019-03-01T08:00:00Z"
    }
  },
  "data": [
    {
      "entity_id": "2mvb28",
      "activity_start_time": "2019-02-28T01:30:07Z",
      "activity_end_time": "2019-03-01T07:42:55Z",
      "placements": [
        "ALL_ON_TWITTER"
      ]
    },
    {
      "entity_id": "2mvb29",
      "activity_start_time": "2019-02-27T11:30:07Z",
      "activity_end_time": "2019-03-01T07:42:50Z",
      "placements": [
        "ALL_ON_TWITTER",
        "PUBLISHER_NETWORK"
      ]
    },
    {
      "entity_id": "2mvfan",
      "activity_start_time": "2019-02-27T09:00:05Z",
      "activity_end_time": "2019-03-01T06:06:36Z",
      "placements": [
        "PUBLISHER_NETWORK"
      ]
    },
    {
      "entity_id": "2n17dx",
      "activity_start_time": "2019-02-28T02:02:26Z",
      "activity_end_time": "2019-03-01T07:52:44Z",
      "placements": [
        "ALL_ON_TWITTER",
        "PUBLISHER_NETWORK"
      ]
    }
  ]
}