同期アナリティクス
GET stats/accounts/:account_id¶
現在のアカウントの同期アナリティクスジョブを取得します。7日の最大時間範囲(end_time
- start_time
)が許可されます。
リソースURL¶
https://ads-api.x.com/10/stats/accounts/:account_id
パラメーター¶
名前 | 説明 |
---|---|
account_id 必須 |
利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。 タイプ: 文字列 例: |
end_time 必須 |
取得するデータの範囲を、ISO 8601で表される、指定の終了時間に設定します。 注: 時間の単位(0分0秒)で表す必要があります。 タイプ: 文字列 例: |
entity 必須 |
データを取得するエンティティのタイプ。 タイプ: 列挙 使用可能な値: |
entity_ids 必須 |
データを取得する特定のエンティティ。エンティティIDのカンマ区切りのリストを指定します。 注: 最大20件のエンティティIDを指定できます。 タイプ: 文字列 例: |
granularity 必須 |
取得するデータの詳細度を指定します。 タイプ: 列挙 使用可能な値: |
metric_groups 必須 |
返される特定のメトリック。メトリックグループのカンマ区切りのリストを指定します。詳細については、「メトリックとセグメント化」を参照してください。 注: タイプ: 列挙 使用可能な値: |
placement 必須 |
取得するデータの範囲を、特定の配置に設定します。 注: 使用できる値は、リクエストごとに1つのみです。TwitterとTwitterオーディエンスプラットフォームプレースメントの両方を持つエンティティの場合は、プレースメントの値ごとに個別のリクエストが必要です。 タイプ: 列挙 使用可能な値: |
start_time 必須 |
取得するデータの範囲を、ISO 8601で表される、指定の開始時間に設定します。 注: 時間の単位(0分0秒)で表す必要があります。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/stats/accounts/18ce54d4x5t?entity=LINE_ITEM&entity_ids=8u94t&start_time=2017-05-19&end_time=2017-05-26&granularity=TOTAL&placement=ALL_ON_TWITTER&metric_groups=ENGAGEMENT
応答の例¶
{
"data_type": "stats",
"time_series_length": 1,
"data": [
{
"id": "8u94t",
"id_data": [
{
"segment": null,
"metrics": {
"impressions": [
1233
],
"tweets_send": null,
"qualified_impressions": null,
"follows": null,
"app_clicks": null,
"retweets": null,
"likes": [
1
],
"engagements": [
58
],
"clicks": [
58
],
"card_engagements": null,
"poll_card_vote": null,
"replies": null,
"carousel_swipes": null
}
}
]
}
],
"request": {
"params": {
"start_time": "2017-05-19T07:00:00Z",
"segmentation_type": null,
"entity_ids": [
"8u94t"
],
"end_time": "2017-05-26T07:00:00Z",
"country": null,
"placement": "ALL_ON_TWITTER",
"granularity": "TOTAL",
"entity": "LINE_ITEM",
"platform": null,
"metric_groups": [
"ENGAGEMENT"
]
}
}
}