チャネルごとのアドオンのコンバージョンの取得
指定した期間やその他のオプション フィルターに該当するアドオンのチャネルごとのコンバージョン集計を取得するには、Microsoft Store 分析 API でこのメソッドを使用します。
- コンバージョンとは、(Microsoft アカウントでサインインした) 顧客がアドオンのライセンスを (有料、無料を問わず) 新しく取得したことを意味します。
- チャネルとは、顧客がアプリの一覧ページに到達した方法です (Microsoft Store やカスタム アプリ プロモーション キャンペーンなど)。
この情報は、パートナー センターのアドオン取得レポートでも確認できます。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 分析 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
要求
要求の構文
認証方法 | 要求 URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions |
要求ヘッダー
Header | 型 | 説明 |
---|---|---|
承認 | string | 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | 型 | 内容 | 必須 |
---|---|---|---|
applicationId | string | アドオン コンバージョン データを取得するアプリの Store ID。 ストア ID は、たとえば 9WZDNCRFJ3Q8 のような文字列です。 | はい |
inAppProductId | string | コンバージョン データを取得するアドオンの Store ID。 | はい |
startDate | 日付 | 取得するコンバージョン データの期間の開始日。 既定値は "1/1/2016" です。 | いいえ |
endDate | 日付 | 取得するコンバージョン データの期間の終了日。 既定値は現在の日付です。 | いいえ |
top | int | 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 | いいえ |
skip | int | クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 を指定すると、データの最初の 10,000 行が取得され、top=10000 と skip=10000 を指定すると、データの次の 10,000 行が取得されます。 | No |
filter | string | 応答本文をフィルター処理する 1 つまたは複数のステートメントです。 各ステートメントでは eq や ne 演算子を使用できます。また、ステートメントを and や or で結合することもできます。 フィルター ステートメントでは、次の文字列を指定できます。 説明については、この記事の「コンバージョン値」セクションを参照してください。
filter パラメーターの例: filter=deviceType eq 'PC'。 |
いいえ |
aggregationLevel | string | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 指定しない場合、既定値は day です。 | No |
orderby | string | 各コンバージョンの結果データ値の順序を指定するステートメント。 構文は orderby=field [order],field [order],... です。field パラメーターは次のいずれかの文字列になります。
order パラメーターは省略可能であり、asc または desc を指定して、各フィールドを昇順または降順にすることができます。 既定値は asc です。 orderby 文字列の例: orderby=date,market |
No |
groupby | string | 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。
返されるデータ行には、groupby パラメーターで指定されたフィールドと、次のものが含まれます。
groupby パラメーターは、aggregationLevel パラメーターと同時に使用できます。 例: groupby=ageGroup,market&aggregationLevel=week |
いいえ |
要求の例
アプリのコンバージョン データを取得するためのいくつかの要求の例を次に示します。 applicationId 値を、目的のアプリのストア ID に置き換えてください。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?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/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US' HTTP/1.1
Authorization: Bearer <your access token>
[応答]
応答本文
値 | 種類 | 説明 |
---|---|---|
値 | 配列 | アドオンのコンバージョン集計データが格納されているオブジェクトの配列。 各オブジェクトのデータの詳細については、以下の「コンバージョン値」セクションを参照してください。 |
@nextLink | string | データの追加ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターを 10 に設定した場合、クエリに適合するコンバージョン データが 10 行を超えると、この値が返されます。 |
TotalCount | int | クエリの結果データ内の行の総数です。 |
コンバージョン値
Value 配列のオブジェクトには、次の値が含まれます。
値 | 種類 | 説明 |
---|---|---|
date | string | コンバージョン データの期間の最初の日付。 要求に日付を指定した場合、この値はその日付になります。 要求に週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
inAppProductId | string | コンバージョン データを取得するアドオンの Store ID。 |
inAppProductName | string | コンバージョン データを取得するアドオンの表示名。 |
applicationId | string | コンバージョン データを取得するアプリのストア ID です。 |
applicationName | string | コンバージョン データを取得するアプリの表示名。 |
appType | string | コンバージョン データを取得する製品の種類。 このメソッドでサポートされている値は Add-On のみです。 |
customCampaignId | string | アプリに関連付けられているカスタム アプリ プロモーション キャンペーン の ID 文字列。 |
referrerUriDomain | string | カスタム アプリ プロモーション キャンペーン ID を持つアプリ一覧がアクティブ化されたドメインを指定します。 |
channelType | string | コンバージョンのチャネルを指定する次のいずれかの文字列。
|
storeClient | string | コンバージョンが行われた Microsoft Store のバージョン。 現在、サポートされている値は SFC のみです。 |
deviceType | string | 次の文字列のいずれかです。
|
market | string | コンバージョンが発生した市場の ISO 3166 国コード。 |
clickCount | 数値 | アプリ一覧のリンクを顧客がクリックした回数。 |
conversionCount | 数値 | 顧客のコンバージョンの数。 |
要求と応答の例
次のコード スニペットは、これらの要求についての要求と JSON 応答本文の例を示しています。
サンプル要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>
サンプル応答
{
"Value": [
{
"inAppProductId": "9NN2HW33ZB2G",
"applicationId": "9NBLGGGZ5QDR",
"clickCount": 220636,
"conversionCount": 154
},
{
"inAppProductId": "9PN07J0WC18B",
"applicationId": "9NBLGGGZ5QDR",
"clickCount": 277061,
"conversionCount": 187
}
],
"@nextLink": "",
"TotalCount": 2
}
サンプル要求
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>
サンプル応答
{
"Value": [
{
"inAppProductId": "9WZDNCRCWW61",
"inAppProductName": "SeasonPass0",
"appType": "Add-On",
"date": "2022-06-21",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "mcg_mahjong_othergames",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "BR",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-06",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "mcg_solitaire_othergames",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "AT",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5Z",
"inAppProductName": "Episode1Combo",
"appType": "Add-On",
"date": "2022-07-09",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-09",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW4Z",
"inAppProductName": "Episode1Grandfathered",
"appType": "Add-On",
"date": "2022-07-11",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "|autosuggest",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "ES",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5W",
"inAppProductName": "Episode2Combo",
"appType": "Add-On",
"date": "2022-07-11",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW4P",
"inAppProductName": "SeasonPass24",
"appType": "Add-On",
"date": "2022-07-12",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "vungle",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CZ",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW5H",
"inAppProductName": "OEMFreePurchase",
"appType": "Add-On",
"date": "2022-07-13",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "9wzdncrfjbd8",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "CA",
"clickCount": 1,
"conversionCount": 1
},
{
"inAppProductId": "9WZDNCRCWW61",
"inAppProductName": "SeasonPass0",
"appType": "Add-On",
"date": "2022-07-17",
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"customCampaignId": "scom-web-store",
"channelType": "CustomCampaignId",
"storeClient": "SFW",
"deviceType": "Unknown",
"market": "US",
"clickCount": 1,
"conversionCount": 1
}
],
"@nextLink": "",
"TotalCount": 9
}