在 Microsoft 市集分析 API 中使用此方法,以取得指定日期範圍內應用程式附加元件的匯總取得數據,格式為 JSON,並可以使用其他可選的篩選條件。 這項資訊也可在合作夥伴中心的 附加元件下載報告中 取得。
先決條件
若要使用此方法,您必須先執行下列動作:
- 如果您尚未這麼做,請完成 Microsoft 市集分析 API 的所有 必要條件 。
- 取得 Azure AD 存取令牌 ,以用於此方法的要求標頭中。 取得存取令牌之後,您必須在 60 分鐘内使用它,否則將會失效。 令牌到期之後,您可以取得新的令牌。
請求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions |
請求標頭
| 頁首 | 類型 | 說明 |
|---|---|---|
| 授權 | 字符串 | 必須的。 Bearer<token>形式的 Azure AD 存取令牌。 |
要求參數
需要 applicationId 或 inAppProductId 參數。 若要擷取向應用程式註冊之所有附加元件的數據,請指定 applicationId 參數。 若要擷取單一附加元件的擷取數據,請指定 inAppProductId 參數。 如果您同時指定這兩個參數,則會忽略 applicationId 參數。
| 參數 | 類型 | 說明 | 為必填項目 |
|---|---|---|---|
| 應用程式ID | 字符串 | 您想要擷取其附加元件購買資料的應用程式之市集標識碼 。 | 是的 |
| 應用程式內產品ID | 字符串 | 您想要擷取之附加元件 市集標識符。 | 是的 |
| 開始日期 | 日期 | 要檢索附加元件獲取數據的日期範圍的開始日期。 預設值為目前的日期。 | 否 |
| 結束日期 | 日期 | 用於擷取附加元件購得數據的日期範圍之結束日期。 預設值為目前的日期。 | 否 |
| 返回頁首 | 整數 (int) | 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多資料列,回應內容會包含下一個連結,您可以使用該連結來請求下一頁的資料。 | 否 |
| 略過 | 整數 (int) | 查詢中要略過的行數目。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 | 否 |
| 篩選器 | 字符串 | 一或多個語句用於篩選回應中的數據列。 如需詳細資訊,請參閱下方 的篩選位元段 一節。 | 否 |
| 聚合層級 | 字符串 | 指定要擷取匯總數據的時間範圍。 可以是下列其中一個字串: 日、 周或 月。 如果未指定,則預設值為 day。 | 否 |
| 排序 | 字符串 | 語句,排序每個附加元件取得的結果數據值。 語法為 orderby=field [order],field [order],...。 field 參數可以是下列其中一個字符串:
order 參數是選擇性的,而且可以是 asc 或 desc,以指定每個欄位的遞增或遞減順序。 預設值為 asc。 以下是 orderby 字串範例: orderby=date,market |
否 |
| 按群組分類 | 字符串 | 僅將資料彙總套用至指定欄位的陳述式。 您可以指定下欄位:
傳回的數據列將包含 groupby 參數中指定的欄位,以及以下內容:
groupby 參數可以搭配 aggregationLevel 參數使用。 例如: &groupby=ageGroup,market&aggregationLevel=week |
否 |
篩選欄位
要求的 filter 參數包含一或多個語句,可篩選響應中的數據列。 每個語句都包含與 eq 或 ne 運算符相關聯的欄位和值,而且語句可以使用 和或結合。 以下是一些 範例篩選 參數:
- filter=市場 eq 'US' 並且 性別 eq '男'
- filter=(market ne 'US') and (gender ne 'Unknown') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne '大於 55' or ageGroup ne '小於 13')
如需支援欄位的清單,請參閱下表。 字串值必須以 篩選 參數中的單引弧括住。
| 領域 | 說明 |
|---|---|
| 收購類型 | 下列其中一個字串:
|
| 年齡組別 | 下列其中一個字串:
|
| storeClient | 下列其中一個字串:
|
| 性別 | 下列其中一個字串:
|
| 市場 | 字串,其中包含發生收購之市場的 ISO 3166 國家/地區代碼。 |
| 作業系統版本 | 下列其中一個字串:
|
| 裝置類型 | 下列其中一個字串:
|
| 訂單名稱 | 字串,指定用來取得附加元件之促銷碼訂單的名稱(這隻適用於使用者藉由兌換促銷碼取得附加元件時)。 |
範例請求
下列範例展示數個有關取得附加元件採購數據的要求。 將 inAppProductId 和 applicationId 值替換成您的附加元件或應用程式的適當商店 ID。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=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/inappacquisitions?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/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>
回應
回應主體
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 價值觀 | 陣列 | 包含聚合附加元件獲取資料的物件陣列。 如需每個物件中數據的詳細資訊,請參閱下方的附加元件 取得值 一節。 |
| @nextLink | 字符串 | 如果有額外的數據頁面,此字串會包含可用來要求下一頁數據的 URI。 例如,如果要求的頂端 參數 |
| 總計數 | 整數 (int) | 查詢的資料結果中的總列數。 |
附加元件購置價值
Value 陣列中的元素包含下列值。
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 日期 | 字符串 | 取得數據之日期範圍中的第一個日期。 如果要求指定了單一天,這個值就是該日期。 如果要求指定了一周、月或其他日期範圍,這個值就是該日期範圍中的第一個日期。 |
| 應用程式內產品ID | 字符串 | 您要取得下載數據的附加元件市集 ID。 |
| 應用程式內產品名稱 | 字符串 | 附加元件的顯示名稱。 除非您在 groupby 參數中指定 inAppProductName 欄位,否則只有在 aggregationLevel 參數設定為 day 時,才會出現在回應數據中。 |
| 應用程式ID | 字符串 | 您想要擷取附加元件下載資料之應用程式的市集標識碼。 |
| 應用程式名稱 | 字符串 | 應用程式的顯示名稱。 |
| 裝置類型 | 字符串 | 完成交易的裝置類型。 如需支援的字串清單,請參閱上面的 篩選欄位 一節。 |
| 訂單名稱 | 字符串 | 訂單的名稱。 |
| storeClient | 字符串 | 發生擷取之市集的版本。 如需支援的字串清單,請參閱上面的 篩選欄位 一節。 |
| 作業系統版本 | 字符串 | 發生獲取時的作業系統版本。 如需支援的字串清單,請參閱上面的 篩選欄位 一節。 |
| 市場 | 字符串 | 發生收購之市場的 ISO 3166 國家/地區代碼。 |
| 性別 | 字符串 | 完成購買的用戶性別。 如需支援的字串清單,請參閱上面的 篩選欄位 一節。 |
| 年齡組別 | 字符串 | 進行下載的用戶年齡群組。 如需支援的字串清單,請參閱上面的 篩選欄位 一節。 |
| 收購類型 | 字符串 | 下載類型(免費、付費等)。 如需支援的字串清單,請參閱上面的 篩選欄位 一節。 |
| 採購數量 | 整數 | 發生的收購次數。 |
要求和回應範例
下列代碼段示範一個請求的範例以及該請求的 JSON 回應主體。
範例要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
範例回應
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NBLGGAAGZDQ",
"date": "2022-07-29",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 18.12,
"purchasePriceLocalAmount": 18.12,
"purchaseTaxUSDAmount": 1.13,
"purchaseTaxLocalAmount": 1.13
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Episode 4",
"addonProductId": "9NAAAAAAAAAQ",
"date": "2017-01-07",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 4.147206,
"purchasePriceLocalAmount": 3.99,
"purchaseTaxUSDAmount": 0.686004,
"purchaseTaxLocalAmount": 0.66
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NALGGGZ5QDQ",
"date": "2018-04-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.99,
"purchasePriceLocalAmount": 1.99,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Strategy Guide Episode 4",
"addonProductId": "9NBLGGGZ5QDQ",
"date": "2021-11-25",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.31902922876179,
"purchasePriceLocalAmount": 150.0,
"purchaseTaxUSDAmount": 0.114315866492689,
"purchaseTaxLocalAmount": 13.0
},
],
"TotalCount": 4,
"DataFreshnessTimestamp": "2022-07-29T05:54:00"
}
相關主題