Microsoft Store Services SDK を使ってユーザーとの関係を深める

Microsoft Store Services SDK が提供する機能を利用すると、ユニバーサル Windows プラットフォーム (UWP) アプリでユーザーとのエンゲージメントを行うことができます。たとえば、ターゲット指定されたデベロッパー センター通知をアプリに送信したり、A/B テストを行ったりできます。 この SDK は、Visual Studio 2015 とそれ以降のバージョンの Visual Studio 用の拡張です。

注意

UWP アプリで広告を表示するには、Microsoft Store Services SDK ではなく Microsoft Advertising SDK を使います。 詳しくは、「アプリでの広告の表示」をご覧ください。

Microsoft Store Services SDK によりサポートされるシナリオ

この Microsoft Store Services SDK では現在、UWP アプリ向けに次のシナリオがサポートされています。 API リファレンス ドキュメントについては、「Microsoft Store Services SDK API リファレンス」をご覧ください。

シナリオ 説明
UWP アプリの A/B テストの実行 ユニバーサル Windows プラットフォーム (UWP) アプリで A/B テストを実施して、すべてのユーザー向けに機能を公開する前に、一部のユーザーに対して機能の有効性を測定することができます。 デベロッパー センター ダッシュボードで実験を定義したら、アプリで StoreServicesExperimentVariation クラスを使用して実験のバリエーションを取得します。次に、そのデータを使用して、テストする機能の動作を変更し、LogForVariation メソッドを使って、デベロッパー センターにビュー イベントとコンバージョン イベントを送信します。 最後に、ダッシュボードで結果を表示し、実験を管理します。
UWP アプリからのフィードバック Hub の起動 UWP アプリで StoreServicesFeedbackLauncher クラスを使用し、Windows 10 ユーザーをフィードバック Hub に誘導して、ユーザーが問題、提案、賛成票を送信できるようにします。 次に、デベロッパー センター ダッシュボードのフィードバック レポートでこのフィードバックを管理します。
デベロッパー センターのプッシュ通知を受信するように UWP アプリを設定する Windows デベロッパー センター ダッシュボードを使用してユーザーに送信するターゲット プッシュ通知を受信するアプリを、UWP アプリの StoreServicesEngagementManager クラスを使用して登録します。
UWP アプリで、デベロッパー センターの利用状況レポート用のカスタム イベントをログに記録する UWP アプリで StoreServicesCustomEventLogger クラスを使用して、デベロッパー センターでアプリに関連するカスタム イベントをログに記録します。 次にデベロッパー センター ダッシュボードの利用状況レポートカスタム イベントのセクションで、カスタム イベントの合計回数を確認します。
注意

アプリで広告を表示するには、Microsoft Store Services SDK ではなく Microsoft Advertising SDK を使います。 詳しくは、「アプリでの広告の表示」をご覧ください。

前提条件

Microsoft Store Services SDK には以下が必要となります。

  • Visual Studio 2015 またはそれ以降のバージョン。
  • Visual Studio と共にインストールされている ユニバーサル Windows アプリ用 Visual Studio Tools

SDK のインストール

開発用コンピューターに Microsoft Store Services SDK をインストールするには、次の 2 つのオプションがあります。

  • MSI インストーラー  ここから利用できる MSI インストーラーを使って SDK をインストールできます。 このオプションを使用すると、開発用コンピュータの共有場所に SDK ライブラリがインストールされ、Visual Studio の任意の UWP プロジェクトで参照できるようになります。
  • NuGet パッケージ  NuGet を使って Visual Studio の特定の UWP プロジェクト用に SDK ライブラリをインストールできます。 このオプションでは、SDK ライブラリは NuGet パッケージがインストールされているプロジェクト用にのみインストールされます。

マイクロソフトでは定期的に、向上したパフォーマンスと新しい機能を備えた、新しいバージョンの Microsoft Store Services SDK をリリースしています。 開発用コンピューターに SDK を使っている既存のプロジェクトがあり、そのプロジェクトで最新バージョンを使う場合は、最新バージョンの SDK をダウンロードしてインストールしてください。

MSI によるインストール

MSI インストーラーを使って Microsoft Store Services SDK をインストールするには

  1. Visual Studio のすべてのインスタンスを閉じます。

  2. Microsoft Store Engagement and Monetization SDK、Universal Ad Client SDK、または Ad Mediator 拡張機能を以前にインストールしていた場合は、それらの SDK をアンインストールします。 必要に応じて、コマンド プロンプト ウィンドウを開き、次のコマンドを実行して、Visual Studio と共にインストールされている可能性があり、コンピューター上のインストールされているプログラムの一覧には表示されない可能性がある、古い SDK のバージョンをすべて削除します。

    MsiExec.exe /x{5C87A4DB-31C7-465E-9356-71B485B69EC8}
    MsiExec.exe /x{6AB13C21-C3EC-46E1-8009-6FD5EBEE515B}
    MsiExec.exe /x{6AC81125-8485-463D-9352-3F35A2508C11}
    
  3. Microsoft Store Services SDK をダウンロードしてインストールします。 インストールには数分かかることがあります。 確実に処理が完了するまでお待ちください。

  4. Visual Studio を再起動します。

  5. 以前のバージョンの Microsoft Store Services SDK、Microsoft Advertising SDK、Universal Ad Client SDK、Microsoft Store Engagement and Monetization SDK のライブラリを参照する既存のプロジェクトがある場合には、Visual Studio でプロジェクトを開き、プロジェクトをクリーンしてリビルドすることをお勧めします (ソリューション エクスプ ローラーでプロジェクト ノードを右クリックして、[クリーン] を選択し、次にもう一度プロジェクト ノードを右クリックして、[リビルド] を選択します)。

    または、プロジェクトで初めて SDK を使う場合には、適切な Microsoft Store Services SDK ライブラリの参照をプロジェクトに追加します。

NuGet によるインストール

NuGet を使って Microsoft Store Services SDK ライブラリを特定のプロジェクトにインストールするには

  1. Visual Studio のすべてのインスタンスを閉じます。

  2. Microsoft Store Engagement and Monetization SDK、Universal Ad Client SDK、または Ad Mediator 拡張機能を以前にインストールしていた場合は、それらの SDK をアンインストールします。 必要に応じて、コマンド プロンプト ウィンドウを開き、次のコマンドを実行して、Visual Studio と共にインストールされている可能性があり、コンピューター上のインストールされているプログラムの一覧には表示されない可能性がある、古い SDK のバージョンをすべて削除します。

    MsiExec.exe /x{5C87A4DB-31C7-465E-9356-71B485B69EC8}
    MsiExec.exe /x{6AB13C21-C3EC-46E1-8009-6FD5EBEE515B}
    MsiExec.exe /x{6AC81125-8485-463D-9352-3F35A2508C11}
    
  3. Visual Studio を起動し、Microsoft Store Services SDK ライブラリを使用するプロジェクトを開きます。

    注意

    プロジェクトに SDK の以前の MSI インストールからのライブラリの参照が既に含まれている場合は、これらの参照をプロジェクトから削除します。 これらの参照は、参照先のライブラリが前の手順で削除されたため、その隣に警告アイコンが表示されます。

  4. Visual Studio で、[プロジェクト][NuGet パッケージの管理] をクリックします。

  5. 検索ボックスに「Microsoft.Services.Store.SDK」と入力し、Microsoft.Services.Store.SDK パッケージをインストールします。 パッケージのインストールが完了したら、ソリューションを保存します。

    注意

    [出力] ウィンドウに、指定されたパスが長すぎることを示すインストール パッケージ エラーが表示されたとき、場合によっては、NuGet を構成して、既定の場所よりも短いパスで示される別の場所にパッケージを展開する必要があります。 これを行うには、repositoryPath 値をコンピューターの nuget.config ファイルに追加し、それを短いフォルダーのパスに割り当て、そこに NuGet パッケージが展開されるようにします。 詳しくは、NuGet ドキュメントのこの記事をご覧ください。 または、Visual Studio プロジェクトを短いパスを持つ別のフォルダーに移動してみることができます。

  6. プロジェクトが含まれている Visual Studio ソリューションを閉じ、そのソリューションを再度開きます。

  7. プロジェクトが NuGet によりインストールされた以前のバージョンの Microsoft Store Services SDK のライブラリを既に参照している場合で、プロジェクトを SDK の新しいリリースに更新する場合には、プロジェクトをクリーンしてリビルドすることをお勧めします (ソリューション エクスプローラーでプロジェクト ノードを右クリックして、[クリーン]を選択し、次にもう一度プロジェクト ノードを右クリックして、[リビルド] を選択します)。

    または、プロジェクトで初めて SDK を使う場合には、適切な Microsoft Store Services SDK ライブラリの参照をプロジェクトに追加します。

アセンブリ参照をプロジェクトを追加する

+MSI インストーラーまたは NuGet により Microsoft Store Services SDK をインストールしたら、次の手順に従って UWP プロジェクトで SDK アセンブリを参照します。

  1. Visual Studio でプロジェクトを開きます。

    注意

    プロジェクトが JavaScript アプリで、ターゲットが [任意の CPU] になっている場合は、アーキテクチャ固有のビルド出力 (たとえば [x86]) を使うようにプロジェクトを更新します。

  2. ソリューション エクスプローラーで、[参照設定] を右クリックし、[参照の追加] を選択します。

  3. [参照マネージャー][ユニバーサル Windows] を展開し、[拡張機能] をクリックして、[Microsoft Engagement Framework] の横のチェック ボックスをオンにします。 これにより、A/B テストを実行するフィードバック Hub を起動するデベロッパー センターからターゲット プッシュ通知を受信するデベロッパー センターでカスタム イベントをログに記録するなどのユーザー エンゲージメント シナリオの Microsoft.Services.Store.Engagement 名前空間で API を使うことができるようになります。

  4. [OK] をクリックします。

注意

NuGet から SDK ライブラリをインストールした場合、プロジェクトには Microsoft.Services.Store.SDK 参照が含められます。 Microsoft.Services.Store.SDK の参照は (その中のライブラリではなく) NuGet パッケージを表し、これは無視することができます。

SDK のフレームワーク パッケージを理解する

Microsoft Store Services SDK の Microsoft.Services.Store.Engagement.dll ライブラリは、フレームワーク パッケージとして構成されています。 このライブラリには、Microsoft.Services.Store.Engagement 名前空間の API が含まれています。

このライブラリはフレームワーク パッケージであるため、このライブラリを使用するバージョンのアプリをユーザーがインストールすると、このライブラリは、修正されてパフォーマンスが向上した新しいバージョンのライブラリが公開されるたびに、ユーザーのデバイスで Windows Update によって自動的に更新されます。 これにより、利用できる最新バージョンのライブラリがユーザーのデバイスに確実にインストールされます。

このライブラリに新しい API や機能が導入された新しいバージョンの SDK がリリースされた場合は、これらの機能を使用するために最新バージョンの SDK をインストールする必要があります。 このシナリオでは、更新されたアプリをストアに公開する必要もあります。