Merchant API を効果的に使用するには、登録、認証、認可のコンセプトを理解することが重要です。これらは、Merchant Center データへの安全かつ正確なアクセスを確保するという点で、それぞれ異なる目的を果たします。
用語
登録、認証、認可は関連していますが、それぞれ意味と目的が異なります。
- 認証: このプロセスでは、サービスは API リクエストを行うユーザーまたはアプリケーションの ID を確認します。Merchant API は、OAuth 2.0 などの標準の Google メカニズムを使用します。詳細については、リクエストを認証すると自分のアカウントとして認証するをご覧ください。
- 承認: このプロセスでは、認証されたユーザーまたはアプリケーションが Merchant Center アカウントを使用して実行できるアクションを決定します。Merchant Center アカウント内で認証済みユーザーに付与されたロールと権限に基づいて、「何ができるか」という質問に回答します。たとえば、ユーザーは商品データの読み取りは許可されているが、アカウント設定の変更は許可されていない場合があります。
- 登録: Merchant API に関しては、これは、お客様が管理する販売者アカウントに関する重要なサービスのお知らせを Google からお客様に送信できるようにする 1 回限りの設定プロセスです。登録すると、デベロッパーのメールアドレスがメインの Merchant Center アカウントに追加され、認証に使用する Google Cloud プロジェクト ID にリンクされます。このリンクにより、アプリケーションは管理しているすべての販売者アカウントのサービス アナウンスを受信できます。詳細については、Google Cloud プロジェクトを作成するをご覧ください。
登録
登録プロセスは、アプリケーションで Merchant API を使用できるようにするために不可欠です。次の説明をお読みください。
前提条件
Merchant API を使用するには、次の登録が必要です。
- Merchant Center アカウント: 既存の Merchant Center アカウントが必要です。
- 管理者権限: 登録呼び出しを開始するために使用する Google ユーザー アカウントには、登録する Merchant Center アカウントに対する管理者権限が必要です。
- Google Cloud プロジェクト: アプリケーションは Google Cloud プロジェクトに関連付けられている必要があります。このプロジェクトは、アプリケーションの認証に必要な認証情報（OAuth 2.0 クライアント ID など）を提供します。
共有 Google Cloud プロジェクトを登録できない理由
Google OAuth Playground や API Explorer などのツールは、Google が所有する共有の Google Cloud プロジェクトを使用します。共有プロジェクトでは登録できません。理由は次のとおりです。
- これらはテストと探索を目的としたものであり、本番環境のアプリケーション ID を目的としたものではありません。
- 登録すると、共有ツールと特定の Merchant Center データがリンクされ、不要な連絡が発生する可能性があります。
Google から送信される Merchant API 通信が実際の使用状況と関連性を保つように、アプリケーションには専用の Google Cloud プロジェクトが必要です。
ただし、OAuth Playground と API Explorer のウェブアプリを使用して、テストや非本番環境のユースケースで Merchant API を使用することはできます。
Google Cloud プロジェクト ID を確認する
プロジェクト ID とプロジェクト番号は、Google Cloud コンソールで確認できます。詳細については、プロジェクト名、番号、ID を確認するをご覧ください。
登録呼び出しを行う
Accounts サブ API 内の registerGcp メソッドを使用して登録します。この呼び出しにより、Google Cloud プロジェクト番号が Merchant Center アカウントに関連付けられます。
このプロセスでは、API の呼び出しに使用する個々のユーザーに関連付けられたメールアドレスを指定する必要があります。このメールアドレスは、Merchant Center アカウントの管理者権限を持つユーザーのものである必要があります。
メール フィールドについて
効果的なコミュニケーションが重要です。Google は、Merchant API に関連する重要な更新情報、必須サービスのお知らせ（MSA）、デベロッパー アンケート、その他の機会をお送りします。適切な連絡先管理により、これらの情報が適切なユーザーに届くようになります。
- 目的: Google は、API 関連の連絡先としてこのメールアドレスを使用します。
- メールアドレスの所有者: API 統合を担当する個々のデベロッパーまたは主要な技術担当者のメールアドレスを指定します。
- ベスト プラクティス:
- 許可: 個人の会社のメールアドレスを使用します。
- 使用しないでください: 一般的なグループ エイリアスまたはサービス アカウントのメールアドレスを使用しないでください。コミュニケーションは人間を対象としています。
連絡先管理の users リソース
登録呼び出しのメールアドレスで最初の連絡先を設定できますが、連絡先と権限をより堅牢に管理するには、Merchant API の accounts.users リソースまたは Merchant Center UI のユーザー管理設定を使用することをおすすめします。Merchant Center の使用について詳しくは、アカウントのユーザーを管理するをご覧ください。
これらの機能を利用する方法は次のとおりです。
- すべてのデベロッパーを追加: API 統合に取り組んでいるデベロッパーを Merchant Center アカウントのユーザーとして追加します。
API_DEVELOPERロールを割り当てる: 標準ロール（管理者、標準）に加えて、ユーザーにAPI_DEVELOPERロールを割り当てることができます。特に、API 関連の通知を受け取るユーザーにこのロールを割り当てます。他のロールと組み合わせることができます。- メリット:
- 明確な分離: API の連絡先管理を 1 回限りの登録から切り離します。
- 柔軟性: チームメンバーの変更に合わせて連絡先を更新できます。
- ターゲットを絞ったコミュニケーション: API 固有のニュースが関連するユーザーに確実に届きます。
登録時にメールアドレスを指定した場合でも、API_DEVELOPER ロールを持つユーザーを追加して API の連絡先を管理することを強くおすすめします。
参照
詳しくは以下をご覧ください。