広告のパフォーマンス データを取得する

Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲やその他のオプションフィルター中にアプリケーションの広告パフォーマンス データを集計します。 このメソッドは、JSON 形式でデータを返します。

このメソッドは、パートナー センターの Advertising パフォーマンス レポート によって提供されるのと同じデータを返します。

[前提条件]

このメソッドを使用するには、まず次の操作を行う必要があります。

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

詳細については、「Microsoft Store サービスを使用した分析データへのアクセス」を参照してください。

リクエスト

リクエスト構文

リクエストヘッダー

要求パラメーター

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

フィールドをフィルターする

要求本文の フィルター パラメーターには、応答の行をフィルター処理する 1 つ以上のステートメントが含まれています。 各ステートメントには、eq または ne 演算子に関連付けられているフィールドと値が含まれており、ステートメントは、、、、またはを使用して結合できます。 フィルター パラメーターの例を次に示します。

• filter=market eq 'US' と deviceType eq 'phone'

サポートされているフィールドの一覧については、次の表を参照してください。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。

要求の例

次の例では、広告のパフォーマンス データを取得するためのいくつかの要求を示します。 applicationId の値をアプリのストア ID に置き換えます。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答内容

広告のパフォーマンス値

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

応答の例

次の例は、この要求の JSON 応答本文の例を示しています。

{
  "Value": [
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10765920",
      "adUnitName":"TestAdUnit",
      "revenueInAccountCurrency": 10.0,
      "impressions": 1000,
      "requests": 10000,
      "clicks": 1,
      "accountCurrencyCode":"USD"
    },
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10795110",
      "adUnitName":"TestAdUnit2",
      "revenueInAccountCurrency": 20.0,
      "impressions": 2000,
      "requests": 20000,
      "clicks": 3,
      "accountCurrencyCode":"USD"
    },
  ],
  "@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
  "TotalCount": 191753
}

関連トピック

• 広告パフォーマンスレポート
• Microsoft Store サービス を使用して分析データにアクセスする