在 Microsoft Store 分析 API 中使用此方法，以取得應用程式在指定日期範圍內的獲取漏斗數據及其他選用篩選條件。 此資訊也可在合作夥伴中心的 下載數報告中 取得。
先決條件
若要使用此方法，您必須先執行下列動作：
- 如果您尚未執行此操作，請完成 Microsoft Store 分析 API 的所有必要條件。
- 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取令牌之後，您必須在 60 分鐘内使用它，否則將會失效。 令牌到期之後，您可以取得新的令牌。
請求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/funnel |
請求標頭
| 頁首 | 類型 | 說明 |
|---|---|---|
| 授權 | 字符串 | 必須的。 Azure AD 存取令牌的形式為 Bearer<token>。 |
要求參數
| 參數 | 類型 | 說明 | 為必填項目 |
|---|---|---|---|
| 應用程式ID | 字符串 | 您想要擷取取得漏斗數據之應用程式的 市集識別碼。 市集標識符範例為 9WZDNCRFJ3Q8。 | 是的 |
| 開始日期 | 日期 | 要取得的蒐集漏斗數據之日期範圍的開始日期。 預設值為目前的日期。 | 否 |
| 結束日期 | 日期 | 要擷取的轉換數據日期範圍的結束日期。 預設值為目前的日期。 | 否 |
| 篩選器 | 字符串 | 一或多個語句用於篩選回應中的數據列。 如需詳細資訊，請參閱下方的 篩選字段 一節。 | 否 |
篩選欄位
要求的 filter 參數包含一或多個語句，可篩選響應中的數據列。 每個語句都包含與 eq 或 ne 運算符相關聯的欄位和值，而且語句可以使用 和或結合。
支援下列篩選欄位。 字串值必須以 篩選 參數中的單引弧括住。
| 領域 | 說明 |
|---|---|
| 活動ID | 與自定義應用程式促銷活動相關的標識符字串， 與取得有關聯。 |
| 市場 | 字串，其中包含發生收購之市場的 ISO 3166 國家/地區代碼。 |
| 裝置類型 | 下列其中一個字串，指定發生擷取的裝置類型：
|
| 年齡組別 | 下列其中一個字串，用以指定完成獲取的使用者年齡群組：
|
| 性別 | 下列其中一個字串，指定完成擷取的用戶性別：
|
範例請求
下列範例示範幾種取得 App 獲取渠道數據的請求。 以您應用程式的市集標識碼取代 applicationId 值。
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
}