アナリティクス

アクティブエンティティ

Postmanで実行 ❯ 

GET stats/accounts/:account_id/active_entities

特定の期間内にどのエンティティのアナリティクスメトリックが変更されたかについて詳細を取得します。

このエンドポイントは、アナリティクスエンドポイントと組み合わせて使用​​する必要があります。このエンドポイントの結果は、アナリティクスのリクエスト先の広告エンティティを示します。使用方法ガイドラインについては、「アクティブエンティティガイド」を参照してください。

変更イベントは1時間ごとのバケットで利用できます。

  • クエリ対象となる1時間ごとのバケットは、start_timeとend_timeの値で指定します。
  • 返されるdata配列には、後続のアナリティクスリクエストに含める必要がある、すべてのエンティティのオブジェクトが含まれます。
  • 重要: 後続のアナリティクスリクエストで指定する日付は、activity_start_timeとactivity_end_timeの値に基づいて決定する必要があります。
    • これらの値は、保存された変更イベントが適用される時間範囲を表します。これはエンティティごとに返されます。

注: 90日の最大時間範囲（end_time - start_time）が許可されます。

リソースURL

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

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
end_time
必須

取得するデータの範囲を、ISO 8601で表される、指定の終了時間に設定します。

注: 時間の単位（0分0秒）で表す必要があります。

タイプ: 文字列

例: 2017-05-26T07:00:00Z
entity
必須

データを取得するエンティティのタイプ。

タイプ: 列挙

使用可能な値: CAMPAIGN、FUNDING_INSTRUMENT、LINE_ITEM、MEDIA_CREATIVE、PROMOTED_ACCOUNT、PROMOTED_TWEET
start_time
必須

取得するデータの範囲を、ISO 8601で表される、指定の開始時間に設定します。

注: 時間の単位（0分0秒）で表す必要があります。

タイプ: 文字列

例: 2017-05-19T07:00:00Z
campaign_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的のキャンペーンに関連付けられたエンティティのみに設定します。最大200件のIDを指定できます。

注: funding_instrument_idsおよびline_item_idsとは同時に使用できません。

タイプ: 文字列

例: 8wku2
funding_instrument_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的のお支払い方法に関連付けられたエンティティのみに設定します。最大200件のIDを指定できます。

注: campaign_idsおよびline_item_idsとは同時に使用できません。

タイプ: 文字列

例: lygyi
line_item_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的の行項目に関連付けられたエンティティのみに設定します。最大200件のIDを指定できます。

注: campaign_idsおよびline_item_idsとは同時に使用できません。

タイプ: 文字列

例: 8v7jo

リクエストの例

GET https://ads-api.x.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"
      ]
    }
  ]
}