取得應用程式獲取漏斗圖資料

  • 發行項

在 Microsoft Store 分析 API 中使用此方法，在特定日期範圍期間和其他選擇性篩選條件取得應用程式的獲取漏斗圖資料。 此資訊也可在合作夥伴中心的獲取報告中取得。

必要條件

要使用此方法，您需要先執行以下操作：

  • 如果您尚未執行此操作，請完成 Microsoft Store 分析 API 的所有必要條件。
  • 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取權杖之後，您在其到期之前有 60 分鐘的時間可以使用。 權杖到期之後，您可以取得新的權杖。

要求

要求語法

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

要求標頭

標題 類型 描述
授權 字串 必要。 持有人<權杖>形式的 Azure AD 存取權杖。

要求參數

參數 類型 描述 必要
applicationId 字串 您想要擷取獲取漏斗圖資料之應用程式的 Store ID。 範例 Store ID 為 9WZDNCRFJ3Q8。 是
startDate date 要擷取獲取漏斗圖資料之日期範圍的開始日期。 預設值是目前的日期。 否
endDate date 要擷取獲取漏斗圖資料之日期範圍的結束日期。 預設值是目前的日期。 否
篩選器 字串 篩選回應中的資料列的一或多個陳述式。 如需詳細資訊，請參閱下面的篩選功能變數一節。 否

 

篩選功能變數

要求的 filter 參數包含一或多個陳述式，可篩選回應中的資料列。 每個陳述式都包含與 eq 或 ne 運算子相關聯的功能變數和值，而且可以使用 and 或 or 來結合陳述式。

支援下列篩選功能變數。 字串值必須以 filter 參數中的單引號括住。

功能變數 描述
campaignId 與獲取相關聯之自訂應用程式促銷活動的識別碼字串。
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
性別 下列其中一個字串，指定已完成獲取的使用者性別：
  • M
  • F
  • Unknown

要求範例

下列範例示範數個取得應用程式獲取漏斗圖資料的要求。 以您應用程式的 Store ID 取代 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>

回應

回應本文

值 類型 描述
值 陣列 物件的陣列，其中包含應用程式的獲取漏斗圖資料。 如需關於每個物件中的資料的詳細資訊，請參閱下方的漏斗圖值一節。
TotalCount int Value 陣列中的物件總數。

漏斗圖值

Value 陣列中的物件包含下列值。

值 類型 描述
MetricType 字串 下列其中一個字串，指定此物件中包含的漏斗圖資料類型：
  • PageView
  • Acquisition
  • 安裝
  • Usage
UserCount 字串 執行 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
}