チャネルごとのアプリのコンバージョンの取得Get app conversions by channel

日付範囲やその他のオプション フィルターを指定して、アプリケーションに関するチャネルごとの集計コンバージョンを取得するには、Microsoft Store 分析 API の以下のメソッドを使います。Use this method in the Microsoft Store analytics API to get aggregate conversions by channel for an application during a given date range and other optional filters.

  • コンバージョンは、(Microsoft アカウントでサインインした) ユーザーが、アプリ (有料の場合も無料の場合も含む) のライセンスを新しく取得したことを意味します。A conversion means that a customer (signed in with a Microsoft account) has newly obtained a license to your app (whether you charged money or you've offered it for free).
  • チャネルはユーザーがアプリの内容ページにアクセスするために使用した方法 (たとえば、ストアを通じて、またはカスタム アプリ プロモーション キャンペーン) です。The channel is the method in which a customer arrived at your app's listing page (for example, via the Store or a custom app promotion campaign).

この情報も記載されて、買収レポートパートナー センターでします。This information is also available in the 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/appchannelconversions

要求ヘッダー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 コンバージョン データを取得するアプリのストア ID です。The Store ID of the app for which you want to retrieve conversion data. ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。An example Store ID is 9WZDNCRFJ3Q8. Yes
startDatestartDate datedate 取得するコンバージョン データの日付範囲の開始日です。The start date in the date range of conversion data to retrieve. 既定値は 1/1/2016 です。The default is 1/1/2016. XNo
endDateendDate datedate 取得するコンバージョン データの日付範囲の終了日です。The end date in the date range of conversion 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 response body. 各ステートメントでは eqne 演算子を使用できます。また、ステートメントを andor で結合することもできます。Each statement can use the eq or ne operators, and statements can be combined using and or or. フィルター ステートメントで、次の文字列を指定できます。You can specify the following strings in the filter statements. 詳細については、この記事の「コンバージョン値」をご覧ください。For descriptions, see the conversion values section in this article.
  • ApplicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • チャネルchannelType
  • ストア クライアントstoreClient
  • deviceTypedeviceType
  • marketmarket

filter パラメーターの例: filter=deviceType eq 'PC'Here is an example filter parameter: filter=deviceType eq 'PC'.

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 conversion. 構文は 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
  • ApplicationNameapplicationName
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • チャネルchannelType
  • ストア クライアントstoreClient
  • deviceTypedeviceType
  • marketmarket

order パラメーターは省略可能であり、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
  • appTypeappType
  • customCampaignIdcustomCampaignId
  • referrerUriDomainreferrerUriDomain
  • チャネルchannelType
  • ストア クライアントstoreClient
  • deviceTypedeviceType
  • marketmarket

返されるデータ行には、groupby パラメーターに指定したフィールドと次の値が含まれます。The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • conversionCountconversionCount
  • clickCountclickCount

groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。The groupby parameter can be used with the aggregationLevel parameter. 例: groupby=ageGroup,market&aggregationLevel=weekFor example: groupby=ageGroup,market&aggregationLevel=week

XNo

要求の例Request example

アプリのコンバージョン データを取得するための要求の例を、いくつか次に示します。The following example demonstrates several requests for getting app conversion data. applicationId 値を、目的のアプリのストア ID に置き換えてください。Replace the applicationId value with the Store ID for your app.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US'  HTTP/1.1
Authorization: Bearer <your access token>

応答Response

応答本文Response body

ValueValue 種類Type 説明Description
ValueValue arrayarray アプリに関する集計コンバージョン データが含まれるオブジェクトの配列です。An array of objects that contain aggregate conversion data for the app. 各オブジェクトのデータについて詳しくは、次の「コンバージョン値」セクションをご覧ください。For more information about the data in each object, see the conversion 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 パラメーターが 10 に設定されたが、クエリのコンバージョン データに 10 を超える行が含まれている場合に、この値が返されます。For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of conversion data for the query.
TotalCountTotalCount intint クエリの結果データ内の行の総数です。The total number of rows in the data result for the query.

コンバージョン値Conversion values

Value 配列のオブジェクトには、次の値が含まれます。Objects in the Value array contain the following values.

Value 種類Type 説明Description
datedate stringstring コンバージョン データの日付範囲の最初の日付です。The first date in the date range for the conversion 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.
applicationIdapplicationId stringstring コンバージョン データを取得するアプリのストア ID です。The Store ID of the app for which you are retrieving conversion data.
applicationNameapplicationName stringstring コンバージョン データを取得するアプリの表示名です。The display name of the app for which you are retrieving conversion data.
appTypeappType stringstring コンバージョン データを取得する製品の種類です。The type of the product for which you are retrieving conversion data. このメソッドでは、サポートされている唯一の値は App です。For this method, the only supported value is App.
customCampaignIdcustomCampaignId stringstring アプリに関連付けられているカスタム アプリ プロモーション キャンペーンの ID 文字列です。The ID string for a custom app promotion campaign that is associated with the app.
referrerUriDomainreferrerUriDomain stringstring カスタム アプリ プロモーション キャンペーン ID を含むアプリの登録情報がアクティブ化されたドメインを指定します。Specifies the domain where the app listing with the custom app promotion campaign ID was activated.
channelTypechannelType stringstring コンバージョンのチャネルを指定する次のいずれかの文字列です。One of the following strings that specifies the channel for the conversion:
  • customCampaignIdCustomCampaignId
  • 店舗のトラフィックStore Traffic
  • その他Other
storeClientstoreClient stringstring コンバージョンが発生したストアのバージョンです。The version of the Store where the conversion occurred. 現時点では、サポートされている唯一の値は SFC です。Currently, the only supported value is SFC.
deviceTypedeviceType stringstring 次のいずれかの文字列です。One of the following strings:
  • PCPC
  • PhonePhone
  • ConsoleConsole
  • IoTIoT
  • HolographicHolographic
  • UnknownUnknown
marketmarket stringstring コンバージョンが発生した市場の ISO 3166 国コードです。The ISO 3166 country code of the market where the conversion occurred.
clickCountclickCount numbernumber アプリの内容へのリンクをクリックした顧客の数です。The number of customer clicks on your app listing link.
conversionCountconversionCount numbernumber 顧客のコンバージョンの数です。The number of customer conversions.

応答の例Response example

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

{
  "Value": [
    {
      "date": "2016-01-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "App",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "US",
      "clickCount": 7,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}