Xbox Live の同時使用状況データの取得Get Xbox Live concurrent usage data

Xbox Live 対応ゲームをプレイしたユーザーの平均数について、分単位、時間単位、または日単位でリアルタイムに近い使用状況データ (5 ~ 15 分の遅延) を取得するには、Microsoft Store 分析 API の以下のメソッドを使います。Use this method in the Microsoft Store analytics API to get near real-time usage data (with 5-15 minutes latency) about the average number of customers playing your Xbox Live-enabled game every minute, hour, or day during a specified time range. この情報も記載されて、 Xbox analytics レポートパートナー センターでします。This information is also available in the Xbox analytics report in Partner Center.

重要

このメソッドは、Xbox のゲームまたは Xbox Live サービスを使用するゲームのみサポートします。This method only supports games for Xbox or games that use Xbox Live services. これらのゲームは、概念の承認プロセスを完了する必要があります。これには、Microsoft パートナーが発行したゲームと ID@Xbox プログラムを介して申請されたゲームが含まれます。These games must go through the concept approval process, which includes games published by Microsoft partners and games submitted via the ID@Xbox program. このメソッドでは、Xbox Live クリエーターズ プログラムを介して発行されたゲームは現在サポートされていません。This method does not currently support games published via the Xbox Live Creators Program.

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

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

パラメーターParameter 種類Type 説明Description 必須Required
applicationIdapplicationId stringstring Xbox Live の同時使用状況データを取得するゲームの Store ID です。The Store ID of the game for which you want to retrieve Xbox Live concurrent usage data. Yes
metricTypemetricType stringstring 取得する Xbox Live 分析データの種類を指定する文字列です。A string that specifies the type of Xbox Live analytics data to retrieve. このメソッドでは、値 concurrency を指定します。For this method, specify the value concurrency. Yes
startDatestartDate datedate 取得する同時使用状況データの日付範囲の開始日です。The start date in the date range of concurrent usage data to retrieve. 既定の動作については aggregationLevel の説明をご覧ください。See the aggregationLevel description for default behavior. XNo
endDateendDate datedate 取得する同時使用状況データの日付範囲の終了日です。The end date in the date range of concurrent usage data to retrieve. 既定の動作については aggregationLevel の説明をご覧ください。See the aggregationLevel description for default behavior. XNo
aggregationLevelaggregationLevel stringstring 集計データを取得する時間範囲を指定します。Specifies the time range for which to retrieve aggregate data. minutehourday のいずれかの文字列を指定できます。Can be one of the following strings: minute, hour, or day. 指定しない場合、既定値は day です。If unspecified, the default is day.

startDate または endDate を指定しなかった場合、応答本文は既定で次のようになります。If you do not specify startDate or endDate, the response body defaults to the following:

  • :使用可能なデータの最後の 60 のレコード。minute: The last 60 records of available data.
  • 1 時間:使用可能なデータの直近 24 個のレコード。hour: The last 24 records of available data.
  • 1 日:使用可能なデータの最後の 7 レコード。day: The last 7 records of available data.

各集計レベルでは、返すことのできるレコード数にサイズ制限があります。The following aggregation levels have size limits on the number of records that can be returned. 要求された期間が大きすぎる場合、レコードは切り捨てられます。The records will be truncated if the requested time span is too large.

  • :最大 1440 (24 時間のデータ) を記録します。minute: Up to 1440 records (24 hours of data).
  • 1 時間:最大 720 レコード (データの 30 日)。hour: Up to 720 records (30 days of data).
  • 1 日:最大 60 レコード (データの 60 日)。day: Up to 60 records (60 days of data).
XNo

要求の例Request example

次の例では、Xbox Live 対応ゲームの同時使用状況データを取得する要求を示します。The following example demonstrates a request for getting concurrent usage data for your Xbox Live-enabled game. この要求は、2018 年 2 月 1 日から 2018 年 2 月 2 日までの毎分のデータを取得します。This request retrieves data for every minute between February 1 2018 and February 2 2018. applicationId の値は、ゲームの Store ID に置き換えてください。Replace the applicationId value with the Store ID for your game.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/gameanalytics?applicationId=9NBLGGGZ5QDR&metrictype=concurrency&aggregationLevel=hour&startDate=2018-02-01&endData=2018-02-02 HTTP/1.1
Authorization: Bearer <your access token>

応答Response

応答本文にはオブジェクトの配列が含まれ、各要素のオブジェクトは、指定された分、時間、または日に対応する同時使用状況データのセットを 1 つ保持します。The response body contains an array of objects that each contain one set of concurrent usage data for a specified minute, hour, or day. 各オブジェクトには次の値が含まれます。Each object contains the following values.

ValueValue 種類Type 説明Description
CountCount numbernumber 指定された分、時間、または日に Xbox Live 対応ゲームをプレイしたユーザーの平均数です。The average number of customers playing your Xbox Live-enabled for the specified minute, hour, or day.

  値 0 は、指定期間に同時ユーザーがいなかったか、指定期間に対するゲームの同時ユーザー データの収集中にエラーが発生したことを示します。Note  A value of 0 indicates either that there were no concurrent users during the specified interval, or that there was a failure while collecting concurrent user data for the game during the specified interval.

日付Date stringstring 同時使用状況データが発生した分、時間、または日を指定する日付と時刻です。The date and time that specifies the minute, hour or day during which the concurrent usage data occurred.
SeriesNameSeriesName stringstring この値は常に UserConcurrency になります。This always has the value UserConcurrency.

応答の例Response example

分単位のデータ集計要求に対する JSON 応答本文の例を次に示します。The following example demonstrates an example JSON response body for this request with data aggregation by minute.

[   {
        "Count": 418.0,
        "Date": "2018-02-02T04:42:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 418.0,
        "Date": "2018-02-02T04:43:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 415.0,
        "Date": "2018-02-02T04:44:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 412.0,
        "Date": "2018-02-02T04:45:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 414.0,
        "Date": "2018-02-02T04:46:13.65Z",
        "SeriesName": "UserConcurrency"
    }
]