リクエストの承認

アプリケーションから限定公開データがリクエストされた場合は、そのデータへのアクセス権を持つ認証済みのユーザーがそのリクエストを承認する必要があります。

アプリケーションから Indexing API に送信するすべてのリクエストには、承認トークンを含める必要があります。このトークンは Google でアプリケーションを識別するためにも使用されます。

承認プロトコルについて

アプリケーションでは OAuth 2.0 を使用してリクエストを承認する必要があります。これ以外の承認プロトコルはサポートされていません。アプリケーションで Google ログインを使用している場合、承認手続きの一部が自動化されます。

OAuth 2.0 によるリクエストの承認

Indexing API へのすべてのリクエストは、認証済みのユーザーによって承認される必要があります。

OAuth 2.0 の承認プロセス(または「フロー」)の詳細は、開発するアプリケーションの種類によって若干異なりますが、次の一般的なプロセスは、すべての種類のアプリケーションに適用されます。

  1. アプリケーションの作成時に、Google API コンソールを使用してアプリケーションを登録します。そうすると、後で必要になるクライアント ID やクライアント シークレットなどの情報が Google から提供されます。
  2. Google API コンソールで Indexing API を有効にします(API が API コンソールに表示されない場合は、この手順をスキップしてください)。
  3. アプリケーションは、ユーザー データにアクセスする必要がある場合、特定のアクセス範囲を Google にリクエストします。
  4. データをリクエストするアプリケーションの承認を求める Google の同意画面がユーザーに表示されます。
  5. ユーザーが承認すると、Google からアプリケーションに短期間有効なアクセス トークンが与えられます。
  6. アプリケーションは、アクセス トークンを付けてユーザー データをリクエストします。
  7. Google はリクエストとトークンが有効であると判断した場合、リクエストされたデータを返します。

フローによっては、追加手順(更新トークンを使用して新しいアクセス トークンを取得するなど)が必要になる場合もあります。各種アプリケーションに対するフローについて詳しくは、Google の OAuth 2.0 に関するドキュメントをご覧ください。

Indexing API で使用される OAuth 2.0 の範囲情報は次のとおりです。

範囲 意味
https://www.googleapis.com/auth/internal/one-platform/standard-docset 読み取り / 書き込みアクセス
https://www.googleapis.com/auth/internal/one-platform/standard-docset.readonly 読み取り専用アクセス

OAuth 2.0 を使用してアクセスをリクエストするには、アプリケーションの登録時に Google から提供された情報(クライアント ID やクライアント シークレットなど)の他に、この範囲情報が必要になります。

ヒント: Google API クライアント ライブラリで一部の承認プロセスを処理することもできます。これらのライブラリは、各種プログラミング言語で利用できます。詳しくは、ライブラリとサンプルのページをご覧ください。

フィードバックを送信...