在Microsoft市集分析 API 中使用此方法,以 JSON 格式取得應用程式在指定日期範圍和其他選擇性篩選期間的匯總擷取數據。 此資訊也可在合作夥伴中心的 下載數報告中 取得。
先決條件
若要使用此方法,您必須先執行下列動作:
- 如果您尚未這麼做,請完成 Microsoft 商店分析 API 的所有 必要條件 。
- 取得 Azure AD 存取令牌 ,以用於此方法的要求標頭中。 取得存取令牌之後,您必須在 60 分鐘内使用它,否則將會失效。 令牌到期之後,您可以取得新的令牌。
請求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions |
請求標頭
| 頁首 | 類型 | 說明 |
|---|---|---|
| 授權 | 字符串 | 必須的。 持有人令牌<形式的> Azure AD 存取令牌。 |
要求參數
| 參數 | 類型 | 說明 | 為必填項目 |
|---|---|---|---|
| 應用程式ID | 字符串 | 您想要擷取下載資料之應用程式的 市集標識碼 。 | 是的 |
| 開始日期 | 日期 | 要擷取之獲取數據日期範圍的開始日期。 預設值為目前的日期。 | 否 |
| 結束日期 | 日期 | 要擷取之獲取數據的日期範圍的結束日期。 預設值為目前的日期。 | 否 |
| 返回頁首 | 整數 (int) | 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多資料列,回應內容會包含下一個連結,您可以使用該連結來請求下一頁的資料。 | 否 |
| 略過 | 整數 (int) | 查詢中要略過的行數目。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 | 否 |
| 篩選器 | 字符串 | 一或多個語句用於篩選回應中的數據列。 每個陳述式都包含回應本文的欄位名稱及與 eq 或 ne 運算符相關聯的值,且陳述式可以使用 和 或 或 結合。 字串值必須以 篩選 參數中的單引弧括住。 例如 filter=market eq 'US' 和 gender eq 'm'。
您可以從回應主體指定下列欄位:
|
否 |
| 聚合層級 | 字符串 | 指定要擷取匯總數據的時間範圍。 可以是下列其中一個字串: 日、 周或 月。 如果未指定,則預設值為 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/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm' HTTP/1.1
Authorization: Bearer <your access token>
回應
回應主體
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 價值觀 | 陣列 | 對象的陣列,其中包含應用程式的匯總擷取數據。 如需每個物件中數據的詳細資訊,請參閱下方的 下載值 一節。 |
| @nextLink | 字符串 | 如果有額外的數據頁面,此字串會包含可用來要求下一頁數據的 URI。 例如,如果要求的 top 參數設定為 10000,但查詢的擷取數據超過 10000 個數據列,則會傳回此值。 |
| 總計數 | 整數 (int) | 查詢的資料結果中的總列數。 |
收購價值
Value 陣列中的元素包含下列值。
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 日期 | 字符串 | 取得數據之日期範圍中的第一個日期。 如果要求指定了單一天,這個值就是該日期。 如果要求指定了一周、月或其他日期範圍,這個值就是該日期範圍中的第一個日期。 |
| 應用程式ID | 字符串 | 您要擷取下載資料之應用程式的市集標識碼。 |
| 應用程式名稱 | 字符串 | 應用程式的顯示名稱。 |
| 裝置類型 | 字符串 | 下列其中一個字串,指定發生擷取的裝置類型:
|
| 訂單名稱 | 字符串 | 訂單的名稱。 |
| storeClient | 字符串 | 下列其中一個字串,指示進行購買的市集版本:
|
| 作業系統版本 | 字符串 | 下列字串之一,指定擷取發生時的作業系統版本:
|
| 市場 | 字符串 | 發生收購之市場的 ISO 3166 國家/地區代碼。 |
| 性別 | 字符串 | 下列其中一個字串,指定進行獲取的使用者性別:
|
| 年齡組別 | 字符串 | 下列其中一個字串,指定進行下載的使用者年齡群組:
|
| 收購類型 | 字符串 | 下列其中一個字串,用來指出獲取的類型:
|
| 採購數量 | 數字 | 指定匯總層級期間發生的收購數量。 |
要求和回應範例
下列程式碼片段示範了一些請求的範例,以及這些請求的 JSON 回應內容。
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"date": "2022-07-29",
"acquisitionQuantity": 7,
"purchasePriceUSDAmount": 0.0,
"purchasePriceLocalAmount": 0.0,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
],
"TotalCount": 1,
"DataFreshnessTimestamp": "2022-07-29T08:42:00"
}
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"acquisitionType": "Free",
"storeClient": "Microsoft Store (client)",
"gender": "f",
"market": "TW",
"osVersion": "Windows 10",
"deviceType": "PC",
"date": "2021-08-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 0.0,
"purchasePriceLocalAmount": 0.0,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"acquisitionType": "Free",
"storeClient": "Microsoft Store (client)",
"gender": "Unknown",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"date": "2021-08-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 0.0,
"purchasePriceLocalAmount": 0.0,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
],
"TotalCount": 2,
"DataFreshnessTimestamp": "2022-07-29T08:42:00"
}