Insights のデータを取得します。Get insights data

Insights データを取得するには、Microsoft Store analytics API では、このメソッドは、特定の日付範囲とその他のオプションのフィルターの中に、買収、ヘルス、およびアプリの使用状況メトリックに関連するを使用します。Use this method in the Microsoft Store analytics API to get insights data related to acquisitions, health, and usage metrics for an app during a given date range and other optional filters. この情報も記載されて、 Insights レポートパートナー センターでします。This information is also available in the Insights 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/insights

要求ヘッダー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 Store ID insights データを取得するアプリの。The Store ID of the app for which you want to retrieve insights data. このパラメーターを指定しないと、応答本文は、自分のアカウントに登録されているすべてのアプリの insights のデータが含まれます。If you do not specify this parameter, the response body will contain insights data for all apps registered to your account. XNo
startDatestartDate datedate 取得する insights データの日付範囲の開始日。The start date in the date range of insights data to retrieve. 既定値は、現在の日付の 30 日前です。The default is 30 days before the current date. XNo
endDateendDate datedate 取得する insights データの日付範囲の終了日。The end date in the date range of insights data to retrieve. 既定値は現在の日付です。The default is the current date. XNo
filterfilter stringstring 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。One or more statements that filter the rows in the response. 各ステートメントには、応答本文からのフィールド名、および eq 演算子または ne 演算子と関連付けられる値が含まれており、andor を使用してステートメントを組み合わせることができます。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. filter パラメーターでは、文字列値を単一引用符で囲む必要があります。String values must be surrounded by single quotes in the filter parameter. たとえば、フィルター = データ型 eq '買収' します。For example, filter=dataType eq 'acquisition'.

次のフィルター フィールドを指定できます。You can specify the following filter fields:

  • 取得acquisition
  • 正常性health
  • 使用状況usage
XNo

要求の例Request example

次の例では、insights データを取得するための要求を示します。The following example demonstrates a request for getting insights data. applicationId 値を、目的のアプリのストア ID に置き換えてください。Replace the applicationId value with the Store ID for your app.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights?applicationId=9NBLGGGZ5QDR&startDate=6/1/2018&endDate=6/15/2018&filter=dataType eq 'acquisition' or dataType eq 'health' HTTP/1.1
Authorization: Bearer <your access token>

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
ValueValue arrayarray アプリの insights のデータを格納するオブジェクトの配列。An array of objects that contain insights data for the app. 各オブジェクトのデータの詳細については、次を参照してください。、 Insight 値以下のセクション。For more information about the data in each object, see the Insight values section below.
TotalCountTotalCount intint クエリの結果データ内の行の総数です。The total number of rows in the data result for the query.

Insight 値Insight values

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

ValueValue 種類Type 説明Description
applicationIdapplicationId stringstring Insights のデータを取得するアプリの Store ID。The Store ID of the app for which you are retrieving insights data.
insightDateinsightDate stringstring 日付が特定のメトリックの変化を特定しました。The date on which we identified the change in a specific metric. この日付は、大幅な増加を検出しました週の終わりを表すと比較する前に、その週とメトリックに増減します。This date represents the end of the week in which we detected a significant increase or decrease in a metric compared to the week before that.
データ型dataType stringstring この情報を表す一般的な分析の領域を指定する次の文字列のいずれか:One of the following strings that specifies the general analytics area that this insight describes:

  • 取得acquisition
  • 正常性health
  • 使用状況usage
insightDetailinsightDetail arrayarray 1 つまたは複数InsightDetail 値現在インサイトの詳細を表します。One or more InsightDetail values that represent the details for current insight.

InsightDetail 値InsightDetail values

Value 種類Type 説明Description
FactNameFactName stringstring 現在 insight または現在のディメンションについて説明します、メトリックを示す値は次のいずれかに基づいて、 dataType値。One of the following values that indicates the metric that the current insight or current dimension describes, based on the dataType value.
  • ヘルス、この値は常にヒット カウントします。For health, this value is always HitCount.
  • 買収、この値は常に取得数します。For acquisition, this value is always AcquisitionQuantity.
  • 使用状況、この値は、次の文字列のいずれかを指定できます。For usage, this value can be one of the following strings:
    • DailyActiveUsersDailyActiveUsers
    • EngagementDurationMinutesEngagementDurationMinutes
    • DailyActiveDevicesDailyActiveDevices
    • DailyNewUsersDailyNewUsers
    • DailySessionCountDailySessionCount
SubDimensionsSubDimensions arrayarray 情報を得ることの 1 つのメトリックを記述する 1 つまたは複数のオブジェクト。One or more objects that describe a single metric for the insight.
PercentChangePercentChange stringstring この割合は、全体の顧客ベースでメトリックを変更しました。The percentage that the metric changed across your entire customer base.
DimensionNameDimensionName stringstring 現在のディメンションで説明されているメトリックの名前。The name of the metric described in the current dimension. 例としては、 EventType市場DeviceTypePackageVersionAcquisitionTypeAgeGroup性別します。Examples include EventType, Market, DeviceType, PackageVersion, AcquisitionType, AgeGroup and Gender.
DimensionValueDimensionValue stringstring 現在のディメンションで説明されているメトリックの値。The value of the metric that is described in the current dimension. たとえば場合、 DimensionNameEventTypeDimensionValue可能性がありますクラッシュまたはハング.For example, if DimensionName is EventType, DimensionValue might be crash or hang.
FactValueFactValue stringstring 情報を得ることが検出された日付のメトリックの絶対値。The absolute value of the metric on the date the insight was detected.
DirectionDirection stringstring 変更の方向 (または)。The direction of the change (Positive or Negative).
日付Date stringstring 日付、現在の情報または現在のディメンションに関連する変更を特定しました。The date on which we identified the change related to the current insight or the current dimension.

応答の例Response example

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

{
  "Value": [
    {
      "applicationId": "9NBLGGGZ5QDR",
      "insightDate": "2018-06-03T00:00:00",
      "dataType": "health",
      "insightDetail": [
        {
          "FactName": "HitCount",
          "SubDimensions": [
            {
              "FactName:": "HitCount",
              "PercentChange": "21",
              "DimensionValue:": "DE",
              "FactValue": "109",
              "Direction": "Positive",
              "Date": "6/3/2018 12:00:00 AM",
              "DimensionName": "Market"
            }
          ],
          "DimensionValue": "crash",
          "Date": "6/3/2018 12:00:00 AM",
          "DimensionName": "EventType"
        },
        {
          "FactName": "HitCount",
          "SubDimensions": [
            {
              "FactName:": "HitCount",
              "PercentChange": "71",
              "DimensionValue:": "JP",
              "FactValue": "112",
              "Direction": "Positive",
              "Date": "6/3/2018 12:00:00 AM",
              "DimensionName": "Market"
            }
          ],
          "DimensionValue": "hang",
          "Date": "6/3/2018 12:00:00 AM",
          "DimensionName": "EventType"
        },
      ],
      "insightId": "9CY0F3VBT1AS942AFQaeyO0k2zUKfyOhrOHc0036Iwc="
    }
  ],
  "@nextLink": null,
  "TotalCount": 2
}