Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲およびその他のオプションフィルター中にアプリケーションの取得ファネル データを取得します。 この情報は、パートナー センターの 取得レポート でも使用できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | 取得したい獲得ファネルデータのアプリのストアID 。 ストア ID の例は 9WZDNCRFJ3Q8 です。 | イエス |
開始日 | 日付 | 取得ファネルデータの日付範囲から取得する開始日。 既定値は現在の日付です。 | いいえ |
終了日 | 日付 | 取得ファネルデータの取得に必要な日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
フィルター | ひも | 応答内の行をフィルター処理する 1 つ以上のステートメント。 詳細については、以下の「フィルター フィールド セクション」を参照してください。 | いいえ |
フィールドをフィルターする
要求の フィルター パラメーターには、応答内の行をフィルター処理する 1 つ以上のステートメントが含まれています。 各ステートメントには、eq または ne 演算子に関連付けられているフィールドと値が含まれており、ステートメントは、、、、またはを使用して結合できます。
次のフィルター フィールドがサポートされています。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。
田畑 | 説明 |
---|---|
キャンペーンID | 取得に関連付けられている カスタム アプリ プロモーション キャンペーン の ID 文字列。 |
市場 | 取得が発生した市場の ISO 3166 国コードを含む文字列。 |
デバイスタイプ | 取得が発生したデバイスの種類を指定する次のいずれかの文字列。
|
年齢層 | 取得を完了したユーザーの年齢グループを指定する次のいずれかの文字列。
|
ジェンダー | 取得を完了したユーザーの性別を指定する次のいずれかの文字列。
|
要求の例
次の例では、アプリの取得ファネル データを取得するためのいくつかの要求を示します。 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>
[応答]
応答内容
価値 | タイプ | 説明 |
---|---|---|
価値 | 配列 | アプリの取得ファネル データを含むオブジェクトの配列。 各オブジェクトのデータの詳細については、後述の「じょうご値 セクション」を参照してください。 |
トータルカウント | 整数 (int) | Value 配列内のオブジェクトの合計数。 |
ファネルの値
Value 配列内のオブジェクトには、次の値が含まれます。
価値 | タイプ | 説明 |
---|---|---|
メトリックタイプ | ひも | このオブジェクトに含まれるじょうごデータ の
|
ユーザー数 | ひも | 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
}