Start Free Trial   Support

Google Campaign Manager Advanced Settings

Authenticate via OAuth Authentication

Use the OAuth authentication standard to connect to Google Campaign Manager. You can authenticate with a user account or with a service account. A service account is required to grant organization-wide access scopes to the provider. The provider facilitates these authentication flows as described below.

Authenticate with a User Account

See Using OAuth Authentication for an authentication guide.

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You need to create an OAuth application in this flow. See Creating a Custom OAuth App to create and authorize an app. You can then connect to Google Campaign Manager data that the service account app has permission to access.

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthJWTCertType: Set this to "PFXFILE".
  • OAuthJWTCertPassword: Set this to the password of the .p12 file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTIssuer: Set this to the email address of the service account.
  • OAuthJWTCert: Set this to the path to the .p12 file.
  • OAuthJWTSubject: Set this to the email address of the user for whom the application is requesting delegate access. Note that delegate access must be granted by an administrator.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.

When you connect the provider completes the OAuth flow for a service account.

  1. Creates and signs the JWT with the claim set required by the provider.
  2. Exchanges the JWT for the access token.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Submits the JWT for a new access token when the token expires.

Using OAuth Authentication

Use the OAuth authentication standard to connect to Google Campaign Manager. You can authenticate with a user account or a service account. The provider facilitates this as described below.

Using a User Account to Authenticate to Google Campaign Manager

The user account flow requires the authenticating user to interact with Google Campaign Manager via the browser.

Embedded Credentials

Desktop Applications

See Embedded Credentials to connect with the provider's embedded credentials and skip creating a custom OAuth app.

Headless Machines

See Headless Machines to skip creating a custom OAuth app and authenticate an application running on a headless server or another machine where the provider is not authorized to open a browser.

Custom Credentials

Instead of connecting with the provider's embedded credentials, you can register an app to obtain the OAuthClientId and OAuthClientSecret.

When to Create a Custom OAuth App

Web Applications

You need to create a custom OAuth app in the web flow.

Desktop Applications

Creating a custom OAuth app is optional as the provider is already registered with Google Campaign Manager and you can connect with its embedded credentials. You might want to create a custom OAuth app to change the information displayed when users log into the Google Campaign Manager OAuth endpoint to grant permissions to the provider.

Headless Machines

Creating a custom OAuth app is optional to authenticate a headless machine; the provider is already registered with Google Campaign Manager and you can connect with its embedded credentials. In the headless OAuth flow, users need to authenticate via a browser on another machine. You might want to create a custom OAuth app to change the information displayed when users log into the Google Campaign Manager OAuth endpoint to grant permissions to the provider.

Service Accounts

You need to create an OAuth application in this flow. You can use a service account to delegate enterprise-wide access scopes to the provider.

Service accounts have silent authentication, without user authentication in the browser. Instead, the app is linked to the organization. You connect to Google Campaign Manager data that the service account has permission to access. See Custom Credentials for an authentication guide.

Creating a Custom OAuth App

See Creating a Custom OAuth App for how-tos.

Embedded Credentials

 

Authenticate using the Embedded OAuth Credentials

Desktop Authentication with the Embedded OAuth App

You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.
When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process.
  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Custom Credentials

When to Create a Custom OAuth App

User Account Authentication

Creating a custom OAuth app is required in the web flow. Creating a custom OAuth app is optional for desktop and headless applications; the provider is already registered with Google Campaign Manager and you can connect with its embedded credentials.

You might want to create a custom OAuth app to change the information displayed when users log into the Google Campaign Manager OAuth endpoint to grant permissions to the provider.

Service Account Authentication

You need to create an OAuth app in the service account flow.

Authenticate with a User Account

Desktop Authentication with a Custom OAuth App

After Creating a Custom OAuth App, follow the steps below to authenticate with your custom App's credentials.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: Set this to the client Id assigned when you registered your app.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your app.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.
When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
  1. Extracts the access token from the callback URL and authenticates requests.
  2. Refreshes the access token when it expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Web Authentication with a Custom OAuth App

When connecting via a Web application, you need to register a custom OAuth app with Google Campaign Manager; see Creating a Custom OAuth App. You can then use the provider to get and manage the OAuth token values.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.

You can then call stored procedures to complete the OAuth exchange:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings.

    The stored procedure returns the URL to the OAuth endpoint.

  2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
  3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL.

Refresh the OAuth Access Token

You can set InitiateOAuth to REFRESH to automatically refresh the OAuth access token when it expires, or you can call the RefreshOAuthAccessToken stored procedure to refresh the token manually.

Automatic Refresh

To refresh the token with InitiateOAuth, set the following on the first data connection:

  • OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
  • InitiateOAuth: Set this to REFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthSettingsLocation: Set this to the path where the provider will save the OAuth values, to be persisted across connections.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.

On subsequent data connections, set the following:

  • InitiateOAuth
  • OAuthSettingsLocation
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.

Manual Refresh

You can use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken. Call the stored procedure after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed. You need the following connection properties to be set:

  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.

You can then call RefreshOAuthAccessToken with the following parameter set:

  • OAuthRefreshToken: Set this to the OAuthRefreshToken returned by GetOAuthAccessToken.

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to grant enterprise-wide access scopes to the provider.

You need to create an OAuth application in this flow. See Creating a Custom OAuth App to create and authorize an app.

You can then connect to Google Campaign Manager data that the service account has permission to access. After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthJWTCertType: Set this to "PEMKEY_FILE".
  • OAuthJWTCert: Set this to the path to the .pem file you generated.
  • OAuthJWTCertPassword: Set this to the password of the .pem file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.
When you connect the provider completes the OAuth flow for a service account.
  1. Creates and signs the JWT with the claim set required by the provider.
  2. Exchanges the JWT for the access token.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Submits the JWT for a new access token when the token expires.

Headless Machines

 

Using OAuth on a Headless Machine

The following sections show how to authenticate a headless server or another machine on which the provider cannot open a browser. You can authenticate with a user account or with a service account.
 

Authenticate with a User Account

To authenticate with a user account, you need to authenticate from another machine. Authentication is a two-step process.
  1. Instead of installing the provider on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the provider on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the provider to automatically refresh the access token from the headless machine.
You can follow the headless OAuth authentication flow using the provider's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Using the Embedded OAuth Credentials

Obtain a Verifier Code

Follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property:

  1. Click the following link to open the Google Campaign Manager OAuth endpoint in your browser.
  2. Log in and grant permissions to the provider. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values.

  • OAuthVerifier: Set this to the verifier code.
  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.

Transfer OAuth Settings

Follow the steps below to install the provider on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the provider and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable text file.
  • InitiateOAuth: Set this to GETANDREFRESH.
Test the connection to authenticate in the browser. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.

Using the Credentials for a Custom OAuth App

Create a Custom OAuth App

Creating a custom OAuth app is optional in the headless OAuth flow; you can skip creating an app by connecting with the provider's embedded OAuth credentials. You might want to create a custom OAuth app to change the information displayed when users log into Google Campaign Manager to grant permissions to the provider.

See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.

Obtain a Verifier Code

Set the following properties on the headless machine:

  • InitiateOAuth: Set this to OFF.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings 

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

  1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
  2. Open the returned URL in a browser. Log in and grant permissions to the provider. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
  • InitiateOAuth: Set this to REFRESH.

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.

Transfer OAuth Settings

Follow the steps below to install the provider on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the provider and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable text file.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the client Id assigned when you registered your app.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your app.

Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the provider.

You need to create an OAuth application in this flow. See Creating a Custom OAuth App to create and authorize an app. You can then connect to Google Campaign Manager data that the service account has permission to access.

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the Client Id in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • OAuthJWTCertType: Set this to "PEMKEY_FILE".
  • OAuthJWTCert: Set this to the path to the .pem file you generated.
  • OAuthJWTCertPassword: Set this to the password of the .pem file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
  • ProfileID: Set this to the DoubleClick User Profile ID you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first User Profile returned will be used.
When you connect the provider completes the OAuth flow for a service account.
  1. Creates and signs the JWT with the claim set required by the provider.
  2. Exchanges the JWT for the access token.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Submits the JWT for a new access token when the token expires.

Creating a Custom OAuth App

When to Create a Custom OAuth App

User Account Authentication

Creating a custom OAuth app is required in the web flow. Creating a custom OAuth app is optional for desktop and headless applications; the provider is already registered with Google Campaign Manager and you can connect with its embedded credentials.

You might want to create a custom OAuth app to change the information displayed when users log into the Google Campaign Manager OAuth endpoint to grant permissions to the provider.

Service Account Authentication

You need to create an OAuth app in the service account flow.

Create an OAuth App for User Account Authentication

Follow the procedure below to register an app and obtain the OAuthClientId and OAuthClientSecret.

Create a Custom OAuth App: Desktop

  1. Log into the Google API Console and open a project. Select the API Manager from the main menu.
  2. Click Credentials -> Create Credentials -> OAuth Client Id. Click Other.
  3. Click Library -> DCM/DFA Reporting And Trafficking API -> Enable API.

Create a Custom OAuth App: Web Apps

  1. Log into the Google API Console and open a project. Select the API Manager from the main menu.

  2. If you are connecting from a desktop application, click Credentials -> Create Credentials -> OAuth Client Id. Click Other.

    If you are connecting from a Web application, click Web Application. In the Authorized Redirect URIs box, enter the URL you want to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access.

  3. Click Library -> DCM/DFA Reporting And Trafficking API -> Enable API.

Create a Custom OAuth App: Headless Machines

  1. Log into the Google API Console and open a project. Select the API Manager from the main menu.
  2. Click Credentials -> Create Credentials -> OAuth Client Id. Click Other.
  3. Click Library -> DCM/DFA Reporting And Trafficking API -> Enable API.

Create an OAuth App for Service Account Authentication

To obtain the necessary authentication properties, follow the steps below to create an OAuth application and generate a private key:

  1. Log into the Google API Console and open a project. Select the API Manager from the main menu.
  2. Click Create Credentials -> Service Account Key.
  3. In the Service Account menu, select New Service Account or select an existing service account.
  4. If you are creating a new service account, additionally select one or more roles. You can assign primitive roles at the project level in the IAM and Admin section; other roles enable you to further customize access to Google APIs.
  5. In the Key Type section, select the P12 key type.
  6. Create the app to download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.
  7. In the service accounts section, click Manage Service Accounts and set OAuthJWTIssuer to the email address displayed in the service account Id field.

Retrieving DoubleClick Campaign Manager data

DoubleClick Campaign Manager data is organized into various metrics (Clicks, CostPerClick, Impressions, etc.), which can be queried over various dimensions (Country, Month, etc.). Auto-discovering all existing reports for your DCM account is extremely expensive. To work around this, the provider exposes five generic tables, one for each type of report, which allow for ad-hoc reporting as well as running your existing reports. There is also the option to create custom schema files for your existing reports so they can be queried as their own tables. These sections will discuss the different strategies for querying your DCM data with the provider.

Built-In Reporting Tables

There are five built-in tables in the driver: CrossDimensionReachReport, FloodlightReport, PathToConversionReport, ReachReport, and StandardReport. These generic tables include all possible dimensions and metrics for the given report type but not all combinations of dimensions or metrics are valid in DCM. Therefore, 'SELECT *' queries to these tables are not permitted normally. Instead, you have several options of pulling data from these tables:

  1. Ad-hoc reporting is available by running a query selecting any valid combination of dimensions or metrics from the table. For example:
    SELECT Campaign, CampaignId, Impressions, Clicks, ClickRate, TotalConversions FROM StandardReport

    This query involves a multi-step process. First, the report definition is created in DCM and the processing is started. Note that DCM reports can take a very long time to process especially if you have a large volume of data. Once the processing is finished, the report is downloaded and output by the provider. Finally, the report definition is deleted from DCM.

  2. You can supply a ReportID in the filter for the query to run an existing report. This query allows for 'SELECT *' but note that only the fields that are actually included in the report will be populated with data with the rest returning NULL. For example:
    SELECT * FROM StandardReport WHERE ReportID='123456789'

    The report is executed in real time so note that DCM reports can take a very long time to process especially if you have a large volume of data. The report definition is not deleted in this case.

  3. You can supply both a ReportID and a FileID in the filter to download a previously run report. This query allows for 'SELECT *' but note that only the fields that are actually included in the report will be populated with data with the rest returning NULL. For example:
    SELECT * FROM StandardReport WHERE ReportID='123456789' AND FileID='987654321'

    Since the report has already been executed in this case, results will return immediately. The RunReport and CheckReportStatus stored procedures along with this method of querying can be used for asynchronous processing of the report in your application.

Existing DCM Reports

The provider also offers the CreateCustomSchema stored procedure for creating new table definitions for your existing reports in DCM. The stored procedure takes a table name, the report ID, and an output folder as inputs. Calling it will create a new schema file that you can query like any other table. You will need to set the Location connection property to the folder containing the new script files in order to access them after they are created. For example:

EXEC CreateCustomSchema TableName='MyCustomReport', ReportID='123456789', OutputFolder='C:\Users\Administrator\Desktop'

Customizing the SSL Configuration

By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Troubleshooting the Connection

To show provider activity from query execution to network traffic, use Logfile and Verbosity. The examples of common connection errors below show how to use these properties to get more context. Contact the support team for help tracing the source of an error or circumventing a performance issue.

  • Authentication errors: Typically, recording a Logfile at Verbosity 4 is necessary to get full details on an authentication error.
  • Queries time out: A server that takes too long to respond will exceed the provider's client-side timeout. Often, setting the Timeout property to a higher value will avoid a connection error. Another option is to disable the timeout by setting the property to 0. Setting Verbosity to 2 will show where the time is being spent.
  • The certificate presented by the server cannot be validated: This error indicates that the provider cannot validate the server's certificate through the chain of trust. If you are using a self-signed certificate, there is only one certificate in the chain.

    To resolve this error, you must verify yourself that the certificate can be trusted and specify to the provider that you trust the certificate. One way you can specify that you trust a certificate is to add the certificate to the trusted system store; another is to set SSLServerCert.