アプリケーションから限定公開データがリクエストされた場合は、対象データへのアクセス権を持つ認証済みのユーザーがリクエストを承認する必要があります。
アプリケーションから Display & Video 360 API に送信するリクエストにはすべて、認証トークンが含まれている必要があります。このトークンは Google でアプリケーションを識別するためにも使用されます。
認証プロトコルについて
リクエストを承認するために、アプリケーションは OAuth 2.0 を使用する必要があります。これ以外の認証プロトコルには対応していません。アプリケーションで「Google でログイン」を使用している場合、承認手続きの一部が自動化されます。
OAuth 2.0 を使用したリクエストの承認
Display & Video 360 API へのリクエストは、すべて認証済みのユーザーによって承認される必要があります。
OAuth 2.0 の承認プロセス(「フロー」)の詳細は開発するアプリケーションの種類によって若干異なりますが、次の一般的なプロセスはすべての種類のアプリケーションに当てはまります。
- アプリケーションの作成時に、Google API Console を使用してアプリケーションを登録します。登録すると、後で必要になるクライアント ID やクライアント シークレットなどの情報が Google から提供されます。
- Google API Console で Display & Video 360 API を有効にします。(Indexing API が API Console に表示されない場合は、この手順をスキップしてください)。
- アプリケーションでユーザーデータにアクセスする必要がある場合は、特定のアクセスのスコープを Google にリクエストします。
- データをリクエストするアプリケーションの承認を求める Google の同意画面がユーザーに表示されます。
- ユーザーが承認すると、有効期間の短いアクセス トークンがアプリケーションに付与されます。
- アプリケーションは、リクエストにそのアクセス トークンを付与してユーザーデータをリクエストします。
- Google がそのリクエストとトークンが有効であると判断すると、リクエストされたデータが返されます。
プロセスによっては、更新トークンを使用して新しいアクセス トークンを取得するなど、追加の手順が必要になる場合もあります。各種アプリケーションのフローについて詳しくは、Google の OAuth 2.0 ドキュメントをご覧ください。
Display & Video 360 API で使用される OAuth 2.0 のスコープ情報は次のとおりです。
範囲 | 意味 |
---|---|
https://www.googleapis.com/auth/display-video |
読み取り / 書き込みアクセス。 |
https://www.googleapis.com/auth/display-video-user-management |
users サービスに対する読み取り/書き込みアクセス権。サービス アカウントのユーザーのみが使用できます。 |
OAuth 2.0 を使用してアクセスをリクエストする場合、アプリケーションを登録したときに Google から提供された情報(クライアント ID やクライアント シークレットなど)に加えて、スコープ情報が必要になります。
ヒント: Google API クライアント ライブラリで一部の承認プロセスを処理することもできます。これらのライブラリはさまざまなプログラミング言語で用意されています。詳細については、ライブラリとサンプルのページをご覧ください。
ユーザー権限
Display & Video 360 API を使用するには、認証する Google アカウントは、関連するパートナーまたは広告主へのアクセス権を持つディスプレイ &ビデオ 360 ユーザーである必要があります。
ディスプレイ &ビデオ 360 のユーザーが次の操作を行うには、関連するパートナーまたは広告主に対して次のいずれかのユーザー役割を付与されている必要があります。
- 読み取り専用:
get
呼び出しまたはlist
呼び出しを使用してリソースを取得します(user
リソースを除く)。 - 標準: リソースの取得、作成、更新。同じパートナーまたは広告主の権限を持つ
user
リソースを取得します。 - 管理: リソースの取得、作成、更新。管理するパートナーまたは広告主の
user
リソースを取得、作成、アクセス権を付与します。