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

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

Microsoft Store Services SDK でサポートされるシナリオ

Microsoft Store Services SDK は現在、UWP アプリの次のシナリオをサポートしています。 API リファレンス ドキュメントについては、「 Microsoft Store Services SDK API リファレンスを参照してください。

前提条件

Microsoft Store Services SDK には、次のものが必要です。

• Visual Studio 2015 以降のバージョン。
• Visual Studio のバージョンと共にインストールされた Visual Studio Tools for Universal Windows Apps。

SDK のインストール

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

• MSI インストーラー ここから利用できる MSI インストーラーを使って SDK をインストールできます。
• NuGet パッケージ NuGet パッケージとして SDK をインストールできます。

Microsoft は、パフォーマンスの向上と新機能を備えた新しいバージョンの 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 でプロジェクトを開き、プロジェクトをクリーンアップしてリビルドすることをお勧めします (ソリューション エクスプローラーで、プロジェクト ノードを右クリックして Clean を選択しますをクリックし、プロジェクト ノードをもう一度右クリックし、Rebuild) を選択します。

それ以外の場合、プロジェクトで初めて 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 を使用するプロジェクトを開きます。

   Note

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

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

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

   Note

   Output ウィンドウで、指定したパスが長すぎることを示す Install-Package エラーが報告される場合は、既定の場所よりもパスが短い別の場所にパッケージを抽出するように NuGet を構成する必要があります。 これを行うには、 repositoryPath 値をコンピューター上の nuget.config ファイルに追加し、NuGet パッケージを抽出できる短いフォルダー パスに割り当てます。 詳細については、NuGet ドキュメント この記事 を参照してください。 または、パスが短い別のフォルダーに Visual Studio プロジェクトを移動することもできます。 この問題は、グローバル パッケージのパスが長すぎることが原因で発生する場合もあります。 その場合は、nuget.config ファイルに globalPackagesFolder の値を追加します。

6. プロジェクトを含む Visual Studio ソリューションを閉じてから、ソリューションを再度開きます。

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

それ以外の場合、プロジェクトで初めて SDK を使用する場合は、 アセンブリ参照をプロジェクトに追加する準備ができました。

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

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

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

   Note

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

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

3. Reference Managerで、Universal Windowsを展開し、Extensionsをクリックし、Microsoft Engagement Framework の横にあるチェック ボックスオンにします。 これにより、 Microsoft.Services.Store.Engagement 名前空間の API を使用できます。

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

SDK のフレームワーク パッケージについて

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

このライブラリはフレームワーク パッケージであるため、これは、ユーザーがこのライブラリを使用するアプリのバージョンをインストールした後、修正プログラムとパフォーマンスの向上を備えた新しいバージョンのライブラリを公開するたびに、このライブラリが Windows Update を介してデバイスに自動的に更新されることを意味します。 これにより、お客様は常に最新バージョンのライブラリがデバイスにインストールされます。

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

関連トピック

• Microsoft Store Services SDK API リファレンス
• A/B テストを使用して実験を実行する
• アプリからのフィードバック Hub の起動
• パートナー センターのプッシュ通知を受信するようにアプリを設定する
• パートナー センターのカスタム イベントをログに記録する