アプリの入手に関するファネル データの取得

  • [アーティクル]

日付範囲やその他のオプション フィルターを指定して、アプリケーションの入手に関するファネル データを取得するには、Microsoft Store 分析 API の以下のメソッドを使います。 この情報は、パートナー センターの取得レポートでも確認できます。

前提条件

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

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

要求

要求の構文

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

要求ヘッダー

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

要求パラメーター

パラメーター Type 説明 必須
applicationId string 入手に関するファネル データを取得するアプリの ストア ID です。 ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。 はい
startDate 日付 取得する入手に関するファネル データの日付範囲開始日です。 既定値は現在の日付です。 いいえ
endDate 日付 取得する入手に関するファネル データの日付範囲終了日です。 既定値は現在の日付です。 いいえ
filter string 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 詳しくは、次の「フィルター フィールド」セクションをご覧ください。 No

 

フィルター フィールド

要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。 各ステートメントには eq 演算子または ne 演算子と関連付けられるフィールドと値が含まれ、and または or を使ってステートメントを組み合わせることができます。

以下のフィルター フィールドがサポートされています。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。

フィールド 説明
campaignId 入手に関連付けられているカスタム アプリ プロモーション キャンペーンの ID 文字列です。
market 入手が発生した市場の ISO 3166 国コードを含む文字列です。
deviceType 入手が発生したデバイスの種類を指定する、以下のいずれかの文字列です。
  • PC
  • 電話
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holographic
  • Unknown
ageGroup 入手を完了したユーザーの年齢グループを指定する、以下のいずれかの文字列です。
  • 0 – 17
  • 18 – 24
  • 25 – 34
  • 35 – 49
  • 50 or over
  • Unknown
gender 入手を完了したユーザーの性別を指定する、以下のいずれかの文字列です。
  • M
  • F
  • Unknown

要求の例

アプリの入手に関するファネル データを取得するための要求の例を、いくつか次に示します。 applicationId 値を、目的のアプリのストア ID に置き換えてください。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=8/1/2016&endDate=8/31/2016&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答本文

値 Type 説明
値 array アプリに関する入手のファネル データが含まれるオブジェクトの配列です。 各オブジェクトのデータについて詳しくは、次の「ファネル値」セクションをご覧ください。
TotalCount int Value 配列のオブジェクトの合計数です。

ファネル値

Value 配列のオブジェクトには、次の値が含まれます。

値 Type 説明
MetricType string このオブジェクトに含まれるファネル データの種類を指定する以下のいずれかの文字列です。
  • PageView
  • 取得
  • インストール
  • 使用方法
UserCount string MetricType 値によって指定されたファネル手順を実行したユーザーの数です。

要求と応答の例

次のコード スニペットは、これらの要求の要求と JSON 応答本文の例を示しています。

要求のサンプル

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

応答のサンプル

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 6214
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 1502
        },
        {
            "MetricType": "Usage",
            "UserCount": 606
        },
        {
            "MetricType": "Install",
            "UserCount": 977
        }
    ],
    "TotalCount": 4
}

要求のサンプル

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/21/2021&filter=market eq 'US' and gender eq 'm'
HTTP/1.1
Authorization: Bearer <your access token>

応答のサンプル

{
    "Value": [
        {
            "MetricType": "PageView",
            "UserCount": 10
        },
        {
            "MetricType": "Acqusition",
            "UserCount": 8
        },
        {
            "MetricType": "Usage",
            "UserCount": 5
        },
        {
            "MetricType": "Install",
            "UserCount": 3
        }
    ],
    "TotalCount": 4
}