取得附加元件下載數Get add-on acquisitions

使用「Microsoft Store 分析 API」中的這個方法,以針對特定日期範圍及其他選擇性篩選,取得您應用程式之附加元件的彙總下載數資料 (JSON 格式)。Use this method in the Microsoft Store analytics API to get aggregate acquisition data for add-ons for your app in JSON format during a given date range and other optional filters. 您也可以在合作夥伴中心的「附加元件取得」報告中取得這項資訊。This information is also available in the Add-on acquisitions report in Partner Center.

必要條件Prerequisites

若要使用這個方法,您必須先進行下列動作:To use this method, you need to first do the following:

  • 如果您尚未這樣做,請先完成 Microsoft Store 分析 API 的所有先決條件If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • 取得 Azure AD 存取權杖以便用於這個方法的要求標頭。Obtain an Azure AD access token to use in the request header for this method. 在您取得存取權杖之後,您有 60 分鐘的使用時間,之後其便會到期。After you obtain an access token, you have 60 minutes to use it before it expires. 權杖到期之後,您可以取得新的權杖。After the token expires, you can obtain a new one.

要求Request

要求的語法Request syntax

方法Method 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions

要求標頭Request header

頁首Header 類型Type 描述Description
授權Authorization 字串string 必要。Required. Azure AD 存取權杖,形式為 Bearer <token>。The Azure AD access token in the form Bearer <token>.

要求參數Request parameters

applicationIdinAppProductId 參數為必要。The applicationId or inAppProductId parameter is required. 若要擷取所有註冊至 App 之附加元件的下載數資料,請指定 applicationId 參數。To retrieve acquisition data for all add-ons registered to the app, specify the applicationId parameter. 若要擷取單一附加元件的下載數資料,請指定 inAppProductId 參數。To retrieve acquisition data for a single add-on, specify the inAppProductId parameter. 如果您同時指定上面兩個參數,applicationId 參數將會被忽略。If you specify both, the applicationId parameter is ignored.

參數Parameter 類型Type 說明Description 必要Required
applicationIdapplicationId 字串string 您想要抓取附加元件取得資料之應用程式的存放區識別碼The Store ID of the app for which you want to retrieve add-on acquisition data. Yes
inAppProductIdinAppProductId 字串string 您想要抓取取得資料之附加元件的存放區識別碼The Store ID of the add-on for which you want to retrieve acquisition data. Yes
startDatestartDate datedate 要擷取附加元件下載數資料之日期範圍的開始日期。The start date in the date range of add-on acquisition data to retrieve. 預設值是目前的日期。The default is the current date. No
endDateendDate datedate 要擷取附加元件下載數資料之日期範圍的結束日期。The end date in the date range of add-on acquisition data to retrieve. 預設值是目前的日期。The default is the current date. No
toptop intint 在要求中傳回的資料列數目。The number of rows of data to return in the request. 如果未指定,最大值和預設值為 10000。The maximum value and the default value if not specified is 10000. 如果查詢中有更多資料列,回應主體將會包含您可以用來要求下一頁資料的下一頁連結。If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. No
skipskip intint 在查詢中要略過的資料列數目。The number of rows to skip in the query. 使用此參數來瀏覽大型資料集。Use this parameter to page through large data sets. 例如,top=10000 且 skip=0 將擷取前 10000 個資料列的資料,top=10000 且 skip=10000 將擷取下 10000 個資料列的資料,以此類推。For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. No
filterfilter 字串string 一或多個篩選回應中資料列的陳述式。One or more statements that filter the rows in the response. 如需更多資訊,請參閱下方的<篩選欄位>一節。For more information, see the filter fields section below. No
aggregationLevelaggregationLevel 字串string 指定要擷取彙總資料的時間範圍。Specifies the time range for which to retrieve aggregate data. 可以是下列其中一個字串:dayweekmonthCan be one of the following strings: day, week, or month. 如果沒有指定,則預設為 If unspecified, the default is day. No
orderbyorderby 字串string 對每個附加元件下載數的結果資料值做出排序的陳述式。A statement that orders the result data values for each add-on acquisition. 語法為 orderby=field [order],field [order],...,其中 field 參數可以是下列其中一個字串︰The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • acquisitionTypeacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • 細分market
  • osVersionosVersion
  • deviceTypedeviceType
  • orderNameorderName

order 參數為選擇性,並可以是 ascdesc,以指定每個欄位的遞增或遞減順序。The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. 預設值是ascThe default is asc.

以下是範例orderby字串: orderby = date,市Here is an example orderby string: orderby=date,market

No
groupbygroupby 字串string 將資料彙總僅套用至指定欄位的陳述式。A statement that applies data aggregation only to the specified fields. 您可以指定下列欄位:You can specify the following fields:
  • datedate
  • applicationNameapplicationName
  • inAppProductNameinAppProductName
  • acquisitionTypeacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • 細分market
  • osVersionosVersion
  • deviceTypedeviceType
  • orderNameorderName

傳回的資料列將包含 groupby 參數中指定的欄位,以及下列項目:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • inAppProductIdinAppProductId
  • acquisitionQuantityacquisitionQuantity

groupby 參數可以搭配 aggregationLevel 參數使用。The groupby parameter can be used with the aggregationLevel parameter. 例如: & Groupby = ageGroup、市場 & aggregationLevel = 周For example: &groupby=ageGroup,market&aggregationLevel=week

No

篩選欄位Filter fields

要求的 filter 參數包含在回應中篩選資料列的一或多個陳述式。The filter parameter of the request contains one or more statements that filter the rows in the response. 每個陳述式包含一個與 eqne 運算子關聯的欄位和值,而陳述式可以使用 andor 結合。Each statement contains a field and value that are associated with the eq or ne operators, and statements can be combined using and or or. 下列為一些範例 filter 參數:Here are some example filter parameters:

  • filter=market eq 'US' and gender eq 'm'filter=market eq 'US' and gender eq 'm'
  • filter=(market ne 'US') and (gender ne 'Unknown') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne 'greater than 55' or ageGroup ne ‘less than 13’)filter=(market ne 'US') and (gender ne 'Unknown') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne 'greater than 55' or ageGroup ne ‘less than 13’)

如需支援欄位的清單,請參閱下列表格。For a list of the supported fields, see the following table. 篩選 參數中的字串值必須由單引號括住。String values must be surrounded by single quotes in the filter parameter.

欄位Fields 描述Description
acquisitionTypeacquisitionType 下列其中一個字串:One of the following strings:
  • free
  • 試用trial
  • 付費paid
  • promotional codepromotional code
  • iapiap
ageGroupageGroup 下列其中一個字串:One of the following strings:
  • less than 13less than 13
  • 13-1713-17
  • 18-2418-24
  • 25-3425-34
  • 35-4435-44
  • 44-5544-55
  • greater than 55greater than 55
  • UnknownUnknown
storeClientstoreClient 下列其中一個字串:One of the following strings:
  • Windows Phone 市集 (用戶端)Windows Phone Store (client)
  • Microsoft Store (用戶端)Microsoft Store (client)
  • Microsoft Store (web)Microsoft Store (web)
  • Volume purchase by organizationsVolume purchase by organizations
  • 其他Other
gendergender 下列其中一個字串:One of the following strings:
  • 分鐘m
  • ff
  • UnknownUnknown
marketmarket 內含發生下載之市場的 ISO 3166 國家/地區碼的字串。A string that contains the ISO 3166 country code of the market where the acquisition occurred.
osVersionosVersion 下列其中一個字串:One of the following strings:
  • Windows Phone 7.5Windows Phone 7.5
  • Windows Phone 8Windows Phone 8
  • Windows Phone 8.1Windows Phone 8.1
  • Windows Phone 10Windows Phone 10
  • Windows 8Windows 8
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • UnknownUnknown
deviceTypedeviceType 下列其中一個字串:One of the following strings:
  • PCPC
  • 來電Phone
  • 主控台-Xbox OneConsole-Xbox One
  • 主控台-Xbox 系列 XConsole-Xbox Series X
  • IoTIoT
  • 全息影像Holographic
  • UnknownUnknown
orderNameorderName 指定用來取得附加元件之促銷碼訂單名稱的字串 (這只適用於使用者透過兌換促銷碼來取得附加元件的情況)。A string that specifies the name of the order for the promotional code that was used to acquire the add-on (this only applies if the user acquired the add-on by redeeming a promotional code).

要求範例Request example

下列範例示範數個取得附加元件下載數資料的要求。The following examples demonstrates several requests for getting add-on acquisition data. inAppProductIdapplicationId 值以適當的附加元件或 App 的 Store 識別碼取代。Replace the inAppProductId and applicationId values with the appropriate Store ID for your add-on or app.

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>

回應Response

回應本文Response body

Value 類型Type 描述Description
Value arrayarray 內含彙總附加元件下載數資料的物件陣列。An array of objects that contain aggregate add-on acquisition data. 如需有關每個物件中資料的詳細資訊,請參閱下方的附加元件下載數數值一節。For more information about the data in each object, see the add-on acquisition values section below.
@nextLink 字串string 如果還有其他資料頁面,此字串包含可以用來要求下一頁資料的 URI。If there are additional pages of data, this string contains a URI that you can use to request the next page of data. 例如,如果要求的 top 參數被設定為 10000,但是查詢卻有超過 10000 個資料列的附加元件下載數資料,就會傳回此值。For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of add-on acquisition data for the query.
TotalCountTotalCount intint 查詢之資料結果的資料列總數。The total number of rows in the data result for the query.

附加元件下載數數值Add-on acquisition values

Value 陣列中的元素包含下列值。Elements in the Value array contain the following values.

Value 類型Type 描述Description
datedate 字串string 下載數資料之日期範圍中的第一個日期。The first date in the date range for the acquisition data. 如果要求指定單一天數,此值便會是該日期。If the request specified a single day, this value is that date. 如果要求指定一週、一個月或其他日期範圍,此值便會是該日期範圍的第一個日期。If the request specified a week, month, or other date range, this value is the first date in that date range.
inAppProductIdinAppProductId 字串string 您正在擷取下載數資料之附加元件的 Store 識別碼。The Store ID of the add-on for which you are retrieving acquisition data.
inAppProductNameinAppProductName 字串string 附加元件的顯示名稱。The display name of the add-on. 除非您在 groupby 參數中指定 inAppProductName 欄位,否則只有當 aggregationLevel 參數設定為 day 時,回應資料中才會顯示這個值。This value only appears in the response data if the aggregationLevel parameter is set to day, unless you specify the inAppProductName field in the groupby parameter.
applicationIdapplicationId 字串string 您想要擷取附加元件下載數資料之 App 的 Store 識別碼。The Store ID of the app for which you want to retrieve add-on acquisition data.
applicationNameapplicationName 字串string App 的顯示名稱。The display name of the app.
deviceTypedeviceType 字串string 完成下載的裝置類型。The type of device that completed the acquisition. 如需支援的字串清單,請參閱上方的<篩選欄位>一節。For a list of the supported strings, see the filter fields section above.
orderNameorderName 字串string 訂單的名稱。The name of the order.
storeClientstoreClient 字串string 發生下載之 Microsoft Store 的版本。The version of the Store where the acquisition occurred. 如需支援的字串清單,請參閱上方的<篩選欄位>一節。For a list of the supported strings, see the filter fields section above.
osVersionosVersion 字串string 發生下載的 OS 版本。The OS version on which the acquisition occurred. 如需支援的字串清單,請參閱上方的<篩選欄位>一節。For a list of the supported strings, see the filter fields section above.
marketmarket 字串string 發生下載之市場的 ISO 3166 國家/地區碼。The ISO 3166 country code of the market where the acquisition occurred.
gendergender 字串string 做出下載之使用者的性別。The gender of the user who made the acquisition. 如需支援的字串清單,請參閱上方的<篩選欄位>一節。For a list of the supported strings, see the filter fields section above.
ageGroupageGroup 字串string 做出下載之使用者的年齡層。The age group of the user who made the acquisition. 如需支援的字串清單,請參閱上方的<篩選欄位>一節。For a list of the supported strings, see the filter fields section above.
acquisitionTypeacquisitionType 字串string 下載的類型 (免費、付費等等)。The type of acquisition (free, paid, and so on). 如需支援的字串清單,請參閱上方的<篩選欄位>一節。For a list of the supported strings, see the filter fields section above.
acquisitionQuantityacquisitionQuantity integerinteger 發生的下載數目。The number of acquisitions that occurred.

回應範例Response example

下列範例針對此要求示範範例 JSON 回應主體。The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2015-01-02",
      "inAppProductId": "9NBLGGH3LHKL",
      "inAppProductName": "Contoso add-on 7",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso Demo",
      "deviceType": "Phone",
      "orderName": "",
      "storeClient": "Windows Phone Store (client)",
      "osVersion": "Windows Phone 8.1",
      "market": "GB",
      "gender": "m",
      "ageGroup": "50orover",
      "acquisitionType": "iap",
      "acquisitionQuantity": 1
    }
  ],
  "@nextLink": "inappacquisitions?applicationId=9NBLGGGZ5QDR&inAppProductId=&aggregationLevel=day&startDate=2015/01/01&endDate=2016/02/01&top=1&skip=1",
  "TotalCount": 33677
}