Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲およびその他のオプションフィルター中にアドオンのチャネル別の集計変換を取得します。
- コンバージョン とは、顧客 (Microsoft アカウントでサインイン) がアドオンのライセンスを新しく取得したことを意味します (お金を請求した場合でも無料で提供した場合でも)。
- チャネル は、顧客がアプリの登録情報ページに到着した方法です (たとえば、ストアや カスタム アプリプロモーション キャンペーンを使用)。
この情報は、パートナー センターの アドオン取得レポート でも使用できます。
[前提条件]
このメソッドを使用するには、まず次の操作を行う必要があります。
- まだ行っていない場合は、Microsoft Store 分析 API の
前提条件をすべて満たしてください。 - このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。
リクエスト
リクエスト構文
メソッド | URI リクエスト |
---|---|
取得する | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions |
リクエストヘッダー
ヘッダ | タイプ | 説明 |
---|---|---|
認証 | ひも | 必須。 Bearer<token> 形式の Azure AD アクセス トークン。 |
要求パラメーター
パラメーター | タイプ | 説明 | 必須 |
---|---|---|---|
アプリケーションID | ひも | アドオン変換データを取得するアプリの ストア ID。 ストア ID の例は 9WZDNCRFJ3Q8 です。 | イエス |
アプリ内製品ID | ひも | 変換データを取得したいアドオンのストアID 。 | イエス |
開始日 | 日付 | 取得する変換データの日付範囲の開始日。 既定値は 2016 年 1 月 1 日です。 | いいえ |
終了日 | 日付 | 取得する変換データの日付範囲の終了日。 既定値は現在の日付です。 | いいえ |
ページのトップへ | 整数 (int) | 要求で返されるデータの行数。 最大値と既定値 (指定しない場合) は 10000 です。 クエリにさらに行がある場合、応答本文には次のリンクが含まれています。このリンクを使用して、データの次のページを要求できます。 | いいえ |
スキップ | 整数 (int) | クエリでスキップする行数。 大きなデータ セットをページングするには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 はデータの最初の 10000 行を取得し、top=10000 と skip=10000 は次の 10000 行のデータを取得します。 | いいえ |
フィルター | ひも | 応答本文をフィルター処理する 1 つ以上のステートメント。 各ステートメントは、eq または ne 演算子を使用できます。ステートメントは、、、、またはを使用して結合できます。 フィルター ステートメントでは、次の文字列を指定できます。 説明については、この記事の「変換値」セクションを参照してください。
例 フィルター パラメーターをこちらに示します:filter=deviceType eq 'PC'。 |
いいえ |
集約レベル | ひも | 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます: |
いいえ |
オーダーバイ (orderby) | ひも | 各変換の結果データ値を並べ替えるステートメント。 構文は orderby=field [order],field [order],...です。 フィールド パラメーターには、次のいずれかの文字列を指定できます。
order パラメーターは省略可能で、asc または desc を使用して各フィールドの昇順または降順を指定できます。 既定値は asc 例として次のような orderby 文字列があります: orderby=date、market |
いいえ |
グループバイ | ひも | 指定したフィールドにのみデータ集計を適用するステートメント。 次のフィールドを指定できます:
返されるデータ行には、 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 | ひも | 追加のデータ ページがある場合、この文字列には、データの次のページを要求するために使用できる URI が含まれます。 たとえば、要求の top パラメーターが 10 に設定されていても、クエリの変換データが 10 行を超える場合、この値が返されます。 |
トータルカウント | 整数 (int) | クエリのデータ結果内の行の合計数。 |
変換値
Value 配列内のオブジェクトには、次の値が含まれます。
価値 | タイプ | 説明 |
---|---|---|
日付 | ひも | 変換データの日付範囲の最初の日付。 要求で 1 日を指定した場合、この値はその日付になります。 要求で週、月、またはその他の日付範囲を指定した場合、この値はその日付範囲の最初の日付になります。 |
アプリ内製品ID | ひも | 変換データを取得するアドオンの ストア ID。 |
アプリ内商品名 | ひも | 変換データを取得するアドオンの表示名。 |
アプリケーションID | ひも | 変換データを取得するアプリの ストア ID。 |
アプリケーション名 | ひも | 変換データを取得するアプリの表示名。 |
アプリタイプ | ひも | 変換データを取得する製品の種類。 このメソッドでサポートされている値は、アドオン |
customCampaignId (カスタムキャンペーンID) | ひも | アプリに関連付けられている カスタム アプリ プロモーション キャンペーン の ID 文字列。 |
参照元URIドメイン | ひも | カスタム アプリ プロモーション キャンペーン ID を持つアプリの一覧がアクティブ化されたドメインを指定します。 |
チャンネルタイプ | ひも | 変換のチャネルを指定する次のいずれかの文字列。
|
ストアクライアント | ひも | 変換が行われたストアのバージョン。 現在、サポートされている値は SFC |
デバイスタイプ | ひも | 次のいずれかの文字列:
|
市場 | ひも | 変換が発生した市場の ISO 3166 国コード。 |
クリック数 | 数 | アプリ登録情報のリンクに対する顧客クリックの数。 |
コンバージョン数 | 数 | 顧客のコンバージョンの数。 |
要求と応答の例
次のコード スニペットは、これらの要求の要求と 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
}
関連トピック
- アドオン取得状況レポート
- Microsoft Store サービス を使用して分析データにアクセスする
- アドオンを取得する