アプリの入手に関するファネル データの取得
Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲およびその他のオプションフィルター中にアプリケーションの取得ファネル データを取得します。 この情報は、パートナー センターの取得レポートでも確認できます。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel |
要求ヘッダー
| Header | 型 | 説明 |
|---|---|---|
| 承認 | string | 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。 |
要求パラメーター
| パラメーター | 型 | 内容 | 必須 |
|---|---|---|---|
| applicationId | string | 取得ファネル データを取得するアプリの ストア ID 。 ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。 | はい |
| startDate | 日付 | 取得する取得ファネル データの日付範囲の開始日。 既定値は現在の日付です。 | いいえ |
| endDate | 日付 | 取得する取得ファネル データの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
| filter | string | 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 詳しくは、次の「フィルター フィールド」セクションをご覧ください。 | いいえ |
フィルター フィールド
要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。 各ステートメントには eq 演算子または ne 演算子と関連付けられるフィールドと値が含まれ、and または or を使ってステートメントを組み合わせることができます。
次のフィルター フィールドがサポートされています。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。
| Fields | 説明 |
|---|---|
| campaignId | 取得に関連付けられている カスタム アプリプロモーション キャンペーン の ID 文字列。 |
| market | 入手が行われた市場の、ISO 3166 国コードで記述された文字列。 |
| deviceType | 取得が発生したデバイスの種類を指定する次のいずれかの文字列。
|
| ageGroup | 取得を完了したユーザーの年齢グループを指定する次のいずれかの文字列。
|
| 性別 | 取得を完了したユーザーの性別を指定する次のいずれかの文字列。
|
要求の例
次の例では、アプリの取得ファネル データを取得するためのいくつかの要求を示します。 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>
[応答]
応答本文
| 値 | 種類 | 説明 |
|---|---|---|
| 値 | 配列 | アプリの取得ファネル データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、以下の「 funnel 値 セクション」を参照してください。 |
| TotalCount | int | Value 配列内のオブジェクトの合計数。 |
じょうごの値
Value 配列のオブジェクトには、次の値が含まれます。
| 値 | 種類 | 説明 |
|---|---|---|
| MetricType | string | このオブジェクトに含まれるじょうごデータの 型 を指定する次のいずれかの文字列。
|
| 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": "Acquisition",
"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": "Acquisition",
"UserCount": 8
},
{
"MetricType": "Usage",
"UserCount": 5
},
{
"MetricType": "Install",
"UserCount": 3
}
],
"TotalCount": 4
}