Merchant API を効果的に使用するには、登録、認証、認可のコンセプトを理解することが重要です。これらは、Merchant Center データへの安全かつ正確なアクセスを確保するために、それぞれ異なる目的で使用されます。
用語
登録、認証、認可は関連していますが、それぞれに異なる意味と目的があります。
- 認証: このプロセスでは、サービスが API リクエストを行うユーザーまたはアプリケーションの ID を確認します。Merchant API は、OAuth 2.0 などの標準の Google メカニズムを使用します。認証に API キーを使用することはサポートされておらず、認証エラーが発生します。詳細については、リクエストを認証すると独自のアカウントとして認証するをご覧ください。
- 認可: このプロセスでは、認証されたユーザーまたはアプリケーションが Merchant Center アカウントを使用して実行できる操作を決定します。これは、Merchant Center アカウント内で認証済みユーザーに付与されたロールと権限に基づいて、「何ができるか」という質問に答えます。たとえば、ユーザーに商品データの読み取りは許可されているが、アカウント設定の変更は許可されていない場合があります。
- 登録: Merchant API に関して、これは 1 回限りの設定プロセスです。これにより、Google は管理対象の販売アカウントに関する重要なサービスに関するお知らせを送信できるようになります。登録すると、デベロッパーのメールアドレスがメインの 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 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 統合を担当する個々のデベロッパーまたは主要な技術担当者のメールアドレス。
- ベスト プラクティス:
- 推奨: 個人の会社のメールアドレスを使用する。
- 禁止事項: 一般的なグループ エイリアスやサービス アカウントのメールアドレスを使用する。コミュニケーションは人間の受信者を対象としています。
連絡先管理用の users リソース
登録呼び出しのメールアドレスは初期連絡先を設定しますが、連絡先と権限を管理するより堅牢な方法は、Merchant API の accounts.users リソースまたは Merchant Center UI のユーザー管理設定を使用することです。Merchant Center の使用方法について詳しくは、アカウントのユーザーを管理するをご覧ください。
これらの機能は次のように利用できます。
- すべてのデベロッパーを追加する: API 統合に取り組んでいるデベロッパーを Merchant Center アカウントのユーザーとして追加します。
API_DEVELOPERロールを割り当てる: 標準ロール（管理者、標準）に加えて、ユーザーにAPI_DEVELOPERロールを割り当てることができます。特に、API 関連の通知を受け取るユーザーにこのロールを割り当てます。他のロールと組み合わせることができます。- メリット:
- 明確な分離: API 連絡先管理を 1 回限りの登録から切り離します。
- 柔軟性: チームメンバーの変更に応じて連絡先を更新できます。
- ターゲットを絞ったコミュニケーション: API 固有のニュースが関連するユーザーに確実に届くようにします。
登録時にメールアドレスを指定した場合でも、API_DEVELOPER ロールを持つユーザーを追加して API の連絡先を管理することを強くおすすめします。
参照
詳しくは以下をご覧ください。