非同期アナリティクス

GET stats/jobs/accounts/:account_id¶

現在のアカウントの一部またはすべての非同期アナリティクスジョブの詳細を取得します。

ジョブが正常に完了すると（"status": "SUCCESS"）、urlパラメーターで返されるURLにあるファイルをダウンロードしてデータを取得できます。これらの結果ファイルは、転送を最適化するために圧縮（gzip）されており、アクセスする前に解凍する必要があります。

注: このエンドポイントが返すHTTP応答ヘッダーは次のとおりです。

• X-Concurrent-Job-Limit: 特定の時点で処理状態にある可能性のあるジョブの最大数。
• X-Concurrent-Job-Limit-Remaining: 現在処理中のジョブ数を考慮した作成可能な数。

リソースURL¶

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

パラメーター¶

リクエストの例¶

GET https://ads-api.x.com/10/stats/jobs/accounts/18ce54d4x5t?job_ids=883787505404747776

応答の例¶

{
  "request": {
    "params": {
      "job_ids": [
        883787505404747776
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "start_time": "2017-05-19T07:00:00Z",
      "segmentation_type": null,
      "url": "https://ton.twimg.com/advertiser-api-async-analytics/hMk_CPWYqCAYY99gWzylwNJe26HgVm9Iji0wFiuEXbE74bjWsyTtop49MpL-QXO5bhebBZwFhvK9GyNs4gSnfoCG8wdSLmnhKZ0hj7PezoiQggj9AywMDHCMwq3gGHHv.json.gz",
      "id_str": "883787505404747776",
      "entity_ids": [
        "8u94t"
      ],
      "end_time": "2017-05-26T07:00:00Z",
      "country": null,
      "placement": "ALL_ON_TWITTER",
      "id": 883787505404747776,
      "expires_at": "2017-07-10T20:38:57Z",
      "status": "SUCCESS",
      "granularity": "DAY",
      "entity": "LINE_ITEM",
      "created_at": "2017-07-08T20:38:55Z",
      "platform": null,
      "updated_at": "2017-07-08T20:38:57Z",
      "metric_groups": [
        "ENGAGEMENT"
      ]
    }
  ]
}

POST stats/jobs/accounts/:account_id¶

現在のアカウントに非同期アナリティクスジョブを作成します。

セグメント化されていないクエリには、90日の最大時間範囲（end_time - start_time）が許可されます。セグメント化されたクエリの場合、最大時間範囲は45日です。

job_idが返されます。これをGET stats/jobs/accounts/:account_idリクエストで使用すると、ジョブが処理をいつ終了したかを確認できます。

ジョブが正常に完了すると（"status": "SUCCESS"）、urlパラメーターで返されるURLにあるファイルをダウンロードしてデータを取得できます。これらの結果ファイルは、転送を最適化するために圧縮（gzip）されており、アクセスする前に解凍する必要があります。

注: このエンドポイントが返すHTTP応答ヘッダーは次のとおりです。

• X-Concurrent-Job-Limit: 特定の時点で処理状態にある可能性のあるジョブの最大数。
• X-Concurrent-Job-Limit-Remaining: 現在処理中のジョブ数を考慮した作成可能な数。

リソースURL¶

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

パラメーター¶

リクエストの例¶

POST https://ads-api.x.com/10/stats/jobs/accounts/18ce54d4x5t?entity=LINE_ITEM&entity_ids=8u94t&start_time=2017-05-19&end_time=2017-05-26&granularity=DAY&placement=ALL_ON_TWITTER&metric_groups=ENGAGEMENT

応答の例¶

{
  "request": {
    "params": {
      "start_time": "2017-05-19T07:00:00Z",
      "entity_ids": [
        "8u94t"
      ],
      "account_id": "18ce54d4x5t",
      "end_time": "2017-05-26T07:00:00Z",
      "placement": "ALL_ON_TWITTER",
      "granularity": "DAY",
      "entity": "LINE_ITEM",
      "metric_groups": [
        "ENGAGEMENT"
      ]
    }
  },
  "data": {
    "start_time": "2017-05-19T07:00:00Z",
    "segmentation_type": null,
    "url": null,
    "id_str": "883787505404747776",
    "entity_ids": [
      "8u94t"
    ],
    "end_time": "2017-05-26T07:00:00Z",
    "country": null,
    "placement": "ALL_ON_TWITTER",
    "id": 883787505404747776,
    "expires_at": null,
    "status": "PROCESSING",
    "granularity": "DAY",
    "entity": "LINE_ITEM",
    "created_at": "2017-07-08T20:38:55Z",
    "platform": null,
    "updated_at": "2017-07-08T20:38:55Z",
    "metric_groups": [
      "ENGAGEMENT"
    ]
  }
}

DELETE stats/jobs/accounts/:account_id/:job_id¶

指定した広告アカウントの非同期アナリティクスジョブをキャンセルします。

注: キャンセルできるのは、PROCESSINGジョブのみです。

リソースURL¶

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

パラメーター¶

リクエストの例¶

DELETE https://ads-api.x.com/10/stats/jobs/accounts/18ce54d4x5t/823634888955809793

応答の例¶

{
  "request": {
    "params": {
      "job_id": 823634888955809793,
      "account_id": "18ce54d4x5t"
    }
  },
  "data_type": "job",
  "data": {
    "start_time": "2016-10-25T07:00:00Z",
    "segmentation_type": "AGE",
    "url": null,
    "id_str": "823634888955809793",
    "entity_ids": [
      "6c62d"
    ],
    "end_time": "2016-12-05T08:00:00Z",
    "country": null,
    "placement": "ALL_ON_TWITTER",
    "id": 823634888955809793,
    "expires_at": null,
    "status": "CANCELLED",
    "granularity": "DAY",
    "entity": "LINE_ITEM",
    "created_at": "2017-01-23T20:53:54Z",
    "platform": null,
    "updated_at": "2017-01-23T20:53:54Z",
    "metric_groups": [
      "ENGAGEMENT"
    ]
  }
}