Skip to Content

Google Ad Manager Connection Details

Introduction

Connector Version

This documentation is based on version 21.0.8662 of the connector.

Get Started

Google Ad Manager Version Support

Establish a Connection

Connect to Google Ad Manager

Provide the following connection properties before adding the authentication properties.

  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

Authenticate to Google Ad Manager

All connections to Google Ad Manager are authenticated using OAuth. The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

Authenticate with a User Account

AuthScheme must be set to OAuth in all of the user account flows.

For desktop applications, the connector's default application is the simplest way to authenticate. The only additional requirement is to set InitiateOAuth to GETANDREFRESH.

When the driver starts, it will open a browser and Google Ad Manager will request your login information. The connector will use the credentials you provide to access your Google Ad Manager data. These credentials will be saved and automatically refreshed as needed.

See Using OAuth Authentication for a authentication guide covering all the supported methods in detail.

Authenticate with a Service Account

To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate.

For a JSON file, you will need to set these properties:

  • AuthScheme: Required. Set this to OAuthJWT.
  • InitiateOAuth: Required. Set this to GETANDREFRESH.
  • OAuthJWTCertType: Required. Set this to GOOGLEJSON.
  • OAuthJWTCert: Required. Set this to the path to the .json file provided by Google.
  • OAuthJWTSubject: Optional. Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, you will need to set these properties instead:

  • AuthScheme: Required. Set this to OAuthJWT.
  • InitiateOAuth: Required. Set this to GETANDREFRESH.
  • OAuthJWTCertType: Required. Set this to PFXFILE.
  • OAuthJWTCert: Required. Set this to the path to the .pfx file provided by Google.
  • OAuthJWTCertPassword: Optional. Set this to the .pfx file password. In most cases this will need to be provided since Google encrypts PFX certificates.
  • OAuthJWTCertSubject: Optional. Set this only if you are using a OAuthJWTCertType which stores multiple certificates. Should not be set for PFX certificates generated by Google.
  • OAuthJWTIssuer: Required. Set this to the email address of the service account. This address will usually include the domain iam.gserviceaccount.com.
  • OAuthJWTSubject: Optional. Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

If you do not already have a service account, you can create one by following the procedure in Creating a Custom OAuth App.

Authenticate with a GCP Instance Account

When running on a GCP virtual machine, the connector can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Use OAuth Authentication

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

Use a User Account to Authenticate to Google Ad Manager

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

Embedded Credentials

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

Custom Credentials

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

When to Create a Custom OAuth App

Creating a custom OAuth app is optional as the connector is already registered with Google Ad 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 Ad Manager OAuth endpoint to grant permissions to the connector.

Use a Service Account to Connect to Google Ad Manager

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 connector.

You need to create an OAuth application in this flow. You can then connect to Google Ad Manager data that the service account has permission to access. See Custom Credentials for an authentication guide.

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector 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 optional as the connector is already registered with Google Ad 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 Ad Manager OAuth endpoint to grant permissions to the connector.

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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector 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.
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 connector.

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 Ad 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.
  • 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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

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

  1. Creates and signs the JWT with the claim set required by the connector.
  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

Use OAuth on a Headless Machine

The following sections show how to authenticate a headless server or another machine on which the connector 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 connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the connector's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Use 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 Ad Manager OAuth endpoint in your browser.
  2. Log in and grant permissions to the connector. 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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

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 connector to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

Transfer OAuth Settings

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

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

  • OAuthSettingsLocation: Set this to a writable text file.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

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 connector to enable the automatic refreshing of the access token.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.
Use 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 connector's embedded OAuth credentials. You might want to create a custom OAuth app to change the information displayed when users log into Google Ad Manager to grant permissions to the connector.

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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

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 connector. 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:

  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • 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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

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

  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

Transfer OAuth Settings

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

On a second machine, install the connector 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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

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.
  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.
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 connector.

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 Ad 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.
  • 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.
  • NetworkCode: Set the NetworkCode connection property to the network code displayed in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

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

  1. Creates and signs the JWT with the claim set required by the connector.
  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.

Create a Custom OAuth App

When to Create a Custom OAuth App
User Account Authentication

Creating a custom OAuth app is optional as the connector is already registered with Google Ad 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 Ad Manager OAuth endpoint to grant permissions to the connector.

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.

After creating the app, the OAuthClientId and OAuthClientSecret are displayed.

Configure Your DFP Network

Follow the steps below to authorize the application; if you are a third-party developer, you may need to have your client perform these steps for you.

  1. Go to your DoubleClickFP for Publishers network.
  2. Click the Admin tab.
  3. Ensure that API access is enabled.
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.

Configure Your DFP Network

If you are a third-party developer, you may need to have your client do this step for you.

  1. Go to your DoubleClickFP for Publishers network.
  2. Click the Admin tab.
  3. Ensure that API access is enabled.

Follow the steps below to authorize the app; you are then ready to follow the authentication guide.

  1. Click the Add a Service Account User button.
  2. Fill in the form using the service account email.
  3. Click the Save button. A message appears confirming the addition of your service account.
  4. View existing service account users by going to the Users tab and then clicking the Service Account filter.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Google Ad Manager connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

User Defined Views

The Jitterbit Connector for Google Ads Manager allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector 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.

Data Model

The Jitterbit Connector for Google Ads Manager models Google Ad Manager objects as relational tables and views. A Google Ad Manager object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Google Ad Manager APIs.

Schemas for most database objects are defined in simple, text-based configuration files. However, schemas for Saved Query Reports are dynamically obtained.

Accessing Saved Query Reports

When you connect, the connector retrieves the list of reports and the metadata for the tables by calling the appropriate web services. Any changes you make to the Saved Query Reports, such as adding a new report, adding new fields, or changing the data type of a field, will immediately be reflected when you connect using the connector.

The connector offloads as much of the SELECT statement processing as possible to the Google Ad Manager APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Inserting custom fields

When executing an Insert statement and you've specified a custom field, the value of the custom field must be an aggregate. The aggregate must contain the ID of the custom field and the value that you want to give it. You can get custom fields' IDs by querying CustomFields table. Currently, only custom fields of type "Text" are supported for Insert. Other types are not insertable/updatable.

Below is an example of inserting into Orders table while specifying the "MyOwnCustomField" custom field. The ID of the custom field is 1238676 and its value is "Sample text here".

INSERT INTO Orders (Name, Notes, AdvertiserId, TraffickerId, CreatorId, Status, MyOwnCustomField) VALUES ('T-Shirt', 'Note description', '7412504329', '452586926', '9521226', 'DRAFT', '<customFieldId> 1238676 </customFieldId><value xsi:type="TextValue"><value> Sample text here </value></value>')

Tables

The connector models the data in Google Ad Manager into a list of tables that can be queried using standard SQL statements.

Generally, querying Google Ad Manager tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Jitterbit Connector for Google Ads Manager Tables

Name Description
Companies Create, update, and query DoubleClick for Publishers Companies.
Contacts Create, update, and query DoubleClick for Publishers Contacts.
Creatives Update and query DoubleClick for Publishers Creatives.
CustomFields Create, update, and query DoubleClick for Publishers Custom Fields.
CustomTargetingKeys Create, update, and query DoubleClick for Publishers Custom Targeting Keys.
Inventories Create, update, and query DoubleClick for Publishers Inventories.
Labels Create, update, delete, and query DoubleClick for Publishers Labels.
LineItemCreativeAssociations Query DoubleClick for Publishers LineItemCreativeAssociations.
LineItems Create, update, delete, and query DoubleClick for Publishers Line Items.
MobileApplications Create and query DoubleClick for Publishers Mobile Applications.
Orders Create, update, delete, and query DoubleClick for Publishers Orders.
Placements Create, update, delete, and query DoubleClick for Publishers Placements.
ProposalLineItems Create, update, and query DoubleClick for Publishers ProposalLineItems.
Proposals Create, update, and query DoubleClick for Publishers Proposals.
Users Create, update, delete, and query DoubleClick for Publishers Users.

Companies

Create, update, and query DoubleClick for Publishers Companies.

Select

The following queries are processed server side. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Companies. For example:

SELECT * FROM [Companies]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Companies] WHERE ID = '4410125029'
Insert

To create a new Company, the Name and Type fields are required.

INSERT INTO [Companies] (Name, Type) VALUES ('CompName', 'ADVERTISER')
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [Companies] SET Name = 'New CompName' WHERE ID = '4410125029'
Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True Uniquely identifies the Company. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
Name String False The full name of the company. This attribute is required and has a maximum length of 127 characters.
Type String False Specifies what kind of company this is. This attribute is required. The allowed values are ADVERTISER, HOUSE_ADVERTISER, HOUSE_AGENCY, AGENCY, AD_NETWORK, AFFILIATE_DISTRIBUTION_PARTNER, CONTENT_PARTNER, UNKNOWN.
CreditStatus String True Specifies the company's credit status. This attribute is optional and defaults to CreditStatus.ACTIVE when basic credit status settings are enabled, and CreditStatus.ON_HOLD when advanced credit status settings are enabled.
LastModifiedDateTime Datetime True The date and time this company was last modified.

Contacts

Create, update, and query DoubleClick for Publishers Contacts.

Select

The following queries are processed server side. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Contacts. For example:

SELECT * FROM [Contacts]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Contacts] WHERE ID = '4940864'
Insert

To create a new Contact, the Name, CompanyId, and Email fields are required.

INSERT INTO [Contacts] (Name, CompanyId, Email) VALUES ('Cont', '4415064655', 'cont@email.com')
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [Contacts] SET Name = 'New Contact', Email = 'email@yahoo.com' WHERE ID = '4944377'
Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True The unique ID of the Contact. This value is readonly and is assigned by Google.
Name String False The name of the contact. This attribute is required and has a maximum length of 127 characters.
CompanyId Long False The ID of the Company that this contact is associated with. This attribute is required and immutable.
Status String False The status of the contact. This attribute is readonly and is assigned by Google.
Email String False The e-mail address where the contact can be reached. This attribute is optional.
Address String False The address of the contact. This attribute is optional and has a maximum length of 1024 characters.
CellPhone String False The cell phone number where the contact can be reached. This attribute is optional.
Comment String False A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters.
FaxPhone String False The fax number where the contact can be reached. This attribute is optional.
Title String False The job title of the contact. This attribute is optional and has a maximum length of 1024 characters.
WorkPhone String False The work phone number where the contact can be reached. This attribute is optional.

Creatives

Update and query DoubleClick for Publishers Creatives.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Creatives. For example:

SELECT * FROM [Creatives]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Creatives] WHERE ID = '138206791680'
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [Creatives] SET Name = 'Updated creative' WHERE ID = '138206791680'
Insert

The insert operation is not supported for this table.

Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
Name String False The name of the creative. This attribute is required and has a maximum length of 255 characters.
CompanyId Long False The ID of the advertiser that owns the creative. This attribute is required.
Width Integer False The width of the Creative.
Height Integer False The height of the Creative.
PreviewUrl String True The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
DestinationUrl String False The URL the user is directed to if they click on the creative. This attribute is only required if the template snippet contains the %u or %%DEST_URL%% macro. It has a maximum length of 1024 characters
LastModifiedDateTime Datetime True The date and time this creative was last modified.
Snippet String True The HTML snippet that this creative delivers. This attribute is required.
ExpandedSnippet String True The HTML snippet that this creative delivers with macros expanded. This attribute is read-only and is set by Google.
SslScanResult String True The SSL compatibility scan result for this creative.
LockedOrientation String True A locked orientation for this creative to be displayed in.
OverrideSize Boolean True Allows the creative size to differ from the actual HTML5 asset size. This attribute is optional. thirdPartyImpressionTrackingUrls.
IsSafeFrameCompatible Boolean True Whether the Creative is compatible for SafeFrame rendering.
PrimaryImageId Long True Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
PrimaryImageName String True The name of the creative. This attribute is required and has a maximum length of 255 characters.
PrimaryImageSize Long True Primary image size
PrimaryImageUrl String True Primary image URL
CustomFieldName String True This is the name of the custom field. There will be as many custom columns as custom fields are related to Creatives.

CustomFields

Create, update, and query DoubleClick for Publishers Custom Fields.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory .

Retrieve a list of CustomFields. For example:

SELECT * FROM [CustomFields]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [CustomFields] WHERE ID = '1238676'
Insert

To create a new CustomField, the Name, EntityType, DataType, and Visibility fields are required.

INSERT INTO [CustomFields] (Name, EntityType, DataType, Visibility) VALUES ('ASEF', 'LINE_ITEM', 'STRING', 'FULL')
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [CustomFields] SET Description = 'New Description' WHERE ID = '1238676'
Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True Unique ID of the CustomField. This value is readonly and is assigned by Google.
Name String False Name of the CustomField. This is value is required to create a custom field. The max length is 127 characters.
Description String False A description of the custom field. This value is optional. The maximum length is 511 characters
IsActive Boolean True Specifies whether or not the custom fields is active. This attribute is read-only.
EntityType String False The type of entity that this custom field is associated with. This attribute is read-only if there exists a CustomFieldValue for this field. The allowed values are LINE_ITEM, ORDER, CREATIVE, PRODUCT_TEMPLATE, PRODUCT, PROPOSAL, PROPOSAL_LINE_ITEM, USER, UNKNOWN.
DataType String False The type of data this custom field contains. This attribute is read-only if there exists a CustomFieldValue for this field. The allowed values are STRING, NUMBER, TOGGLE, DROP_DOWN, UNKNOWN.
Visibility String False How visible/accessible this field is in the UI. The allowed values are API_ONLY, READ_ONLY, FULL.

CustomTargetingKeys

Create, update, and query DoubleClick for Publishers Custom Targeting Keys.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of CustomFields. For example:

SELECT * FROM [CustomTargetingKeys]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [CustomTargetingKeys] WHERE ID = '10721398'
Insert

To create a new CustomTargetingKey, the Name, DisplayName, and Type fields are required.

INSERT INTO [CustomTargetingKeys] (Name, DisplayName, Type) VALUES ('tg_key', 'targeting key', 'PREDEFINED')
Update

You can update any field not marked as read-only (except Name column that can only be inserted), by specifying the ID column.

UPDATE [CustomTargetingKeys] SET DisplayName = 'targeting key (Deprecated)' WHERE ID = '10721398'
Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True The ID of the CustomTargetingKey. This value is readonly and is populated by Google.
Name String False Name of the key. This can be used for encoding . If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values. For example, you can create key/value g1=abc to represent gender=female. Keys can contain up to 10 characters each.
DisplayName String False Descriptive name for the key.
Type String False Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item. The allowed values are PREDEFINED, FREEFORM.
Status String True Status of the CustomTargetingKey. This field is read-only. A key can be activated and deactivated by calling CustomTargetingService.performCustomTargetingKeyAction.

Inventories

Create, update, and query DoubleClick for Publishers Inventories.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Inventories. For example:

SELECT * FROM [Inventories]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Inventories] WHERE ID = '21619885919'
Insert

To create a new Inventory, the ParentId and Name fields are required. Additionally, you can also set Description and TargetWindow.

INSERT INTO [Inventories] (ParentId, Name, Description, TargetWindow) VALUES ('45429123', 'Ad_Unit_122', 'Ad unit description.', 'BLANK')
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [Inventories] SET Name = 'NewAdUnitName' WHERE ID = '45429003'
Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True Uniquely identifies the AdUnit. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
ParentId Long False The ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.
HasChildren Boolean True This field is set to true if the ad unit has any children. This attribute is read-only and is populated by Google.
Name String False The name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
Status String True The status of this ad unit. It defaults to InventoryStatus.ACTIVE. This value cannot be updated directly using InventoryService.updateAdUnit. It can only be modified by performing actions via InventoryService.performAdUnitAction.
AdUnitCode String True A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its adUnitCode cannot be changed.
Description String False A description of the ad unit. This value is optional and its maximum length is 65,535 characters.
TargetWindow String False The value to use for the HTML link's target attribute. This value is optional and will be interpreted as TargetWindow.TOP if left blank. The allowed values are TOP, BLANK.
ExplicitlyTargeted Boolean True If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for DFP Premium accounts.
SmartSizeMode String True The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes.
LastModifiedDateTime Datetime True The date and time this ad unit was last modified.
IsSetTopBoxEnabled Boolean True Flag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
IsInterstitial Boolean False Flag that specifies whether this ad unit is interstitial or not.
IsNative Boolean False Flag that specifies whether this ad unit is native or not.
IsFluid Boolean False Flag that specifies whether this ad unit is fluid or not.
ApplicationId Long False The MobileApplication.applicationId for the CTV application that this ad unit is within. This attribute is optional.

Labels

Create, update, delete, and query DoubleClick for Publishers Labels.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Labels. For example:

SELECT * FROM [Labels]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Labels] WHERE ID = '370450571'
Insert

To create a new Label, the Name and Types fields are required.

INSERT INTO [Labels] (Name, Types) VALUES ('new lbl', 'COMPETITIVE_EXCLUSION')
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [Labels] SET Description = 'New Description', Name = 'New updated lbl name' WHERE ID = '370341705'
Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True Unique ID of the Label. This value is readonly and is assigned by Google.
Name String False Name of the Label. This is value is required to create a label and has a maximum length of 127 characters.
Description String False A description of the label. This value is optional and its maximum length is 255 characters.
IsActive Boolean True Specifies whether or not the label is active. This attribute is read-only.
Types String False The types of the Label. The allowed values are COMPETITIVE_EXCLUSION, AD_UNIT_FREQUENCY_CAP, AD_EXCLUSION, CREATIVE_WRAPPER, UNKNOWN.

LineItemCreativeAssociations

Query DoubleClick for Publishers LineItemCreativeAssociations.

Columns
Name Type ReadOnly Description
LineItemId Long False The ID of the LineItem to which the Creative should be associated. This attribute is required.
CreativeId Long False The ID of the Creative being associated with a LineItem. This attribute is required if this is an association between a line item and a creative. This attribute is ignored if this is an association between a line item and a creative set. If this is an association between a line item and a creative, when retrieving the line item creative association, the creativeId will be the creative's ID. If this is an association between a line item and a creative set, when retrieving the line item creative association, the creativeId will be the ID of the master creative.
CreativeSetId Long False The ID of the CreativeSet being associated with a LineItem. This attribute is required if this is an association between a line item and a creative set. This field will be null when retrieving associations between line items and creatives not belonging to a set.
ManualCreativeRotationWeight Double False The weight of the Creative. This value is only used if the line item's creativeRotationType is set to CreativeRotationType.MANUAL. This attribute is optional and defaults to 10.
SequentialCreativeRotationIndex Int False The sequential rotation index of the Creative. This value is used only if the associated line item's LineItem.creativeRotationType is set to CreativeRotationType.SEQUENTIAL. This attribute is optional and defaults to 1.
StartDateTime Datetime False Overrides the value set for LineItem.startDateTime. This value is optional and is only valid for Ad Manager 360 networks.
StartDateTimeType String False Specifies whether to start serving to the LineItemCreativeAssociation right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME. The allowed values are USE_START_DATE_TIME, IMMEDIATELY, ONE_HOUR_FROM_NOW, UNKNOWN.
EndDateTime Datetime False Overrides LineItem.endDateTime. This value is optional and is only valid for Ad Manager 360 networks.
DestinationUrl String False Overrides the value set for HasDestinationUrlCreative.destinationUrl. This value is optional and is only valid for Ad Manager 360 networks.
Sizes String False Overrides the value set for Creative.size, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.
Status String True The status of the association. This attribute is read-only.
Stats String True Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for the association yet.
LastModifiedDateTime Datetime False The date and time this association was last modified.
TargetingName String False Specifies CreativeTargeting for this line item creative association. This attribute is optional. It should match the creative targeting specified on the corresponding CreativePlaceholder in the LineItem that is being associated with the Creative.

LineItems

Create, update, delete, and query DoubleClick for Publishers Line Items.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of LineItems. For example:

SELECT * FROM [LineItems]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [LineItems] WHERE ID = '4377540922'
Insert

To create a new LineItem, the following fields are required: OrderId, Name, StartDateTimeType, EndDateTime, EndTimeZoneId, CreativeRotationType, LineItemType, CurrencyCode, MicroAmount, CostType, CreativePlaceholdersAggregate, AllowOverbook, GoalType, GoalUnitType, GoalUnits, GeoTargetingAggregate, and InventoryTargetingAggregate.

INSERT INTO [LineItems] (OrderId, Name, StartDateTimeType, EndDateTime, EndTimeZoneId, CreativeRotationType, LineItemType, CurrencyCode, MicroAmount, CostType, CreativePlaceholdersAggregate, AllowOverbook, GoalType, GoalUnitType, GoalUnits, GeoTargetingAggregate, InventoryTargetingAggregate) VALUES ('2108997295', 'line item 233', 'IMMEDIATELY', '2017-09-01', 'America/New_York', 'EVEN', 'STANDARD', 'USD', '200000', 'CPM', '<size><width>1</width><height>1</height><isAspectRatio>false</isAspectRatio></size><creativeTemplateId>10004520</creativeTemplateId><expectedCreativeCount>1</expectedCreativeCount><creativeSizeType>NATIVE</creativeSizeType>', 'true', 'LIFETIME', 'IMPRESSIONS', '500000', '<geoTargeting><targetedLocations><id>2840</id><type>COUNTRY</type><displayName>United States</displayName></targetedLocations><targetedLocations><id>20123</id><type>PROVINCE</type><canonicalParentId>2124</canonicalParentId><displayName>Quebec</displayName></targetedLocations><excludedLocations><id>1016367</id><type>CITY</type><canonicalParentId>21147</canonicalParentId><displayName>Chicago</displayName></excludedLocations><excludedLocations><id>200501</id><type>DMA_REGION</type><canonicalParentId>2840</canonicalParentId><displayName>New York NY</displayName></excludedLocations></geoTargeting>', '<inventoryTargeting><targetedPlacementIds>28544791</targetedPlacementIds></inventoryTargeting>')
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [LineItems] SET DeliveryRateType = 'EVENLY' WHERE ID = '4377540922'
Delete

You can delete a LineItem row by specifying the ID column.

DELETE FROM [LineItems] WHERE ID = '4377865094'
Columns
Name Type ReadOnly Description
Id [KEY] Long True Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created.
ExternalId Long True An identifier for the LineItem that is meaningful to the publisher.
Name String False The name of the line item. This attribute is required and has a maximum length of 255 characters.
OrderId Long False The ID of the Order to which the LineItem belongs. This attribute is required.
OrderName String True The name of the Order. This value is read-only.
StartDateTime Datetime False The date and time on which the LineItem is enabled to begin serving. This attribute is required unless LineItem.StartDateTimeType is set to IMMEDIATELY or ONE_HOUR_FROM_NOW.
StartTimeZoneId String False The start date time timezone ID of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles).
StartDateTimeType String False Specifies whether to start serving to the LineItem right away, in an hour, etc. The allowed values are USE_START_DATE_TIME, IMMEDIATELY, ONE_HOUR_FROM_NOW, UNKNOWN.
EndDateTime Datetime False The date and time on which the LineItem will stop serving. This attribute is required unless LineItem.unlimitedEndDateTime is set to true. If specified, it must be after the LineItem.startDateTime. This end date and time does not include auto extension days.
EndTimeZoneId String False The end date time timezone ID of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles).
AutoExtensionDays Integer True The number of days to allow a line item to deliver past its endDateTime. A maximum of 7 days is allowed. This is a premium feature available for LineItemType.STANDARD line items.
UnlimitedEndDateTime Boolean True Specifies whether or not the LineItem has an end time. This attribute is optional and defaults to false. It can be be set to true for only line items of type LineItemType.SPONSORSHIP, LineItemType.NETWORK, LineItemType.PRICE_PRIORITY and LineItemType.HOUSE.
CreativeRotationType String False The strategy used for displaying multiple Creative objects that are associated with the LineItem. This attribute is required. The allowed values are EVEN, OPTIMIZED, MANUAL, SEQUENTIAL.
DeliveryRateType String False The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY or DeliveryRateType.FRONTLOADED depending on the network's configuration. The allowed values are EVENLY, FRONTLOADED, AS_FAST_AS_POSSIBLE.
RoadblockingType String True The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional and defaults to RoadblockingType.ONE_OR_MORE.
LineItemType String False Indicates the line item type of a LineItem. This attribute is required. The allowed values are SPONSORSHIP, STANDARD, NETWORK, BULK, PRICE_PRIORITY, HOUSE, LEGACY_DFP, CLICK_TRACKING, ADSENSE, AD_EXCHANGE, BUMPER, ADMOB, UNKNOWN.
CurrencyCode String False Three letter currency code in string format.
MicroAmount Long False Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
CostType String False The method used for billing this LineItem. This attribute is required. The allowed values are CPA, CPC, CPD, CPM, UNKNOWN, VCPM.
Priority Integer True The priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the LineItemType.
CreativePlaceholdersAggregate String False Details about the creatives that are expected to serve through this LineItem. This attribute is required and replaces the creativeSizes attribute.
DiscountType String True The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to LineItemDiscountType.PERCENTAGE.
Discount Double True The number here is either a percentage or an absolute value depending on the LineItemDiscountType. If the LineItemDiscountType is LineItemDiscountType.PERCENTAGE, then only non-fractional values are supported.
ContractedUnitsBought Integer True This attribute is only applicable for certain line item types and acts as an FYI or note, which does not impact adserving or other backend systems.
EnvironmentType String True The environment that the LineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
CompanionDeliveryOption String True The delivery option for companions
CreativePersistenceType String True Specifies options to prevent ads from replacing or appearing with this LineItem.
AllowOverbook Boolean False The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types LineItemType.SPONSORSHIP and LineItemType.STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false.
SkipInventoryCheck Boolean True The flag indicates whether the inventory check should be skipped when performing an action on this line item. The default value is false.
SkipCrossSellingRuleWarningChecks Boolean True True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false.
ReserveAtCreation Boolean True The flag indicates whether inventory should be reserved when creating a line item of types LineItemType.SPONSORSHIP and LineItemType.STANDARD in an unapproved Order. The default value is false.
Status String True The status of the LineItem. This attribute is readonly.
ReservationStatus String True Describes whether or not inventory has been reserved for the LineItem. This attribute is readonly and is assigned by Google.
IsArchived Boolean True The archival status of the LineItem. This attribute is readonly.
DisableSameAdvertiserCompetitiveExclusion Boolean True If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
LastModifiedByApp String True The application that last modified this line item. This attribute is read only and is assigned by Google.
Notes String True Provides any additional notes that may annotate the LineItem. This attribute is optional and has a maximum length of 65,535 characters.
LastModifiedDateTime Datetime True The date and time this line item was last modified.
CreationDateTime Datetime True This attribute may be null for line items created before this feature was introduced.
IsPrioritizedPreferredDealsEnabled Boolean True Whether an AdExchange line item has prioritized preferred deals enabled. This attribute is optional and defaults to false.
AdExchangeAuctionOpeningPriority Integer True The priority at which an Ad Exchange line item enters the open Ad Exchange auction if the preferred deal fails to transact. This attribute is optional. If prioritized preferred deals are enabled, it defaults to 12. Otherwise, it is ignored.
IsSetTopBoxEnabled Boolean True Flag that specifies whether this LineItem is a set-top box enabled line item. Set-top box line items only support the following creative sizes: 1920x1080 and 640x480.
IsMissingCreatives Boolean True Indicates if a LineItem is missing any creatives for the creativePlaceholders specified.
VideoMaxDuration Integer True The max duration of a video creative associated with this LineItem in milliseconds. This attribute is optional, defaults to 0, and only meaningful if this is a video line item.
GoalType String False The type of the goal for the LineItem. It defines the period over which the goal for LineItem should be reached. The allowed values are NONE, LIFETIME, DAILY, UNKNOWN.
GoalUnitType String False The type of the goal unit for the LineItem. The allowed values are IMPRESSIONS, CLICKS, CLICK_THROUGH_CPA_CONVERSIONS, VIEW_THROUGH_CPA_CONVERSIONS, TOTAL_CPA_CONVERSIONS, UNKNOWN, VIEWABLE_IMPRESSIONS.
GoalUnits Integer False If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the LineItem.
GeoTargetingAggregate String False Specifies what geographical locations are targeted by the LineItem. This attribute is optional.
InventoryTargetingAggregate String False Specifies what inventory is targeted by the LineItem. This attribute is required. The line item must target at least one ad unit or placement.
CustomFieldName String True This is the name of the custom field. There will be as many custom columns as custom fields are related to LineItems.

MobileApplications

Create and query DoubleClick for Publishers Mobile Applications.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of MobileApplications. For example:

SELECT * FROM [MobileApplications]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [MobileApplications] WHERE ID = '370450571'
Insert

To create a new MobileApplication, the DisplayName, AppStoreId, and AppStore fields are required.

INSERT INTO [MobileApplications] (DisplayName, AppStoreId, AppStore) VALUES ('Netflix', 'com.netflix.mediaclient', 'GOOGLE_PLAY')
Update

The update operation is not supported for this table.

Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True Uniquely identifies the mobile application. This attribute is read-only and is assigned by Google when a mobile application is claimed.
DisplayName String False The display name of the mobile application. This attribute is required and has a maximum length of 255 characters.
AppStoreId String False The app store ID of the app to claim. This attribute is required for creation and then is read-only.
AppStore String False The app store the mobile application belongs to. This attribute is required for creation and then is read-only. The allowed values are GOOGLE_PLAY, APPLE_ITUNES, UNKNOWN.
IsArchived Boolean True The archival status of the mobile application. This attribute is read-only.
AppStoreName String True The name of the application on the app store. This attribute is read-only and populated by Google.
DeveloperName String True The name of the developer of the mobile application. This attribute is read-only and populated by Google.
Platform String True The platform the mobile application runs on. This attribute is read-only and populated by Google.
IsFree Boolean True Whether the mobile application is free on the app store it belongs to. This attribute is read-only and populated by Google.
DownloadUrl String True The download URL of the mobile application on the app store it belongs to. This attribute is read-only and populated by Google.

Orders

Create, update, delete, and query DoubleClick for Publishers Orders.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Orders. For example:

SELECT * FROM [ Orders ]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Orders] WHERE ID = '2112977260'
Insert

To create a new Order, the Name, AdvertiserId, TraffickerId, and CreatorId fields are required.

INSERT INTO [Orders] (Name, AdvertiserId, TraffickerId, CreatorId) VALUES ('Ord313', '4410125029', '244525926' ,'244525926')
Update

You can update the Notes of an Order row by specifying the ID column.

UPDATE [Orders] SET Notes = 'Updated notes22222' WHERE ID = '2112977260'
Delete

You can delete an Order row by specifying the ID column.

DELETE FROM [Orders] WHERE ID = '2108997295'
Columns
Name Type ReadOnly Description
Id [KEY] Long False The unique ID of the Order. This value is readonly and is assigned by Google.
Name String False The name of the Order. This value is required to create an order and has a maximum length of 255 characters.
Status String False The status of the Order. This attribute is read-only.
StartDateTime Datetime True The date and time at which the Order and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest LineItem.startDateTime.
EndDateTime Datetime True The date and time at which the Order and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest LineItem.endDateTime.
UnlimitedEndDateTime Boolean False Specifies whether or not the Order has an unlimited end date. This attribute is readonly and is true if any of the order's line items has LineItem.unlimitedEndDateTime set to true.
IsArchived Boolean False The archival status of the Order. This attribute is readonly.
ExternalOrderId Long False An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional.
CurrencyCode String False Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters.
AdvertiserId Long False The unique ID of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. This attribute is required.
AdvertiserContactIds Long False List of IDs for advertiser contacts of the order.
AgencyId Long False The unique ID of the Company, which is of type Company.Type.AGENCY, with which this order is associated. This attribute is optional.
CreatorId Long False The unique ID of the User who created the Order on behalf of the advertiser. This value is readonly and is assigned by Google.
TraffickerId Long False The unique ID of the User responsible for trafficking the Order. This value is required for creating an order
Notes String False Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters.
TotalImpressionsDelivered Long False Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google.
TotalClicksDelivered Long False Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google.
TotalViewableImpressionsDelivered Long False Total viewable impressions delivered for all line items of this Order. This value is read-only and is assigned by Google. Starting in v201705, this will be null when the order does not have line items trafficked against a viewable impressions goal.
TotalBudget Integer False Total budget for all line items of this Order. This value is a readonly field assigned by Google and is calculated from the associated LineItem.costPerUnit values.
LastModifiedByApp String False The application which modified this order. This attribute is read only and is assigned by Google.
IsProgrammatic Boolean False Specifies whether or not the Order is a programmatic order. This value is optional and defaults to false.
LastModifiedDateTime Datetime True The date and time this order was last modified.
CustomFieldName String True This is the name of the custom field. There will be as many custom columns as custom fields are related to Orders.

Placements

Create, update, delete, and query DoubleClick for Publishers Placements.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Placements. For example:

SELECT * FROM [Placements]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Placements] WHERE ID = '28544791'
Insert

To create a new Placement, the Name, Description, and TargetedAdUnitIds fields are required.

INSERT INTO [Placements] (Name, Description, TargetedAdUnitIds ) VALUES ('placement', 'testtttttttt', '21622217303,21622217300')
Update

You can update any field not marked as read-only by specifying the ID column.

UPDATE [Placements] SET Name = 'New Placement', Description = 'New Description' WHERE ID = '28544791'
Delete

The delete operation is not supported for this table.

Columns
Name Type ReadOnly Description
Id [KEY] Long True Uniquely identifies the Placement. This attribute is read-only and is assigned by Google when a placement is created.
Name String False The name of the Placement. This value is required and has a maximum length of 255 characters.
Description String False A description of the Placement. This value is optional and its maximum length is 65,535 characters.
PlacementCode String True A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
Status String True The status of the Placement. This attribute is read-only.
IsAdSenseTargetingEnabled Boolean True Describes whether the Placement is available for site targeting by AdWords advertisers.
TargetedAdUnitIds String False The collection of AdUnit object IDs that constitute the Placement.
LastModifiedDateTime Datetime True The date and time this placement was last modified.

ProposalLineItems

Create, update, and query DoubleClick for Publishers ProposalLineItems.

Columns
Name Type ReadOnly Description
Id [KEY] Long True The unique ID of the ProposalLineItem. This attribute is read-only.
ProposalId Long True The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly.
Name String False The name of the ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
StartDateTime Datetime False The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The DateTime.timeZoneID is required if start date time is not null. This attribute becomes readonly once the ProposalLineItem has started delivering.
EndDateTime Datetime False The date and time at which the line item associated with the ProposalLineItem stops being served. This attribute is optional during creation, but required and must be after the startDateTime. The DateTime.timeZoneID is required if end date time is not null.
TimeZoneId String False The time zone ID in tz database format (e.g. 'America/Los_Angeles') for this ProposalLineItem. The number of serving days is calculated in this time zone. So if rateType is RateType.CPD, it will affect the cost calculation. The startDateTime and endDateTime will be returned in this time zone. This attribute is optional and defaults to the network's time zone. This attribute is read-only when using programmatic guaranteed, using sales management, or when using programmatic guaranteed, not using sales management.
InternalNotes String False Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
IsArchived Boolean True The archival status of the ProposalLineItem. This attribute is read-only.
ContractedUnitsBought Long False The contracted number of impressions or clicks. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is false, then this represents the lifetime minimum impression. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is true, then this represents the daily minimum impression. This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only.
DeliveryRateType String False The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is optional and default value is DeliveryRateType.EVENLY. For a Preferred deal ProposalLineItem, the value can only be DeliveryRateType.FRONTLOADED. The allowed values are EVENLY, FRONTLOADED, AS_FAST_AS_POSSIBLE.
RoadblockingType String False The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONE_OR_MORE if not specified by the product. The allowed values are ONLY_ONE, ONE_OR_MORE, AS_MANY_AS_POSSIBLE, ALL_ROADBLOCK, CREATIVE_SET.
CompanionDeliveryOption String False The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error. The allowed values are OPTIONAL, AT_LEAST_ONE, ALL, UNKNOWN.
VideoMaxDuration Long False The max duration of a video creative associated with this ProposalLineItem in milliseconds. This attribute is optional, defaults to the Product.videoMaxDuration on the Product it was created with, and only meaningful if this is a video proposal line item.
VideoCreativeSkippableAdType String False The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType.NOT_SKIPPABLE. The allowed values are UNKNOWN, DISABLED, ENABLED, INSTREAM_SELECT, ANY.
DfpLineItemId Long True The unique ID of corresponding LineItem. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
LineItemType String False The corresponding LineItemType of the ProposalLineItem. For a programmatic ProposalLineItem, the value can only be one of: LineItemType.SPONSORSHIP, LineItemType.STANDARD, LineItemType.PREFERRED_DEAL The allowed values are SPONSORSHIP, STANDARD, NETWORK, BULK, PRICE_PRIORITY, HOUSE, LEGACY_DFP, CLICK_TRACKING, ADSENSE, AD_EXCHANGE, BUMPER, ADMOB, PREFERRED_DEAL, UNKNOWN.
LineItemPriority Int False The priority for the corresponding LineItem of the ProposalLineItem. This attribute is optional during creation and defaults to the product's priority, or a default value assigned by Google. See LineItem.priority for more information.
RateType String False The method used for billing the ProposalLineItem. The allowed values are CPM, CPC, CPD, CPU, FLAT_FEE, VCPM, CPM_IN_TARGET, UNKNOWN.
DisableSameAdvertiserCompetitiveExclusion Boolean False If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied. This attribute is optional and defaults to false.
IsSold Boolean True Indicates whether this ProposalLineItem has been sold. This attribute is read-only.
ComputedStatus String True The status of the LineItem generated from this proposal line item. This will be null if the proposal line item has not pushed to Ad Manager. This attribute is read-only.
LastModifiedDateTime Datetime True The date and time this ProposalLineItem was last modified. This attribute is assigned by Google when a ProposalLineItem is updated. This attribute is read-only.
ReservationStatus String True The reservation status of the ProposalLineItem. This attribute is read-only.
LastReservationDateTime Datetime True The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only.
EnvironmentType String False The environment that the ProposalLineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER. This field can only be changed if the linkStatus is LinkStatus.UNLINKED. Otherwise its value is read-only and set to Product.environmentType of the product this proposal line item was created from. The allowed values are BROWSER, VIDEO_PLAYER.
AllowedFormats String False The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats. The allowed values are AUDIO, UNKNOWN.
IsProgrammatic Boolean True Whether or not the Proposal for this ProposalLineItem is a programmatic deal. This attribute is populated from Proposal.isProgrammatic. This attribute is read-only.
AdditionalTerms String False Additional terms shown to the buyer in Marketplace.
ProgrammaticCreativeSource String False Indicates the ProgrammaticCreativeSource of the programmatic line item. The allowed values are PUBLISHER, ADVERTISER, UNKNOWN.
EstimatedMinimumImpressions Long False The estimated minimum impressions that should be delivered for a proposal line item.
HasMakegood Boolean True Whether this proposal line item has an associated makegood. This attribute is read-only.
CanCreateMakegood Boolean True Whether a new makegood associated with this line item can be created. This attribute is read-only.

Proposals

Create, update, and query DoubleClick for Publishers Proposals.

Columns
Name Type ReadOnly Description
Id [KEY] Long True The unique ID of the Proposal. This attribute is read-only.
IsProgrammatic Boolean False Flag that specifies whether this Proposal is for programmatic deals. This value is default to false.
DfpOrderId Long True The unique ID of corresponding Order. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
StartDateTime Datetime True The date and time at which the order and line items associated with the Proposal are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest ProposalLineItem.startDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only.
EndDateTime Datetime True The date and time at which the order and line items associated with the Proposal stop being served. This attribute is derived from the proposal line item of the proposal which has the latest ProposalLineItem.endDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only.
Name String False The name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.name when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
Status String True The status of the Proposal. This attribute is read-only.
IsArchived Boolean True The archival status of the Proposal. This attribute is read-only.
InternalNotes String False Provides any additional notes that may annotate the Proposal. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SalesPlannerIds Long True List of unique IDs of User objects who are the sales planners of the Proposal. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
PrimaryTraffickerId Long False The unique ID of the User who is primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.primaryTraffickerId . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SellerContactIds Long True users who are the seller's contacts. This attribute is applicable when using programmatic guaranteed, using sales management, or when using programmatic guaranteed, not using sales management, or when using preferred deals, not using sales management.
AppliedTeamIds Long True The IDs of all teams that the Proposal is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
CurrencyCode String False The currency code of this Proposal. This attribute is optional and defaults to network's currency code.
IsSold Boolean True Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is OrderStatus.APPROVED or OrderStatus.PAUSED. This attribute is read-only.
LastModifiedDateTime Datetime True The date and time this Proposal was last modified. This attribute is read-only.
HasBuyerRfp Boolean False Whether a Proposal contains a BuyerRfp field. If this field is true, it indicates that the Proposal in question orignated from a buyer. This attribute is applicable when using programmatic guaranteed, not using sales management, or when using preferred deals, not using sales management.
DeliveryPausingEnabled Boolean False Whether pausing is consented for the Proposal. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.

Users

Create, update, delete, and query DoubleClick for Publishers Users.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Users. For example:

SELECT * FROM [Users]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Users] WHERE ID = '244555723'
Insert

To create a new User, the Name, Email, and RoleId fields are required.

INSERT INTO [Users] (Name, Email, RoleId ) VALUES ('murat', 'email@gmail.com', '-1')
Update

You can update any column not marked as read-only by specifying the ID column.

UPDATE [Users] SET Name = 'New User' WHERE ID = '244555723'
Delete

You can delete a User row by specifying the ID column.

DELETE FROM [Users] WHERE ID = '244555723'
Columns
Name Type ReadOnly Description
Id [KEY] Long True The unique ID of the User. This attribute is readonly and is assigned by Google.
Name String False The name of the User. It has a maximum length of 128 characters.
Email String False The email or login of the User. In order to create a new user, you must already have a Google Account.
RoleId Long False The unique role ID of the User. Roles that are created by Google will have negative IDs.
RoleName String True The name of the role assigned to the User. This attribute is readonly.
IsActive Boolean True Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
IsEmailNotificationAllowed Boolean True Specifies whether or not the User wants to permit the Publisher Display Ads system to send email notifications to his or her email address. This attribute is optional and defaults to true.
IsServiceAccount Boolean True Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.

Jitterbit Connector for Google Ads Manager Views

Name Description
DeliveryReport Query DoubleClick for Publishers Delivery Reports.
InventoryReport Query DoubleClick for Publishers Inventory Reports.
Roles Query DoubleClick for Publishers Roles.
SalesReport Query DoubleClick for Publishers Sales Reports.

DeliveryReport

Query DoubleClick for Publishers Delivery Reports.

Select

Represents a report job that will be run to retrieve performance and statistics information about deliveries. By default, the report will retrieve data for the last month. Specify StartDate and EndDate to run the report on the desired time period. For example:

SELECT * FROM [DeliveryReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'
Columns
Name Type Description
OrderId String This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderName String This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerImpressions Long This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerClicks Long This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerCtr Double This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerCpmAndCpcRevenue Long This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerWithoutCpdAverageEcpm Double This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderTrafficker String This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderStartDateTime Datetime This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderEndDateTtime Datetime This column maps to the field of the same name in the DoubleClick for Publishers API.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
EndDate Date The end date of the custom date range. The end date cannot be later than today's date.
StartDate Date The start date of the custom date range. The start date must be earlier than or the same as the end date.
DateRangeType String The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE.

InventoryReport

Query DoubleClick for Publishers Inventory Reports.

Select

Represents a report job that will be run to retrieve performance and statistics information about inventories. By default, the report will retrieve data for the last month. Specify StartDate and EndDate to run the report on the desired time period. For example:

SELECT * FROM [InventoryReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'
Columns
Name Type Description
AdUnitId String This column maps to the field of the same name in the DoubleClick for Publishers API.
AdUnitName String This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerImpressions Long This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerClicks Long This column maps to the field of the same name in the DoubleClick for Publishers API.
DynamicAllocationInventoryLevelImpressions Long This column maps to the field of the same name in the DoubleClick for Publishers API.
DynamicAllocationInventoryLevelClicks Long This column maps to the field of the same name in the DoubleClick for Publishers API.
TotalInventoryLevelImpressions Long This column maps to the field of the same name in the DoubleClick for Publishers API.
TotalInventoryLevelCpmAndCpcRevenue Long This column maps to the field of the same name in the DoubleClick for Publishers API.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
EndDate Date The end date of the custom date range. The end date cannot be later than today's date.
StartDate Date The start date of the custom date range. The start date must be earlier than or the same as the end date.
DateRangeType String The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE

Roles

Query DoubleClick for Publishers Roles.

Select

The following queries are processed server side by the Google Ad Manager APIs. The connector processes other SELECT queries client-side in memory.

Retrieve a list of Roles. For example:

SELECT * FROM [Roles]

Additionally, you can specify the ID or filter by any other column.

SELECT * FROM [Roles] WHERE ID = '-28'
Columns
Name Type Description
Id [KEY] Long The unique ID of the role. This value is readonly and is assigned by Google. Roles that are created by Google will have negative IDs.
Name String The name of the role. This value is readonly and is assigned by Google.
Description String The description of the role. This value is readonly and is assigned by Google.
Status String The status of the Role. This field is read-only and can have the values RoleStatus.ACTIVE (default) or RoleStatus.INACTIVE, which determines the visibility of the role in the UI.

SalesReport

Query DoubleClick for Publishers Sales Reports.

Select

Represents a report job that will be run to retrieve performance and statistics information about sales. By default, the report will retrieve data for the last month. Specify StartDate and EndDate to run the report on the desired time period. For example:

SELECT * FROM [SalesReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'
Columns
Name Type Description
SalesPersonId String This column maps to the field of the same name in the DoubleClick for Publishers API.
SalesPersonName String This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerImpressions Long This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerCpmAndCpcRevenue Long This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerWithoutCpdAverageEcpm Long This column maps to the field of the same name in the DoubleClick for Publishers API.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
EndDate Date The end date of the custom date range. The end date cannot be later than today's date.
StartDate Date The start date of the custom date range. The start date must be earlier than or the same as the end date.
DateRangeType String The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE.

Stored Procedures

Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Jitterbit Connector for Google Ads Manager Stored Procedures

Name Description
CreateReportSchema Create schema for a custom report.
GetOAuthAccessToken Obtains the OAuth access token to be used for authentication with various Google services.
GetOAuthAuthorizationURL Obtains the OAuth authorization URL used for authentication with various Google services.
RefreshOAuthAccessToken Refreshes the OAuth access token used for authentication with various Google services.

CreateReportSchema

Create schema for a custom report.

Input
Name Type Required Description
ReportName String True The name of the report.
FileName String True The full file path and name of the schema to generate. Ex : 'C:/Users/User/Desktop/SampleReport.rsd'
Metrics String True Metrics of the report separated by comma. Ex: 'AD_SERVER_IMPRESSIONS, AD_SERVER_TARGETED_IMPRESSIONS, AD_SERVER_CLICKS, AD_SERVER_TARGETED_CLICKS'
Dimensions String True Dimensions of the report separated by comma. Ex: 'MONTH_AND_YEAR, WEEK, DATE, DAY'
Result Set Columns
Name Type Description
Success String Returns True if the report is created.

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with various Google services.

Input
Name Type Required Description
AuthMode String True The type of authentication mode to use. The allowed values are APP, WEB. The default value is WEB.
Verifier String False The verifier code returned by Google after permission for the app to connect has been granted. WEB Authmode only.
Scope String True The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified. The default value is https://www.googleapis.com/auth/dfp.
CallbackURL String False This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, capitalization, and trailing forward slash ('/').
Prompt String True This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user. The default value is SELECT_ACCOUNT.
AccessType String True This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user. The allowed values are ONLINE, OFFLINE. The default value is OFFLINE.
State String False This field indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

GetOAuthAuthorizationURL

Obtains the OAuth authorization URL used for authentication with various Google services.

Input
Name Type Required Description
Scope String True The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified. The default value is https://www.googleapis.com/auth/dfp https://www.google.com/m8/feeds/ .
CallbackURL String False This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, capitalization, and trailing forward slash, ('/').
Prompt String True This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user. The default value is SELECT_ACCOUNT.
AccessType String True This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user. The allowed values are ONLINE, OFFLINE. The default value is OFFLINE.
State String False This field indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
URL String The URL to complete user authentication.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with various Google services.

Input
Name Type Required Description
OAuthRefreshToken String True The refresh token returned from the original authorization code exchange.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Google Ad Manager:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Orders table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Orders'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Orders table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Orders'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:googleadsmanager:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Collaborative Query Processing

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Property Description
AuthScheme The type of authentication to use when connecting to Google Ad Manager.
NetworkCode Obtain this value from the URL after logging into the network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.
Version The lastest Google Ad Manager Api version.

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

JWT OAuth

Property Description
OAuthJWTCert The JWT Certificate store.
OAuthJWTCertType The type of key store containing the JWT Certificate.
OAuthJWTCertPassword The password for the OAuth JWT certificate.
OAuthJWTCertSubject The subject of the OAuth JWT certificate.
OAuthJWTIssuer The issuer of the Java Web Token.
OAuthJWTSubject The user subject for which the application is requesting delegated access.

SSL

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
Pagesize The maximum number of results to return per page from Google Ad Manager.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.

Authentication

This section provides a complete list of authentication properties you can configure.

Property Description
AuthScheme The type of authentication to use when connecting to Google Ad Manager.
NetworkCode Obtain this value from the URL after logging into the network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.
Version The lastest Google Ad Manager Api version.

AuthScheme

The type of authentication to use when connecting to Google Ad Manager.

Possible Values

Auto, OAuth, OAuthJWT, GCPInstanceAccount

Data Type

string

Default Value

Auto

Remarks
  • Auto: Lets the driver decide automatically based on the other connection properties you have set.
  • OAuth: Set this to perform OAuth authentication using a standard user account.
  • OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
  • GCPInstanceAccount: Set this to get Access Token from Google Cloud Platform instance.

NetworkCode

Obtain this value from the URL after logging into the network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

Data Type

string

Default Value

""

Remarks

The NetWorkCode must be set in the connection string. You will find this in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

Version

The lastest Google Ad Manager Api version.

Data Type

string

Default Value

v202202

Remarks

The lastest Google Ad Manager Api version. You will find this in their API documentation page.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

  • Windows: "register://%DSN"
  • Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

JWT OAuth

This section provides a complete list of JWT OAuth properties you can configure.

Property Description
OAuthJWTCert The JWT Certificate store.
OAuthJWTCertType The type of key store containing the JWT Certificate.
OAuthJWTCertPassword The password for the OAuth JWT certificate.
OAuthJWTCertSubject The subject of the OAuth JWT certificate.
OAuthJWTIssuer The issuer of the Java Web Token.
OAuthJWTSubject The user subject for which the application is requesting delegated access.

OAuthJWTCert

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject

field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

Property Description
MY A certificate store holding personal certificates with their associated private keys.
CA Certifying authority certificates.
ROOT Root certificates.
SPC Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, GOOGLEJSON, GOOGLEJSONBLOB

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

Property Description
USER For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB The certificate store is a string that contains a certificate in XML format.
GOOGLEJSON The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service.
GOOGLEJSONBLOB The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service.

OAuthJWTCertPassword

The password for the OAuth JWT certificate.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.

OAuthJWTCertSubject

The subject of the OAuth JWT certificate.

Data Type

string

Default Value

*

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Common fields and their meanings are displayed below.

Field Meaning
CN Common Name. This is commonly a host name like www.server.com.
O Organization
OU Organizational Unit
L Locality
S State
C Country
E Email Address

If a field value contains a comma it must be quoted.

OAuthJWTIssuer

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. This is typically either the Client ID or Email Address of the OAuth Application.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.

OAuthJWTSubject

The user subject for which the application is requesting delegated access.

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\GoogleAdsManager Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\GoogleAdsManager Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
Pagesize The maximum number of results to return per page from Google Ad Manager.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

Pagesize

The maximum number of results to return per page from Google Ad Manager.

Data Type

int

Default Value

100

Remarks

The Pagesize property affects the maximum number of results to return per page from Google Ad Manager. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.