Merchant API を効果的に使用するには、 登録、認証、 および 認可 のコンセプトを理解することが重要です。これらは、Merchant Center データへの安全かつ正確なアクセスを確保するために、それぞれ異なる目的を果たします。
用語
登録、認証、認可は関連していますが、それぞれ意味と目的が異なります。
- 認証: このプロセスでは、API リクエストを行う ユーザーまたはアプリケーションの ID がサービスによって検証されます。Merchant API では、標準的な Google メカニズム（OAuth 2.0 など）が使用されます。詳細については、リクエストを認証するおよび自分のアカウントとして認証するをご覧ください。
- 認可: このプロセスでは、認証された ユーザーまたはアプリケーションが 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 や APIs Explorer などのツールは、Google が所有する共有の Google Cloud プロジェクトを使用します。共有プロジェクトでは登録できません。
- これらはテストとデータ探索を目的としており、本番環境のアプリケーション ID を目的としていません。
- 登録すると、共有ツールと特定の Merchant Center データがリンクされ、不要な通信が発生する可能性があります。
アプリケーションには専用の Google Cloud プロジェクトが必要です。これにより、Google から送信される Merchant API 通信が実際の使用に関連したものになります。
ただし、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 統合を担当する個々のデベロッパー または主要な技術担当者のメールアドレスである必要があります。
- ベスト プラクティス:
- 推奨: 個人の会社のメールアドレスを使用します。
- 非推奨: 一般的なグループ エイリアスやサービス アカウントのメールは使用しないでください。Google は、人間が受信することを想定して通信を行っています。
連絡先管理用の users リソース
登録呼び出しのメールアドレスは最初の連絡先を設定しますが、
連絡先と権限をより堅牢に管理するには、Merchant API
accounts.users
リソースまたは Merchant Center UI のユーザー管理設定を使用します。Merchant Center の使用方法について詳しくは、
アカウントのユーザーを管理するをご覧ください。
これらの機能は次のように活用できます。
- すべてのデベロッパーを追加する: API 統合に取り組んでいるデベロッパーを Merchant Center アカウントのユーザーとして追加します。
API_DEVELOPERロールを割り当てる: 標準ロール（管理者、 標準）に加えて、ユーザーにAPI_DEVELOPERロールを割り当てることができます。特に、API 関連のコミュニケーションを受け取るユーザーにはこのロールを割り当てます。他のロールと組み合わせることもできます。- 特典:
- 明確な分離: API の連絡先管理を 1 回限りの 登録から切り離します。
- 柔軟性: チームメンバーの変更に応じて連絡先を更新します。
- ターゲットを絞ったコミュニケーション: API 固有のニュースが 関連する担当者に届くようにします。
登録時にメールアドレスを指定した場合でも、API_DEVELOPER ロールを持つユーザーを追加して API の連絡先を管理することを強くおすすめします。
参照
詳しくは以下をご覧ください。