在 Microsoft Store 分析 API 中使用此方法,以在指定日期範圍和其他選擇性篩選期間,取得附加元件的通道匯總轉換。
- 轉換 表示客戶(使用 Microsoft 帳戶登入)最近獲得了您附加元件的授權,不論此附加元件是收費的還是免費提供的。
- 通道 是客戶抵達您 app 清單頁面的方法(例如,透過市集或 自定義應用程式促銷活動)。
這項資訊也可在合作夥伴中心的 附加元件下載報告中 取得。
先決條件
若要使用此方法,您必須先執行下列動作:
- 如果您尚未執行此操作,請完成 Microsoft Store 分析 API 的所有必要條件。
- 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取令牌之後,您必須在 60 分鐘内使用它,否則將會失效。 令牌到期之後,您可以取得新的令牌。
請求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions |
請求標頭
| 頁首 | 類型 | 說明 |
|---|---|---|
| 授權 | 字符串 | 必須的。 Azure AD 存取令牌的形式為 Bearer<token>。 |
要求參數
| 參數 | 類型 | 說明 | 為必填項目 |
|---|---|---|---|
| 應用程式ID | 字符串 | 您想要擷取附加元件轉換數據之應用程式的 市集標識碼。 市集標識符範例為 9WZDNCRFJ3Q8。 | 是的 |
| 應用程式內產品ID | 字符串 | 您要擷取轉換資料的附加元件 市集標識碼。 | 是的 |
| 開始日期 | 日期 | 要擷取之轉換數據之日期範圍的開始日期。 預設值為 2016/1/1。 | 否 |
| 結束日期 | 日期 | 要擷取的轉換數據日期範圍之結束日期。 預設值為目前的日期。 | 否 |
| 返回頁首 | 整數 (int) | 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多資料列,回應內容會包含下一個連結,您可以使用該連結來請求下一頁的資料。 | 否 |
| 略過 | 整數 (int) | 查詢中要略過的行數目。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 | 否 |
| 篩選器 | 字符串 | 一個或多個用於篩選回應內容的語句。 每個語句都可以使用 eq 或 ne 運算符,而 語句可以使用 和 或 或結合。 您可以在篩選語句中指定下列字串。 如需描述,請參閱本文中的 轉換值 一節。
以下是 篩選 參數的範例:filter=deviceType eq 'PC'。 |
否 |
| 聚合層級 | 字符串 | 指定要擷取匯總數據的時間範圍。 可以是下列其中一個字串:day、week 或 month。 如果未指定,則預設值為 day。 | 否 |
| 排序 | 字符串 | 一個語句,用於對每個轉換的結果數據值進行排序。 語法為 orderby=field [order],field [order],...。 field 參數可以是下列其中一個字符串:
order 參數是選擇性的,而且可以是 asc 或 desc,以指定每個欄位的遞增或遞減順序。 預設為asc。 以下是 orderby 字串範例: orderby=date,market |
否 |
| 按群組分類 | 字符串 | 僅將資料彙總套用至指定欄位的陳述式。 您可以指定下欄位:
傳回的數據列將包含 groupby 參數中指定的欄位,以及以下內容:
groupby 參數可以搭配 aggregationLevel 參數使用。 例如: groupby=ageGroup,market&aggregationLevel=week |
否 |
範例請求
下列範例示範取得應用程序轉換資料的數個要求。 以您應用程式的市集標識碼取代 applicationId 值。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US' HTTP/1.1
Authorization: Bearer <your access token>
回應
回應主體
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 價值觀 | 陣列 | 包含附加元件匯總轉換數據的對象陣列。 如需每個物件中數據的詳細資訊,請參閱下方的 轉換值 一節。 |
| @nextLink | 字符串 | 如果有額外的數據頁面,此字串會包含可用來要求下一頁數據的 URI。 例如,如果要求 top 參數設定為 10,但查詢的轉換數據超過 10 個數據列,則會傳回這個值。 |
| 總計數 | 整數 (int) | 查詢的資料結果中的總列數。 |
轉換值
Value 陣列中的物件包含下列值。
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 日期 | 字符串 | 轉換數據之日期範圍中的第一個日期。 如果要求指定了單一天,這個值就是該日期。 如果要求指定了一周、月或其他日期範圍,這個值就是該日期範圍中的第一個日期。 |
| 應用程式內產品ID | 字符串 | 您要擷取轉換資料的附加元件 市集標識碼。 |
| 應用程式內產品名稱 | 字符串 | 您要擷取轉換資料的附加元件的顯示名稱。 |
| 應用程式ID | 字符串 | 您要擷取轉換資料之應用程式的 市集標識碼。 |
| 應用程式名稱 | 字符串 | 您要擷取轉換資料之應用程式的顯示名稱。 |
| 應用程式類型 | 字符串 | 您要擷取轉換資料的產品類型。 對於這個方法,唯一支援的值是 附加元件。 |
| 自訂活動識別碼 | 字符串 | 與應用程式相關聯的 自定義應用推廣活動的 ID 字串。 |
| 引用者URI網域 | 字符串 | 指定已啟用自定義應用程式促銷行銷活動標識碼的應用程式清單所在網域。 |
| 通道類型 | 字符串 | 下列其中一個字串,指定轉換的通道:
|
| storeClient | 字符串 | 發生轉換的應用商店版本。 目前,唯一支援的值是 SFC 。 |
| 裝置類型 | 字符串 | 下列其中一個字串:
|
| 市場 | 字符串 | 發生轉換之市場的 ISO 3166 國家/地區代碼。 |
| 點擊次數 | 數字 | 客戶按下您的應用程式清單連結的數目。 |
| 轉換次數 | 數字 | 客戶轉換的數目。 |
要求和回應範例
下列程式碼片段示範了一些請求的範例,以及這些請求的 JSON 回應內容。
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"inAppProductId": "9NN2HW33ZB2G",
"applicationId": "9NBLGGGZ5QDR",
"clickCount": 220636,
"conversionCount": 154
},
{
"inAppProductId": "9PN07J0WC18B",
"applicationId": "9NBLGGGZ5QDR",
"clickCount": 277061,
"conversionCount": 187
}
],
"@nextLink": "",
"TotalCount": 2
}
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"inAppProductId": "9WZDNCRCWW61",
"inAppProductName": "SeasonPass0",
"appType": "Add-On",
"date": "2022-06-21",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "mcg_mahjong_othergames",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "BR",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-06",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "mcg_solitaire_othergames",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "AT",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5Z",
"inAppProductName": "Episode1Combo",
"appType": "Add-On",
"date": "2022-07-09",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-09",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW4Z",
"inAppProductName": "Episode1Grandfathered",
"appType": "Add-On",
"date": "2022-07-11",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "|autosuggest",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "ES",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5W",
"inAppProductName": "Episode2Combo",
"appType": "Add-On",
"date": "2022-07-11",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW4P",
"inAppProductName": "SeasonPass24",
"appType": "Add-On",
"date": "2022-07-12",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-13",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "9wzdncrfjbd8",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CA",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW61",
"inAppProductName": "SeasonPass0",
"appType": "Add-On",
"date": "2022-07-17",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "scom-web-store",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "US",
"clickCount": 1,
"conversionCount": 1
}
],
"@nextLink": "",
"TotalCount": 9
}