API を設定する
アプリケーションから Postmaster Tools API に送信するすべてのリクエストには、認証トークンを含める必要があります。このトークンは Google でアプリケーションを識別するためにも使用されます。
認証プロトコルについて
リクエストを承認するために、アプリケーションは OAuth 2.0 を使用する必要があります。これ以外の認証プロトコルには対応していません。アプリケーションで「Google でログイン」を使用している場合、承認手続きの一部が自動化されます。
OAuth 2.0 を使用したリクエストの承認
Postmaster Tools API に対するすべてのリクエストは、認証済みユーザーによって承認される必要があります。
OAuth 2.0 の承認プロセス(「フロー」)の詳細は開発するアプリケーションの種類によって若干異なりますが、次の一般的なプロセスはすべての種類のアプリケーションに当てはまります。
- アプリケーションの作成時に、Google API Console を使用してアプリケーションを登録します。登録すると、後で必要になるクライアント ID やクライアント シークレットなどの情報が Google から提供されます。
- Google API Console で Postmaster Tools API を有効にします。(Indexing API が API Console に表示されない場合は、この手順をスキップしてください)。
- アプリケーションでユーザーデータにアクセスする必要がある場合は、特定のアクセスのスコープを Google にリクエストします。
- データをリクエストするアプリケーションの承認を求める Google の同意画面がユーザーに表示されます。
- ユーザーが承認すると、有効期間の短いアクセス トークンがアプリケーションに付与されます。
- アプリケーションは、リクエストにそのアクセス トークンを付与してユーザーデータをリクエストします。
- Google がそのリクエストとトークンが有効であると判断すると、リクエストされたデータが返されます。
プロセスによっては、更新トークンを使用して新しいアクセス トークンを取得するなど、追加の手順が必要になる場合もあります。各種アプリケーションのフローについて詳しくは、Google の OAuth 2.0 ドキュメントをご覧ください。
Postmaster Tools API の OAuth 2.0 のスコープ情報は次のとおりです。
範囲 |
意味 |
https://www.googleapis.com/auth/postmaster.readonly |
Postmaster Tools データへの読み取り専用アクセスを許可します。 |
OAuth 2.0 を使用してアクセスをリクエストする場合、アプリケーションを登録したときに Google から提供された情報(クライアント ID やクライアント シークレットなど)に加えて、スコープ情報が必要になります。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-12-21 UTC。
[null,null,["最終更新日 2024-12-21 UTC。"],[[["Every request to the Postmaster Tools API requires an authorization token obtained through OAuth 2.0 for application identification and access."],["Applications need to be registered using the Google API Console to receive a client ID and client secret for authorization purposes."],["Users are presented with a consent screen to grant access to their data, after which the application receives a short-lived access token for data requests."],["Read-only access to Postmaster Tools data is granted using the 'https://www.googleapis.com/auth/postmaster.readonly' scope."]]],["Applications accessing the Postmaster Tools API must use OAuth 2.0 for authorization, including an authorization token in each request. The process involves registering the application in the Google API Console to obtain a client ID and secret, activating the API, and requesting a specific access scope. Users then see a consent screen; upon approval, the application receives an access token. This token is used to request data, with Google verifying the request before releasing it. The scope for this API is `https://www.googleapis.com/auth/postmaster.readonly`.\n"]]