広告キャンペーンのパフォーマンス データの取得

  • [アーティクル]

日付範囲やその他のオプション フィルターを指定して、アプリケーションに関するプロモーション用広告キャンペーンのパフォーマンス データの集計サマリーを取得するには、Microsoft Store 分析 API の以下のメソッドを使います。 このメソッドは、データを JSON 形式で返します。

このメソッドは、パートナー センターの広告キャンペーン レポートで提供されるのと同じデータを返します。 広告キャンペーンについて詳しくは、「アプリ向けの広告キャンペーンの作成」をご覧ください。

広告キャンペーンの詳細を作成、更新、取得するには、Microsoft Store プロモーション API の広告キャンペーンの管理メソッドを使用します。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。

要求

要求の構文

認証方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion

要求ヘッダー

Header 型 説明
承認 string 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。

要求パラメーター

特定のアプリに関する広告キャンペーンのパフォーマンス データを取得するには、applicationId パラメーターを使用します。 開発者アカウントに関連付けられているすべてのアプリに関する広告パフォーマンス データを取得するには、applicationId パラメーターは省略します。

パラメーター Type 内容 必須
applicationId string 広告キャンペーンのパフォーマンス データを取得するアプリの Store ID です。 No
startDate 日付 広告キャンペーンのパフォーマンス データを取得する日付範囲の開始日です。YYYY/MM/DD の形式で指定します。 既定値は、現在の日付から 30 日を差し引いた日付になります。 いいえ
endDate 日付 広告キャンペーンのパフォーマンス データを取得する日付範囲の終了日です。YYYY/MM/DD の形式で指定します。 既定値は、現在の日付から 1 日を差し引いた日付になります。 いいえ
top int 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 いいえ
skip int クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。 No
filter string 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 サポートされているフィルターは campaignId のみです。 各ステートメントでは eq や ne 演算子を使用できます。また、ステートメントを and や or で結合することもできます。 filter パラメーターの例: filter=campaignId eq '100023'。 No
aggregationLevel string 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 指定しない場合、既定値は day です。 No
orderby string

広告キャンペーンのパフォーマンス データに関する結果データ値の順序を指定するステートメントです。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。

  • date
  • campaignId

order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。

orderby 文字列の例: orderby=date,campaignId

 No
groupby string

指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。

  • campaignId
  • applicationId
  • date
  • currencyCode

groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。 例: &groupby=applicationId&aggregationLevel=week

 いいえ

要求の例

広告キャンペーンのパフォーマンス データを取得するための要求の例を、いくつか次に示します。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答本文

値 種類 説明
値 array 広告キャンペーンのパフォーマンスに関する集計データが含まれるオブジェクトの配列です。 各オブジェクトのデータについて詳しくは、次の「キャンペーンのパフォーマンス オブジェクト」セクションをご覧ください。
@nextLink string データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 5 に設定されたが、クエリに対するデータに 5 個を超える項目が含まれている場合に、この値が返されます。
TotalCount int クエリの結果データ内の行の総数です。

キャンペーンのパフォーマンス オブジェクト

Value 配列の要素には、次の値が含まれます。

値 種類 説明
date string 広告キャンペーンのパフォーマンス データの対象となる日付範囲の最初の日付です。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。
applicationId string 広告キャンペーンのパフォーマンス データを取得するアプリのストア ID です。
campaignId string 広告キャンペーンの ID です。
lineId string このパフォーマンス データを生成した広告キャンペーン配信ラインの ID です。
currencyCode string キャンペーン予算の通貨コードです。
spend string 広告キャンペーンで消費した予算金額です。
impressions long キャンペーンの広告インプレッションの数です。
installs long キャンペーンに関連するアプリのインストールの数です。
clicks long キャンペーンの広告クリックの数です。
iapInstalls long キャンペーンに関連するアドオン (アプリ内購入または IAP とも呼ばれます) のインストールの数。
activeUsers long キャンペーンの一部である広告をクリックし、アプリに戻ったユーザーの数です。

応答の例

この要求の JSON 返信の本文の例を次に示します。

{
  "Value": [
    {
      "date": "2015-04-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "4568",
      "lineId": "0001",
      "currencyCode": "USD",
      "spend": 700.6,
      "impressions": 200,
      "installs": 30,
      "clicks": 8,
      "iapInstalls": 0,
      "activeUsers": 0
    },
    {
      "date": "2015-05-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "1234",
      "lineId": "0002",
      "currencyCode": "USD",
      "spend": 325.3,
      "impressions": 20,
      "installs": 2,
      "clicks": 5,
      "iapInstalls": 0,
      "activeUsers": 0
    }
  ],
  "@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
  "TotalCount": 1917
}