アドオンを入手する

Microsoft Store 分析 API の次のメソッドを使用して、特定の日付範囲やその他のオプション フィルターの間に、アプリのアドオンの集計取得データを JSON 形式で取得します。 この情報は、パートナー センターの アドオン取得レポート でも使用できます。

[前提条件]

このメソッドを使用するには、まず次の操作を行う必要があります。

• まだ行っていない場合は、Microsoft Store 分析 API の 前提条件をすべて満たしてください。
• このメソッドの要求ヘッダーで使用する Azure AD アクセス トークン を取得します。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを取得できます。

リクエスト

リクエスト構文

リクエストヘッダー

要求パラメーター

applicationId または inAppProductId パラメーターが必要です。 アプリに登録されているすべてのアドオンの取得データを取得するには、applicationId パラメーターを指定します。 1 つのアドオンの取得データを取得するには、inAppProductId パラメーターを指定します。 両方を指定した場合、applicationId パラメーターは無視されます。

フィールドをフィルターする

要求の フィルター パラメーターには、応答内の行をフィルター処理する 1 つ以上のステートメントが含まれています。 各ステートメントには、eq または ne 演算子に関連付けられているフィールドと値が含まれており、ステートメントは、、、、またはを使用して結合できます。 フィルター パラメーターの例を次に示します。

• filter=market eq 'US' と gender eq 'm'
• filter=(market ne 'US') and (gender ne 'Unknown') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne 'greater than 55' or ageGroup ne 'less than 13')

サポートされているフィールドの一覧については、次の表を参照してください。 文字列値は、 フィルター パラメーター内で一重引用符で囲む必要があります。

要求の例

次の例では、アドオン取得データを取得するためのいくつかの要求を示します。 inAppProductId と applicationId の値を、アドオンまたはアプリの適切なストア ID に置き換えます。

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

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>

[応答]

応答内容

追加機能の取得価値

Value 配列内の要素には、次の値が含まれています。

要求と応答の例

次のコード スニペットは、これらの要求の要求と JSON 応答本文の例を示しています。

サンプル依頼

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

応答の例

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NBLGGAAGZDQ",
            "date": "2022-07-29",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 18.12,
            "purchasePriceLocalAmount": 18.12,
            "purchaseTaxUSDAmount": 1.13,
            "purchaseTaxLocalAmount": 1.13
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Episode 4",
            "addonProductId": "9NAAAAAAAAAQ",
            "date": "2017-01-07",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 4.147206,
            "purchasePriceLocalAmount": 3.99,
            "purchaseTaxUSDAmount": 0.686004,
            "purchaseTaxLocalAmount": 0.66
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Deluxe Collector's Edition",
            "addonProductId": "9NALGGGZ5QDQ",
            "date": "2018-04-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.99,
            "purchasePriceLocalAmount": 1.99,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "inAppProductName": "Strategy Guide Episode 4",
            "addonProductId": "9NBLGGGZ5QDQ",
            "date": "2021-11-25",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 1.31902922876179,
            "purchasePriceLocalAmount": 150.0,
            "purchaseTaxUSDAmount": 0.114315866492689,
            "purchaseTaxLocalAmount": 13.0
        },
    ],
    "TotalCount": 4,
    "DataFreshnessTimestamp": "2022-07-29T05:54:00"
}

関連トピック

• アドオン取得状況レポート
• Microsoft Store サービス を使用して分析データにアクセスする
• チャネル別にアドオンのコンバージョンを確認する
• アプリの買収
• アプリ取得ファネルデータの取得
• チャネル別でアプリのコンバージョンを把握する