ストア サービスを使用してレビューに応答する

  • [アーティクル]

重要

このトピックに記載されているように、Microsoft Store レビュー API は現在動作状態ではありません。 API を使用する代わりに、パートナー センターを使用して同じタスクを実行できます。

Microsoft Store レビュー API を使用して、プログラムによってストア内のアプリのレビューに応答します。 この API は、パートナー センターを使わずに多数のレビューにまとめて返信する開発者には特に便利です。 この API は、Azure Active Directory (Azure AD) を使って、アプリまたはサービスからの呼び出しを認証します。

次の手順で、このプロセスについて詳しく説明しています。

  1. すべての前提条件を完了したことを確認します。
  2. Microsoft Store レビュー API でメソッドを呼び出す前に、 Azure AD アクセス トークンを取得します。 トークンを取得した後、トークンの有効期限が切れる前に、Microsoft Store レビュー API の呼び出しでこのトークンを使用するには 60 分かかります。 トークンの有効期限が切れた後は、新しいトークンを生成できます。
  3. Microsoft Store レビュー API を呼び出します。

注意

Microsoft Store レビュー API を使ってプログラムでレビューに返信する以外に、パートナー センターを使ってレビューに返信することもできます。

手順 1: Microsoft Store レビュー API を使用するための前提条件を満たす

Microsoft Store レビュー API を呼び出すコードの記述を開始する前に、次の前提条件を満たしていることを確認してください。

  • 自分 (または自分の組織) に Azure AD ディレクトリがあり、自分がそのディレクトリに対するグローバル管理者のアクセス許可を持っている必要があります。 Microsoft 365 または Microsoft の他のビジネス サービスをすでに使用している場合、Azure AD ディレクトリをすでに所有しています。 それ以外の場合は、追加料金なしにパートナー センターで新しい Azure AD を作成できます。

  • Azure AD アプリケーションをパートナー センター アカウントに関連付け、アプリケーションのテナント ID とクライアント ID を取得してキーを生成する必要があります。 Azure AD アプリケーションは、Microsoft Store レビュー API を呼び出すアプリまたはサービスを表します。 API に渡す Azure AD アクセス トークンを取得するには、テナント ID、クライアント ID、キーが必要です。

    Note

    この作業を行うのは一度だけです。 テナント ID、クライアント ID、キーがあれば、新しい Azure AD アクセス トークンを作成する必要がある度にそれらを再利用できます。

Azure AD アプリケーションをパートナー センター アカウントに関連付け、必要な値を取得するには、次の手順を実行します。

  1. パートナー センターで、組織のパートナー センター アカウントを組織の Azure AD ディレクトリに関連付けます。

  2. 次に、パートナー センターの [アカウント設定] セクションの [ユーザー] ページから、レビューに返信するために使用するアプリやサービスを表す Azure AD アプリケーションを追加します。 このアプリケーションにマネージャー ロールを確実に割り当てます。 アプリケーションがまだ Azure AD ディレクトリに存在しない場合、パートナー センターで新しい Azure AD アプリケーションを作成できます。

  3. [ユーザー] ページに戻り、Azure AD アプリケーションの名前をクリックしてアプリケーション設定に移動し、テナント ID とクライアント ID の値を書き留めます。

  4. [新しいキーを追加] をクリックします。 次の画面で、キーの値を書き留めます。 このページを離れると、この情報にアクセスすることはできなくなります。 詳細については、「Azure AD アプリケーションのキーを管理する」を参照してください。

手順 2:Azure AD アクセス トークンを取得する

Microsoft Store レビュー API 内のいずれかのメソッドを呼び出す前に、まず、API の各メソッドの Authorization ヘッダーに渡す Azure AD アクセス トークンを取得する必要があります。 アクセス トークンを取得したら、期限が切れる 60 分が経過する前に使用します。 トークンの有効期限が切れた後は、トークンを更新してそれ以降の API 呼び出しで引き続き使用できます。

アクセス トークンを取得するには、「クライアント資格情報を使用したサービス間の呼び出し」の手順に従って、HTTP POST を https://login.microsoftonline.com/<tenant_id>/oauth2/token エンドポイントに送信します。 要求の例を次に示します。

POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com

POST URI の tenant_id の値と client_id および client_secret のパラメーターには、前のセクションでパートナー センターから取得したアプリケーションのテナント ID、クライアント ID、キーを指定します。 resource パラメーターには、https://manage.devcenter.microsoft.com を指定します。

アクセス トークンの有効期限が切れた後は、この手順に従って更新できます。

手順 3: Microsoft Store レビュー API を呼び出す

Azure AD アクセス トークンを取得したら、Microsoft Store レビュー API を呼び出す準備ができました。 各メソッドの Authorization ヘッダーにアクセス トークンを渡す必要があります。

Microsoft Store レビュー API には、特定のレビューへの返信が許可されているかどうかを判断し、1 つ以上のレビューに返信を送信するために使用できるいくつかのメソッドが含まれています。 この API を使用するには、次の手順に従います。

  1. 返信するレビューの ID を取得します。 レビュー ID は、Microsoft Store 分析 API の get アプリ レビュー メソッドの応答データと、[レビュー レポート](/windows/apps/publish/reviews-report) のオフライン ダウンロードで使用できます。
  2. アプリ レビューの応答情報の 取得メソッドを呼び出して、 レビューへの返信が許可されているかどうかを判断します。 顧客はレビューを送信するときに、レビューへの返信を受け取らないことを選択できます。 レビューの返信を受け取らないと選択した顧客によって送信されたレビューに返信することはできません。
  3. アプリ レビューへの応答の 送信メソッドを呼び出して、 プログラムによってレビューに応答します。