アドオン買収データ、ゲームとアプリの取得します。Get add-on acquisitions data for your games and apps

Microsoft Store analytics API でこのメソッドを使用して、UWP アプリ、Xbox One のゲームを Xbox 開発者ポータル (XDP) を取り込んだと XDP Analytics パートナー センター ダッシュ ボードで使用できる JSON 形式で取得データの集計のアドオンを取得します。Use this method in the Microsoft Store analytics API to get aggregate add-on acquisition data in JSON format for UWP apps and Xbox One games that were ingested through the Xbox Developer Portal (XDP) and available in the XDP Analytics Partner Center dashboard.

前提条件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.

注意

この API では、10 月 1 日 2016年より前に日単位の集計データは提供されません。This API does not provide daily aggregate data before Oct 1st 2016.

要求Request

要求の構文Request syntax

メソッドMethod 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. フォームの Azure AD アクセス トークンベアラー <token>します。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

ApplicationIdまたはaddonProductIdパラメーターが必要です。The applicationId or addonProductId parameter is required. アプリに登録されたすべてのアドオンの入手データを取得するには、applicationId パラメーターを指定します。To retrieve acquisition data for all add-ons registered to the app, specify the applicationId parameter. 1 つのアドオンの購入データを取得する指定、 addonProductIdパラメーター。To retrieve acquisition data for a single add-on, specify the addonProductId parameter. 両方を指定した場合、applicationId パラメーターは無視されます。If you specify both, the applicationId parameter is ignored.

パラメーターParameter 種類Type 説明Description 必須Required
applicationIdapplicationId stringstring ProductId取得データを取得する Xbox One のゲームの。The productId of the Xbox One game for which you are retrieving acquisition data. 取得する、 productId XDP 分析プログラムでゲームに移動し、ゲームの取得、 productId URL から。To get the productId of your game, navigate to your game in the XDP Analytics Program and retrieve the productId from the URL. また、パートナー センターの analytics レポートから買収データをダウンロードする場合は、 productId .tsv ファイルに挿入されます。Alternatively, if you download your acquisitions data from the Partner Center analytics report, the productId is included in the .tsv file. Yes
addonProductIdaddonProductId stringstring ProductId取得データを取得するアドオンの。The productId 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. XNo
endDateendDate datedate 取得するアドオン入手データの日付範囲終了日です。The end date in the date range of add-on acquisition data to retrieve. 既定値は現在の日付です。The default is the current date. XNo
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. XNo
skipskip intint クエリでスキップする行数です。The number of rows to skip in the query. 大きなデータ セットを操作するには、このパラメーターを使用します。Use this parameter to page through large data sets. たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。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. XNo
filterfilter stringstring 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。One or more statements that filter the rows in the response. 各ステートメントには、応答本文と、eq、ne または演算子に関連付けられている値からフィールド名が含まれていますとを使用してステートメントを組み合わせることができますとまたはまたはします。Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. 文字列の値は、フィルター パラメーターで単一引用符で囲む必要があります。String values must be surrounded by single quotes in the filter parameter. たとえば、フィルター処理 = 市場 eq '米国'] と [性別の eq います '。For example, filter=market eq 'US' and gender eq 'm'.
応答本文から次のフィールドを指定することができます。You can specify the following fields from the response body:
  • acquisitionTypeacquisitionType
  • 経過時間age
  • storeClientstoreClient
  • 性別gender
  • marketmarket
  • osVersionosVersion
  • deviceTypedeviceType
  • sandboxIdsandboxId
XNo
aggregationLevelaggregationLevel stringstring 集計データを取得する時間範囲を指定します。Specifies the time range for which to retrieve aggregate data. 次のいずれかの文字列を指定できます。dayweek、または monthCan be one of the following strings: day, week, or month. 指定しない場合、既定値は day です。If unspecified, the default is day. XNo
orderbyorderby stringstring それぞれのアドオン入手数について結果データ値の順序を指定するステートメントです。A statement that orders the result data values for each add-on acquisition. 構文は orderby フィールド [order]、[順序] フィールドを = しています. field パラメーターには、次のいずれかの文字列を指定できます。The syntax is orderby=field [order],field [order],... The field parameter can be one of the following strings:
  • datedate
  • acquisitionTypeacquisitionType
  • 経過時間age
  • storeClientstoreClient
  • 性別gender
  • marketmarket
  • osVersionosVersion
  • deviceTypedeviceType
  • orderNameorderName
順序パラメーターは省略可能で、できるascまたはdescを昇順または降順の各フィールドの順序を指定します。The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. 既定値は asc です。The default is asc.
orderby 文字列の例: orderby=date,marketHere is an example orderby string: orderby=date,market
XNo
groupbygroupby stringstring 指定したフィールドのみにデータ集計を適用するステートメントです。A statement that applies data aggregation only to the specified fields. 次のフィールドを指定できます。You can specify the following fields:
  • datedate
  • applicationNameapplicationName
  • addonProductNameaddonProductName
  • acquisitionTypeacquisitionType
  • 経過時間age
  • storeClientstoreClient
  • 性別gender
  • marketmarket
  • osVersionosVersion
  • deviceTypedeviceType
  • paymentInstrumentTypepaymentInstrumentType
  • sandboxIdsandboxId
  • xboxTitleIdHexxboxTitleIdHex
返されるデータ行には、groupby パラメーターに指定したフィールドと次の値が含まれます。The returned data rows will contain the fields specified in the groupby parameter as well as the following:
  • datedate
  • applicationIdapplicationId
  • addonProductIdaddonProductId
  • acquisitionQuantityacquisitionQuantity
Groupby パラメーターで使用できる、 aggregationLevelパラメーター。The groupby parameter can be used with the aggregationLevel parameter. 例: & groupby = 年齢、市場 aggregationLevel = 週For example: &groupby=age,market&aggregationLevel=week
いいえNo

要求の例Request example

アドオン入手データを取得するためのいくつかの要求の例を次に示します。The following examples demonstrates several requests for getting add-on acquisition data. 置換、 addonProductIdapplicationIdアドオンまたはアプリの適切な Store ID の値。Replace the addonProductId and applicationId values with the appropriate Store ID for your add-on or app.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions?applicationId=9WZDNCRFJ314&startDate=1/1/2015&endDate=2/1/2015&skip=0 HTTP/1.1 

Authorization: Bearer <your access token> 

 

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions?applicationId=9WZDNCRFJ314&startDate=1/1/2015&endDate=2/1/2015&skip=0&filter=market eq 'GB' and gender eq 'm' HTTP/1.1 

Authorization: Bearer <your access token>

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
ValueValue 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 stringstring データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる 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 に設定されたが、クエリのアドオン入手データに 10,000 を超える行が含まれている場合に、この値が返されます。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

値の配列内の要素には、次の値が含まれます。Elements in the Value array contain the following values.

Value 種類Type 説明Description
datedate stringstring 入手データの日付範囲の最初の日付です。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.
addonProductIdaddonProductId stringstring ProductId取得データを取得するアドオンの。The productId of the add-on for which you are retrieving acquisition data.
addonProductNameaddonProductName stringstring アドオンの表示名です。The display name of the add-on. この値のみが表示されます、応答データの場合、 aggregationLevelパラメーターに設定されて指定しない限り、 addonProductNameフィールド、にgroupbyパラメーター。This value only appears in the response data if the aggregationLevel parameter is set to day, unless you specify the addonProductName field in the groupby parameter.
applicationIdapplicationId stringstring ProductIdのアドオン購入データを取得するアプリです。The productId of the app for which you want to retrieve add-on acquisition data.
applicationNameapplicationName stringstring ゲームの表示名です。The display name of the game.
deviceTypedeviceType stringstring 入手が完了したデバイスの種類を指定する、以下のいずれかの文字列です。One of the following strings that specifies the type of device that completed the acquisition:
  • "PC""PC"
  • 「電話」"Phone"
  • 「コンソール」"Console"
  • "IoT""IoT"
  • "Server""Server"
  • "Tablet""Tablet"
  • "Holographic""Holographic"
  • 「不明」"Unknown"
storeClientstoreClient stringstring 入手が発生した Store のバージョンを示す、以下のいずれかの文字列です。One of the following strings that indicates the version of the Store where the acquisition occurred:
  • 「Windows Phone ストア (クライアント)」"Windows Phone Store (client)"
  • "Microsoft Store (クライアント)"(または「Windows ストア (クライアント)」、2018 年 3 月 23 日の前にデータのクエリを実行する場合)"Microsoft Store (client)" (or "Windows Store (client)" if querying for data before March 23, 2018)
  • "Microsoft Store (web)"(または"Windows Store (web)"の場合は、2018 年 3 月 23 日の前にデータの照会)"Microsoft Store (web)" (or "Windows Store (web)" if querying for data before March 23, 2018)
  • 組織でボリューム購入""Volume purchase by organizations"
  • 「その他」"Other"
osVersionosVersion stringstring 入手が発生した OS のバージョンです。The OS version on which the acquisition occurred. このメソッドは、この値は常に値が"Windows 10"です。For this method, this value is always "Windows 10".
marketmarket stringstring 入手が発生した市場の ISO 3166 国コードです。The ISO 3166 country code of the market where the acquisition occurred.
gendergender stringstring 入手したユーザーの性別を指定する、以下のいずれかの文字列です。One of the following strings that specifies the gender of the user who made the acquisition:
  • "m""m"
  • "f""f"
  • 「不明」"Unknown"
ageage stringstring 入手したユーザーの年齢グループを示す、以下のいずれかの文字列です。One of the following strings that indicates the age group of the user who made the acquisition:
  • 「より小さい 13」"less than 13"
  • "13-17""13-17"
  • "18-24""18-24"
  • "25-34""25-34"
  • "35-44""35-44"
  • "44-55""44-55"
  • 「55 より大きい」"greater than 55"
  • 「不明」"Unknown"
acquisitionTypeacquisitionType stringstring 入手の種類を示す、以下のいずれかの文字列です。One of the following strings that indicates the type of acquisition:
  • 「無料」"Free"
  • 「試用版」"Trial"
  • 「有料」"Paid"
  • 「プロモーション コード」"Promotional code"
  • "Iap""Iap"
  • "サブスクリプション Iap""Subscription Iap"
  • "プライベート Audience""Private Audience"
  • 「より前の順序」"Pre Order"
  • "Xbox Game Pass"(または「ゲーム パス」が、2018 年 3 月 23 日の前にデータの照会)"Xbox Game Pass" (or "Game Pass" if querying for data before March 23, 2018)
  • "Disk""Disk"
  • 「プリペイド コード」"Prepaid Code"
  • 「以前の注文を課金」"Charged Pre Order"
  • 「以前の注文をキャンセル」"Cancelled Pre Order"
  • 「以前の注文に失敗しました」"Failed Pre Order"
acquisitionQuantityacquisitionQuantity 整数integer 発生した入手の数です。The number of acquisitions that occurred.
inAppProductIdinAppProductId stringstring このアドオンが使用されている製品のプロダクト ID。Product ID of the product where this add-on is used.
inAppProductNameinAppProductName stringstring このアドオンが使用されている製品の製品名。Product Name of the product where this add-on is used.
paymentInstrumentTypepaymentInstrumentType stringstring 支払い方法タイプは、取得のために使用します。Payment instrument type used for the acquisition.
sandboxIdsandboxId stringstring ゲーム用に作成されたサンド ボックス ID。The Sandbox ID created for the game. 値を指定できます小売またはプライベートのサンド ボックス id。This can be the value RETAIL or a private sandbox ID.
xboxTitleIdxboxTitleId stringstring 該当する場合、XDP から製品の Xbox タイトル ID です。Xbox Title ID of the product from XDP, if applicable.
localCurrencyCodelocalCurrencyCode stringstring パートナー センター アカウントの国に基づくローカルの通貨コード。Local Currency code based on the country of the Partner Center account.
xboxProductIdxboxProductId stringstring 該当する場合、XDP から製品の Xbox 製品 ID です。Xbox Product ID of the product from XDP, if applicable.
availabilityIdavailabilityId stringstring 該当する場合、XDP から製品の可用性の ID。Availability ID of the product from XDP, if applicable.
skuIdskuId stringstring 該当する場合、XDP から製品の SKU ID です。SKU ID of the product from XDP, if applicable.
skuDisplayNameskuDisplayName stringstring 該当する場合、XDP から製品の SKU 表示名。SKU Display Name of the product from XDP, if applicable.
xboxParentProductIdxboxParentProductId stringstring 該当する場合、XDP から製品の Xbox 親プロダクト ID。Xbox Parent Product ID of the product from XDP, if applicable.
parentProductNameparentProductName stringstring 該当する場合、XDP から製品の親製品名。Parent Product Name of the product from XDP, if applicable.
productTypeNameproductTypeName stringstring 該当する場合、XDP から製品の製品の種類名。Product Type Name of the product from XDP, if applicable.
purchaseTaxTypepurchaseTaxType stringstring 該当する場合は、XDP から税の種類の製品を購入します。Purchase Tax Type of the product from XDP, if applicable.
purchasePriceUSDAmountpurchasePriceUSDAmount numbernumber アドオンには、顧客が支払った金額は、米国ドルに変換されます。The amount paid by the customer for the add-on, converted to USD.
purchasePriceLocalAmountpurchasePriceLocalAmount numbernumber アドオンに適用される税額。The tax amount applied to the add-on.
purchaseTaxUSDAmountpurchaseTaxUSDAmount numbernumber アドオンに適用される税額は米国ドルに変換されます。The tax amount applied to the add-on, converted to USD.
purchaseTaxLocalAmountpurchaseTaxLocalAmount numbernumber 該当する場合は、XDP からローカルに税額製品を購入します。Purchase Tax Local Amount of the product from XDP, if applicable.

応答の例Response example

この要求の JSON 返信の本文の例を次に示します。The following example demonstrates an example JSON response body for this request.

{ 
  "Value": [ 
    { 
            "inAppProductId": "9NBLGGH1864K", 
            "inAppProductName": "866879", 
            "addonProductId": "9NBLGGH1864K", 
            "addonProductName": "866879", 
            "date": "2017-11-05", 
            "applicationId": "9WZDNCRFJ314", 
            "applicationName": "Tetris Blitz", 
            "acquisitionType": "Iap", 
            "age": "35-49", 
            "deviceType": "Phone", 
            "gender": "m", 
            "market": "US", 
            "osVersion": "Windows Phone 8.1", 
            "paymentInstrumentType": "Credit Card", 
            "sandboxId": "RETAIL", 
            "storeClient": "Windows Phone Store (client)", 
            "xboxTitleId": "", 
            "localCurrencyCode": "USD", 
            "xboxProductId": "00000000-0000-0000-0000-000000000000", 
            "availabilityId": "", 
            "skuId": "", 
            "skuDisplayName": "Full", 
            "xboxParentProductId": "", 
            "parentProductName": "Tetris Blitz", 
            "productTypeName": "Add-On", 
            "purchaseTaxType": "", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 1.08, 
            "purchasePriceLocalAmount": 0.09, 
            "purchaseTaxUSDAmount": 1.08, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

    "@nextLink": null, 
    
    "TotalCount": 7601 
}