Authorize Requests

When your application requests private data, the request must be authorized by an authenticated user who has access to that data.

Every request your application sends to the Display & Video 360 API must include an authorization token. The token also identifies your application to Google.

About authorization protocols

Your application must use OAuth 2.0 to authorize requests. No other authorization protocols are supported. If your application uses Sign In With Google, some aspects of authorization are handled for you.

Authorizing requests with OAuth 2.0

All requests to the Display & Video 360 API must be authorized by an authenticated user.

The details of the authorization process, or "flow," for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:

  1. When you create your application, you register it using the Google API Console. Google then provides information you'll need later, such as a client ID and a client secret.
  2. Activate the Display & Video 360 API in the Google API Console. (If the API isn't listed in the API Console, then skip this step.)
  3. When your application needs access to user data, it asks Google for a particular scope of access.
  4. Google displays a consent screen to the user, asking them to authorize your application to request some of their data.
  5. If the user approves, then Google gives your application a short-lived access token.
  6. Your application requests user data, attaching the access token to the request.
  7. If Google determines that your request and the token are valid, it returns the requested data.

Some flows include additional steps, such as using refresh tokens to acquire new access tokens. For detailed information about flows for various types of applications, see Google's OAuth 2.0 documentation.

Here's the OAuth 2.0 scope information for the Display & Video 360 API:

Scope Meaning Read/write access. Read/write access for users service. Only available for service account users.

To request access using OAuth 2.0, your application needs the scope information, as well as information that Google supplies when you register your application (such as the client ID and the client secret).

Tip: The Google APIs client libraries can handle some of the authorization process for you. They are available for a variety of programming languages; check the page with libraries and samples for more details.

User permissions

In order to use the Display & Video 360 API, the authenticating Google Account must be a Display & Video 360 user with access to relevant partners or advertisers.

The Display & Video 360 user must have one of the following user roles for the relevant partners or advertisers to do the following actions:

  • Read only: Retrieve resources using get or list calls, excluding user resources.
  • Standard: Retrieve, create, and update resources. Retrieve user resources with permissions to the same partners or advertisers.
  • Admin: Retrieve, create, and update resources. Retrieve, create and grant access to user resources for the partners or advertisers you administrate.