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

Microsoft Store Services SDK が提供する機能を利用すると、ユニバーサル Windows プラットフォーム (UWP) アプリでユーザーとのエンゲージメントを行うことができます。たとえば、ターゲット指定されたデベロッパー センター通知をアプリに送信したり、A/B テストを行ったりできます。The Microsoft Store Services SDK provides features that help you engage with customers in your Universal Windows Platform (UWP) apps, such as sending targeted Dev Center notifications to your apps and running A/B experiments in your apps. この SDK は、Visual Studio 2015 とそれ以降のバージョンの Visual Studio 用の拡張です。This SDK is an extension for Visual Studio 2015 and later versions of Visual Studio.

注意

UWP アプリで広告を表示するには、Microsoft Store Services SDK ではなく Microsoft Advertising SDK を使います。To display ads in your UWP apps, use the Microsoft Advertising SDK instead of the Microsoft Store Services SDK. Advertising ライブラリは、Microsoft Store Services SDK から Microsoft Advertising SDK に移動されました。The advertising libraries have been moved from the Microsoft Store Services SDK to the Microsoft Advertising SDK. 詳しくは、「アプリでの広告の表示」をご覧ください。For more information, see Display ads in your app.

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

この Microsoft Store Services SDK では現在、UWP アプリ向けに次のシナリオがサポートされています。The Microsoft Store Services SDK currently supports the following scenarios for UWP apps. API リファレンス ドキュメントについては、「Microsoft Store Services SDK API リファレンス」をご覧ください。For API reference documentation, see Microsoft Store Services SDK API reference.

シナリオScenario 説明Description
UWP アプリの A/B テストの実行Run experiments in your UWP app with A/B testing ユニバーサル Windows プラットフォーム (UWP) アプリで A/B テストを実施して、すべてのユーザー向けに機能を公開する前に、一部のユーザーに対して機能の有効性を測定することができます。Run A/B tests in your Universal Windows Platform (UWP) app to measure the effectiveness of features on some customers before you release the features to everyone. デベロッパー センター ダッシュボードで実験を定義したら、アプリで StoreServicesExperimentVariation クラスを使用して実験のバリエーションを取得します。次に、そのデータを使用して、テストする機能の動作を変更し、LogForVariation メソッドを使って、デベロッパー センターにビュー イベントとコンバージョン イベントを送信します。After you define an experiment in your Dev Center dashboard, use the StoreServicesExperimentVariation class to get variations for your experiment in your app, use this data to modify the behavior of the feature you are testing, and then use the LogForVariation method to send view event and conversion events to Dev Center. 最後に、ダッシュボードで結果を表示し、実験を管理します。Finally, use your dashboard to view the results and manage the experiment.
UWP アプリからのフィードバック Hub の起動Launch Feedback Hub from your UWP app UWP アプリで StoreServicesFeedbackLauncher クラスを使用し、Windows 10 ユーザーをフィードバック Hub に誘導して、ユーザーが問題、提案、賛成票を送信できるようにします。Use the StoreServicesFeedbackLauncher class in your UWP app to direct your Windows 10 customers to Feedback Hub, where they can submit problems, suggestions, and upvotes. 次に、デベロッパー センター ダッシュボードのフィードバック レポートでこのフィードバックを管理します。Then, manage this feedback in the Feedback report in the Dev Center dashboard.
デベロッパー センターのプッシュ通知を受信するように UWP アプリを設定するConfigure your UWP app to receive Dev Center push notifications Windows デベロッパー センター ダッシュボードを使用してユーザーに送信するターゲット プッシュ通知を受信するアプリを、UWP アプリの StoreServicesEngagementManager クラスを使用して登録します。Use the StoreServicesEngagementManager class in your UWP app to register your app to receive targeted push notifications that you send to your customers using the Windows Dev Center dashboard.
UWP アプリで、デベロッパー センターの利用状況レポート用のカスタム イベントをログに記録するLog custom events in your UWP app for the Usage report in Dev Center UWP アプリで StoreServicesCustomEventLogger クラスを使用して、デベロッパー センターでアプリに関連するカスタム イベントをログに記録します。Use the StoreServicesCustomEventLogger class in your UWP app to log custom events that are associated with your app in Dev Center. 次にデベロッパー センター ダッシュボードの利用状況レポートカスタム イベントのセクションで、カスタム イベントの合計回数を確認します。Then, review the total occurrences for your custom events in the Custom events section of the Usage report in the Dev Center dashboard.

前提条件Prerequisites

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

  • Visual Studio 2015 またはそれ以降のバージョン。Visual Studio 2015 or a later version.
  • Visual Studio と共にインストールされている ユニバーサル Windows アプリ用 Visual Studio ToolsVisual Studio Tools for Universal Windows Apps installed with your version of Visual Studio.

SDK のインストールInstall the SDK

開発用コンピューターに Microsoft Store Services SDK をインストールするには、次の 2 つのオプションがあります。There are two options for installing the Microsoft Store Services SDK on your development computer:

  • MSI インストーラー  ここから利用できる MSI インストーラーを使って SDK をインストールできます。MSI installer  You can install the SDK via the MSI installer available here.
  • NuGet パッケージ  NuGet パッケージとして、SDK をインストールすることができます。NuGet package  You can install the SDK as a NuGet package.

マイクロソフトでは定期的に、向上したパフォーマンスと新しい機能を備えた、新しいバージョンの Microsoft Store Services SDK をリリースしています。Microsoft periodically releases new versions of the Microsoft Store Services SDK with performance improvements and new features. 開発用コンピューターに SDK を使っている既存のプロジェクトがあり、そのプロジェクトで最新バージョンを使う場合は、最新バージョンの SDK をダウンロードしてインストールしてください。If you have existing projects that use the SDK and you want to use the latest version, download and install the latest version of the SDK on your development computer.

MSI によるインストールInstall via MSI

MSI インストーラーを使って Microsoft Store Services SDK をインストールするにはTo install the Microsoft Store Services SDK via the MSI installer:

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

  2. Microsoft Store Engagement and Monetization SDK、Universal Ad Client SDK、または Ad Mediator 拡張機能を以前にインストールしていた場合は、それらの SDK をアンインストールします。If you previously installed the Microsoft Store Engagement and Monetization SDK, Universal Ad Client SDK, or Ad Mediator extension, uninstall these SDKs now. 必要に応じて、コマンド プロンプト ウィンドウを開き、次のコマンドを実行して、Visual Studio と共にインストールされている可能性があり、コンピューター上のインストールされているプログラムの一覧には表示されない可能性がある、古い SDK のバージョンをすべて削除します。Optionally, open a Command Prompt window and run these commands to clean out any older SDK versions that may have been installed with Visual Studio, but which may not appear in the list of installed programs on your computer:

    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 をダウンロードしてインストールします。Download and install the Microsoft Store Services SDK. インストールには数分かかることがあります。It may take a few minutes to install. 確実に処理が完了するまでお待ちください。Be sure and wait until the process has finished.

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

  5. 以前のバージョンの Microsoft Store Services SDK、Microsoft Advertising SDK、Universal Ad Client SDK、Microsoft Store Engagement and Monetization SDK のライブラリを参照する既存のプロジェクトがある場合には、Visual Studio でプロジェクトを開き、プロジェクトをクリーンしてリビルドすることをお勧めします (ソリューション エクスプ ローラーでプロジェクト ノードを右クリックして、[クリーン] を選択し、次にもう一度プロジェクト ノードを右クリックして、[リビルド] を選択します)。If you have an existing project that references libraries from any earlier version of the Microsoft Store Services SDK, Microsoft Advertising SDK, Universal Ad Client SDK, or Microsoft Store Engagement and Monetization SDK, we recommend that you open your project in Visual Studio and clean and rebuild your project (in Solution Explorer, right-click your project node and choose Clean, and then right-click your project node again and choose Rebuild).

    または、プロジェクトで初めて SDK を使う場合には、アセンブリ参照をプロジェクトを追加することができます。Otherwise, if you are using the SDK for the first time in your project, you are now ready to add the assembly reference to your project.

NuGet によるインストールInstall via NuGet

NuGet を使って Microsoft Store Services SDK をインストールするにはTo install the Microsoft Store Services SDK libraries via NuGet:

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

  2. Microsoft Store Engagement and Monetization SDK、Universal Ad Client SDK、または Ad Mediator 拡張機能を以前にインストールしていた場合は、それらの SDK をアンインストールします。If you previously installed the Microsoft Store Engagement and Monetization SDK, Universal Ad Client SDK, or Ad Mediator extension, uninstall these SDKs now. 必要に応じて、コマンド プロンプト ウィンドウを開き、次のコマンドを実行して、Visual Studio と共にインストールされている可能性があり、コンピューター上のインストールされているプログラムの一覧には表示されない可能性がある、古い SDK のバージョンをすべて削除します。Optionally, open a Command Prompt window and run these commands to clean out any older SDK versions that may have been installed with Visual Studio, but which may not appear in the list of installed programs on your computer:

    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 を使用するプロジェクトを開きます。Start Visual Studio and open the project in which you want to use the Microsoft Store Services SDK.

    注意

    プロジェクトに SDK の以前の MSI インストールからのライブラリの参照が既に含まれている場合は、これらの参照をプロジェクトから削除します。If your project already includes library references from an earlier MSI installation of the SDK, remove these references from your project. これらの参照は、参照先のライブラリが前の手順で削除されたため、その隣に警告アイコンが表示されます。These references will have warning icons next to them because the libraries they reference were removed in the previous steps.

  4. Visual Studio で、[プロジェクト][NuGet パッケージの管理] の順にクリックします。In Visual Studio, click Project and Manage NuGet Packages.

  5. 検索ボックスに「Microsoft.Services.Store.Engagement」と入力し、Microsoft.Services.Store.Engagement パッケージをインストールします。In the search box, type Microsoft.Services.Store.Engagement and install the Microsoft.Services.Store.Engagement package. パッケージのインストールが完了したら、ソリューションを保存します。When the package is done installing, save your solution.

    注意

    [出力] ウィンドウに、指定されたパスが長すぎることを示すインストール パッケージ エラーが表示されたとき、場合によっては、NuGet を構成して、既定の場所よりも短いパスで示される別の場所にパッケージを展開する必要があります。If the Output window reports an Install-Package error that indicates the specified path is too long, you may need to configure NuGet to extract packages to an alternate location with a shorter path than the default location. これを行うには、repositoryPath 値をコンピューターの nuget.config ファイルに追加し、それを短いフォルダーのパスに割り当て、そこに NuGet パッケージが展開されるようにします。To do this, add the repositoryPath value to a nuget.config file on your computer and assign it to a short folder path where NuGet packages can be extracted. 詳しくは、NuGet ドキュメントのこの記事をご覧ください。For more information, see this article in the NuGet documentation. または、Visual Studio プロジェクトを短いパスを持つ別のフォルダーに移動してみることができます。Alternatively, you can try moving your Visual Studio project to an alternate folder with a shorter path.

  6. プロジェクトが含まれている Visual Studio ソリューションを閉じ、そのソリューションを再度開きます。Close the Visual Studio solution that contains your project and then reopen the solution.

  7. プロジェクトが NuGet によりインストールされた以前のバージョンの Microsoft Store Services SDK のライブラリを既に参照している場合で、プロジェクトを SDK の新しいリリースに更新する場合には、プロジェクトをクリーンしてリビルドすることをお勧めします (ソリューション エクスプローラーでプロジェクト ノードを右クリックして、[クリーン] を選択し、次にもう一度プロジェクト ノードを右クリックして、[リビルド] を選択します)。If your project already references libraries from an earlier version of the Microsoft Store Services SDK that was installed via NuGet and you have updated your project to a newer release of the SDK, we recommend that you clean and rebuild your project (in Solution Explorer, right-click your project node and choose Clean, and then right-click your project node again and choose Rebuild).

    または、プロジェクトで初めて SDK を使う場合には、アセンブリ参照をプロジェクトを追加することができます。Otherwise, if you are using the SDK for the first time in your project, you are now ready to add the assembly reference to your project.

アセンブリ参照をプロジェクトを追加するAdd the assembly reference to your project

+MSI インストーラーまたは NuGet により Microsoft Store Services SDK をインストールしたら、次の手順に従って UWP プロジェクトで SDK アセンブリを参照します。After you install the Microsoft Store Services SDK via the MSI installer or NuGet, follow these instructions to reference the SDK assembly in your UWP project.

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

    注意

    プロジェクトが JavaScript アプリで、ターゲットが [任意の CPU] になっている場合は、アーキテクチャ固有のビルド出力 (たとえば [x86]) を使うようにプロジェクトを更新します。If your project is a JavaScript app that targets Any CPU, update your project to use an architecture-specific build output (for example, x86).

  2. ソリューション エクスプローラーで、[参照設定] を右クリックし、[参照の追加] を選択します。In Solution Explorer, right click References and select Add Reference…

  3. [参照マネージャー][ユニバーサル Windows] を展開し、[拡張機能] をクリックして、[Microsoft Engagement Framework] の横のチェック ボックスをオンにします。In Reference Manager, expand Universal Windows, click Extensions, and then select the check box next to Microsoft Engagement Framework. これにより、Microsoft.Services.Store.Engagement 名前空間の API を使用できます。This enables you to use the APIs in the Microsoft.Services.Store.Engagement namespace.

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

注意

NuGet から SDK ライブラリをインストールした場合、プロジェクトには Microsoft.Services.Store.Engagement 参照が含められます。If you installed the SDK libraries via NuGet, your project will contain a Microsoft.Services.Store.Engagement reference. Microsoft.Services.Store.Engagement の参照は (その中のライブラリではなく) NuGet パッケージを表し、これは無視することができます。The Microsoft.Services.Store.Engagement reference represents the NuGet package (rather than the libraries in it), and you can ignore it.

SDK のフレームワーク パッケージを理解するUnderstanding framework packages in the SDK

Microsoft Store Services SDK の Microsoft.Services.Store.Engagement.dll ライブラリは、フレームワーク パッケージとして構成されています。The Microsoft.Services.Store.Engagement.dll library in the Microsoft Store Services SDK is configured as a framework package. このライブラリには、Microsoft.Services.Store.Engagement 名前空間の API が含まれています。This library contains the APIs in the Microsoft.Services.Store.Engagement namespace.

このライブラリはフレームワーク パッケージであるため、このライブラリを使用するバージョンのアプリをユーザーがインストールすると、このライブラリは、修正されてパフォーマンスが向上した新しいバージョンのライブラリが公開されるたびに、ユーザーのデバイスで Windows Update によって自動的に更新されます。Because this library is a framework package, this means that after a user installs a version of your app that uses this library, this library is automatically updated on their device through Windows Update whenever we publish a new version of the library with fixes and performance improvements. これにより、利用できる最新バージョンのライブラリがユーザーのデバイスに確実にインストールされます。This helps to ensure that your customers always have the latest available version of the library installed on their devices.

このライブラリに新しい API や機能が導入された新しいバージョンの SDK がリリースされた場合は、これらの機能を使用するために最新バージョンの SDK をインストールする必要があります。If we release a new version of the SDK that introduces new APIs or features in this library, you will need to install the latest version of the SDK to use those features. このシナリオでは、更新されたアプリをストアに公開する必要もあります。In this scenario, you would also need to publish your updated app to the Store.