OAuth Service Account Flow

This guide will walk you through how to setup OAuth2 for API access using your own credentials using server-to-server flow. These steps only need to be done once, unless you revoke or delete your OAuth2 credentials.

Step 1 - Creating OAuth2 credentials

Generate a service (delegate) account ID and a *.JSON file by following the linked instructions, then come back to this page.

Note: This flow requires a Google Apps Domain and impersonation.

Step 2 - Setting up the client library using JSON configuration file

Configure the following keys in your google-ads.yaml config file, or in your environment.

In YAML:

path_to_private_key_file: INSERT_PRIVATE_KEY_FILE_PATH
delegated_account: INSERT_DELEGATE_ACCOUNT

In environment:

GOOGLE_ADS_PATH_TO_PRIVATE_KEY_FILE=INSERT_PRIVATE_KEY_FILE_PATH
GOOGLE_ADS_DELEGATE_ACCOUNT=INSERT_DELEGATE_ACCOUNT

Note: When reading configuration the library will prioritize credentials for the OAuth2 Installed or Web application flows, so if you want to use a Service Account authentication make sure credentials for the other flows are not present in your configuration.