Skip to Content

Google Campaign Manager 360 Connection Details

Introduction

Connector Version

This documentation is based on version 22.0.8676 of the connector.

Get Started

Google Campaign Manager Version Support

The connector surfaces the reports and fields available through the v2.8 Google Campaign Manager API. The connector exposes all existing reports in your DCM instance as well as a set of generic tables for ad-hoc reporting.

Establish a Connection

Connect to Google Campaign Manager

Provide the following connection properties before adding the authentication properties.

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

Authenticate to Google Campaign Manager

The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

The following sections discuss the available authentication schemes for Google Campaign Manager:

  • User Accounts (OAuth)
  • Service Account (OAuthJWT)
  • GCP Instance Account
User Accounts (OAuth)

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

Desktop Applications

provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.

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

  • InitiateOAuth: Set this to GETANDREFRESH, which instructs the connector to automatically attempt to get and refresh the OAuth access token.
  • OAuthClientId: (custom applications only) Set this to the Client ID in your custom OAuth application settings.
  • OAuthClientSecret: (custom applications only) Set this to the Client Secret in the custom OAuth application settings.

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 as follows:

  • Extracts the access token from the callback URL.
  • Obtains a new access token when the old one expires.
  • Saves OAuth values in OAuthSettingsLocation that persist across connections.
Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Google Campaign Manager. You can then use the connector to acquire and manage the OAuth token values. See Creating a Custom OAuth App for more information about custom applications.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • OAuthClientId: Set this to the Client ID in your application settings.
  • OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Callback URL you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
  2. Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once authenticated, the browser redirects you to the callback URL.
  3. Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the Client ID in your application settings.
  • OAuthClientSecret: Set this to the Client Secret in your application settings.
  • OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
  • OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
  • OAuthSettingsLocation: Set this to the path where the connector saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

  • OAuthClientId: Set this to the Client ID in your application settings.
  • OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

  1. Choose one of two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the connector to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. Choose one of these options:

    • If you are using the Embedded OAuth Application click Google Campaign Manager OAuth endpoint to open the endpoint in your browser.

    • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:

      • InitiateOAuth: Set to OFF.
      • OAuthClientId: Set to the client ID assigned when you registered your application.
      • OAuthClientSecret: Set to the client secret assigned when you registered your application.

      Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a 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. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

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

  • InitiateOAuth: Set this to REFRESH.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthClientId: (custom applications only) Set this to the Client ID in your custom OAuth application settings.
  • OAuthClientSecret: (custom applications only) Set this to the Client Secret in the custom OAuth application settings.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client ID assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • 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.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

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: (custom applications only) Set this to the client ID assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • 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.
Service Accounts (OAuthJWT)

To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate. If you do not already have a service account, you can create one by following the procedure in Creating a Custom OAuth App.

For a JSON file, set these properties:

  • AuthScheme: Set this to OAuthJWT.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthJWTCertType: Set this to GOOGLEJSON.
  • OAuthJWTCert: 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, set these properties instead:

  • AuthScheme: Set this to OAuthJWT.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthJWTCertType: Set this to PFXFILE.
  • OAuthJWTCert: Set this to the path to the .pfx file provided by Google.
  • OAuthJWTCertPassword: (optional) Set this to the .pfx file password. In most cases you must provide this 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: 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.
GCP Instance Accounts

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.

Create a Custom OAuth App

When to Create a Custom OAuth App

embeds OAuth Application Credentials with branding that can be used when connecting via either a Desktop Application or from a Headless Machine. Creating a custom OAuth application is, however, required when using a web application.

For service accounts, you must always create a custom OAuth application.

You may choose to create your own OAuth Application Credentials when you want to

  • control branding of the Authentication Dialog
  • control the redirect URI that the application redirects the user to after the user authenticates
  • customize the permissions that you are requesting from the user

User Accounts

Create an OAuth App for User Account Authentication

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

Desktop Applications
  1. Log into the Google API Console and open a project.
  2. Select the API Manager from the main menu.
  3. Select Credentials > Create Credentials > OAuth Client Id. Then click Other.
  4. Select Library > DCM/DFA Reporting And Trafficking API > Enable API.
Create an OAuth App for Service Account Authentication

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

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

Retrieve DoubleClick Campaign Manager data

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

Built-In Reporting Tables

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

  1. Ad-hoc reporting is available by running a query selecting any valid combination of dimensions or metrics from the table. For example:

    SELECT Campaign, CampaignId, Impressions, Clicks, ClickRate, TotalConversions FROM StandardReport
    

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

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

    SELECT * FROM StandardReport WHERE ReportID='123456789'
    

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

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

    SELECT * FROM StandardReport WHERE ReportID='123456789' AND FileID='987654321'
    

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

Exist DCM Reports

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

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

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

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Google Campaign Manager and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Jitterbit Connector for Google Campaign 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 CampaignPerformance 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"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

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 Campaign Manager models Google Campaign Manager entities in relational Tables, Views, and Stored Procedures. The provided tables will give you an overview of your account information and the reports available for DoubleClick Campaign Manager queries.

API limitations and requirements are documented in this section.

Create Additional Schemas

The CreateCustomSchema stored procedure can be used to easily generate new schema files for a given report. This procedure takes the TableName and a report ID and builds a schema file that can be read by the connector.

If the Location connection property is set, the file will be output to that folder. Otherwise, the OutputFolder input can be used to specify an output folder. To begin querying these new files, simply set the Location connection property to the folder containing these new schema files.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

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.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Jitterbit Connector for Google Campaign Manager Views

Name Description
CrossDimensionReachReport Table for running CrossDimensionReach reports saved in DCM or ad-hoc reports.
Files Lists all DoubleClick Campaign Manager files for the user.
FloodlightReport Table for running Floodlight reports saved in DCM or ad-hoc reports.
PathToConversionReport Table for running PathToConversion reports saved in DCM or ad-hoc reports.
ReachReport Table for running Reach reports saved in DCM or ad-hoc reports.
Reports Lists all DoubleClick Campaign Manager reports for the user.
StandardReport Table for running Standard reports saved in DCM or ad-hoc reports.
UserProfiles Lists all DoubleClick Campaign Manager user profiles to which the Google user has access.

CrossDimensionReachReport

Table for running CrossDimensionReach reports saved in DCM or ad-hoc reports.

Columns
Name Type Dimension Description
CookieReachAverageImpressionFrequency Double False
CookieReachClickReach Long False
CookieReachDuplicateClickReach Long False
CookieReachDuplicateClickReachPercent Double False
CookieReachDuplicateImpressionReach Long False
CookieReachDuplicateImpressionReachPercent Double False
CookieReachDuplicateTotalReach Long False
CookieReachDuplicateTotalReachPercent Double False
CookieReachExclusiveClickReach Long False
CookieReachExclusiveClickReachPercent Double False
CookieReachExclusiveImpressionReach Long False
CookieReachExclusiveImpressionReachPercent Double False
CookieReachExclusiveTotalReach Long False
CookieReachExclusiveTotalReachPercent Double False
CookieReachImpressionReach Long False
CookieReachIncrementalClickReach Long False
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
ReportID String Optional input to pull a specific report by ID.
FileID String Optional input to pull a specific file by ID.

Files

Lists all DoubleClick Campaign Manager files for the user.

Columns
Name Type Dimension Description
Id [KEY] Long The unique ID of the file.
ReportId Long The ID of the report this file was generated from.
FileName String The name of the report.
Format String The output format of the report. If not specified, default format is 'CSV'. Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. 'CSV' will then be the fallback format.
Status String The status of the report file. Values can be CANCELLED, FAILED, PROCESSING, or REPORT_AVAILABLE.
DateRange String The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
URLs String The URLs where the completed report file can be downloaded.
LastModifiedTime String The timestamp of when this report was last modified.
Kind String The kind of resource this is, in this case dfareporting#file.
eTag String The eTag of this response for caching purposes.
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
Scope String The scope that defines which results are returned. Values aer ALL, MINE (default), or SHARED_WITH_ME.

FloodlightReport

Table for running Floodlight reports saved in DCM or ad-hoc reports.

Columns
Name Type Dimension Description
CookieReachIncrementalImpressionReach Long False
CookieReachIncrementalTotalReach Long False
CookieReachTotalReach Long False
CookieReachOverlapClickReach Long False
CookieReachOverlapClickReachPercent Double False
CookieReachOverlapImpressionReach Long False
CookieReachOverlapImpressionReachPercent Double False
CookieReachOverlapTotalReach Long False
CookieReachOverlapTotalReachPercent Double False
Activity String True
ActivityGroup String True
ActivityGroupId Long True
ActivityId Long True
ActivityTime String True
Ad String True
AdId Long True
AdType String True
Advertiser String True
AdvertiserGroup String True
AdvertiserId Long True
Asset String True
AssetCategory String True
AssetId Long True
AssetOrientation String True
AudienceTargeted String True
BrowserPlatform String True
Campaign String True
CampaignEndDate String True
CampaignId Long True
CampaignStartDate String True
ChannelMix String True
City String True
ClickCount Long True
ClickThroughUrl String True
ConnectionType String True
ConversionReferrer String True
ConversionUrl String True
Country String True
Creative String True
CreativeGroup1 String True
CreativeGroup2 String True
CreativeId Long True
CreativeSize String True
CreativeType String True
CreativeVersion String True
CustomRichMediaEventCount Long True
CustomRichMediaEventPathSummary String True
Date String True
DaysSinceAttributedInteraction Long True
DaysSinceFirstInteraction Long True
DmaRegion String True
DynamicProfile String True
DynamicProfileId Long True
Feed1 String True
Feed1ReportingDimension1 String True
Feed1ReportingDimension2 String True
Feed1ReportingDimension3 String True
Feed1ReportingLabel String True
Feed1UniqueId String True
Feed2 String True
Feed2ReportingDimension1 String True
Feed2ReportingDimension2 String True
Feed2ReportingDimension3 String True
Feed2ReportingLabel String True
Feed2UniqueId String True
Feed3 String True
Feed3ReportingDimension1 String True
Feed3ReportingDimension2 String True
Feed3ReportingDimension3 String True
Feed3ReportingLabel String True
Feed3UniqueId String True
Feed4 String True
Feed4ReportingDimension1 String True
Feed4ReportingDimension2 String True
Feed4ReportingDimension3 String True
Feed4ReportingLabel String True
Feed4UniqueId String True
Feed5 String True
Feed5ReportingDimension1 String True
Feed5ReportingDimension2 String True
Feed5ReportingDimension3 String True
Feed5ReportingLabel String True
Feed5UniqueId String True
FloodlightAttributionType String True
FloodlightConfigId Long True
FloodlightVariableDimension1 String True
FloodlightVariableDimension2 String True
FloodlightVariableDimension3 String True
FloodlightVariableDimension4 String True
FloodlightVariableDimension5 String True
FloodlightVariableDimension6 String True
FloodlightVariableDimension7 String True
FloodlightVariableDimension8 String True
FloodlightVariableDimension9 String True
FloodlightVariableDimension10 String True
FloodlightVariableDimension11 String True
FloodlightVariableDimension12 String True
FloodlightVariableDimension13 String True
FloodlightVariableDimension14 String True
FloodlightVariableDimension15 String True
FloodlightVariableDimension16 String True
FloodlightVariableDimension17 String True
FloodlightVariableDimension18 String True
FloodlightVariableDimension19 String True
FloodlightVariableDimension20 String True
FloodlightVariableDimension21 String True
FloodlightVariableDimension22 String True
FloodlightVariableDimension23 String True
FloodlightVariableDimension24 String True
FloodlightVariableDimension25 String True
FloodlightVariableDimension26 String True
FloodlightVariableDimension27 String True
FloodlightVariableDimension28 String True
FloodlightVariableDimension29 String True
FloodlightVariableDimension30 String True
FloodlightVariableDimension31 String True
FloodlightVariableDimension32 String True
FloodlightVariableDimension33 String True
FloodlightVariableDimension34 String True
FloodlightVariableDimension35 String True
FloodlightVariableDimension36 String True
FloodlightVariableDimension37 String True
FloodlightVariableDimension38 String True
FloodlightVariableDimension39 String True
FloodlightVariableDimension40 String True
FloodlightVariableDimension41 String True
FloodlightVariableDimension42 String True
FloodlightVariableDimension43 String True
FloodlightVariableDimension44 String True
FloodlightVariableDimension45 String True
FloodlightVariableDimension46 String True
FloodlightVariableDimension47 String True
FloodlightVariableDimension48 String True
FloodlightVariableDimension49 String True
FloodlightVariableDimension50 String True
FloodlightVariableDimension51 String True
FloodlightVariableDimension52 String True
FloodlightVariableDimension53 String True
FloodlightVariableDimension54 String True
FloodlightVariableDimension55 String True
FloodlightVariableDimension56 String True
FloodlightVariableDimension57 String True
FloodlightVariableDimension58 String True
FloodlightVariableDimension59 String True
FloodlightVariableDimension60 String True
FloodlightVariableDimension61 String True
FloodlightVariableDimension62 String True
FloodlightVariableDimension63 String True
FloodlightVariableDimension64 String True
FloodlightVariableDimension65 String True
FloodlightVariableDimension66 String True
FloodlightVariableDimension67 String True
FloodlightVariableDimension68 String True
FloodlightVariableDimension69 String True
FloodlightVariableDimension70 String True
FloodlightVariableDimension71 String True
FloodlightVariableDimension72 String True
FloodlightVariableDimension73 String True
FloodlightVariableDimension74 String True
FloodlightVariableDimension75 String True
FloodlightVariableDimension76 String True
FloodlightVariableDimension77 String True
FloodlightVariableDimension78 String True
FloodlightVariableDimension79 String True
FloodlightVariableDimension80 String True
FloodlightVariableDimension81 String True
FloodlightVariableDimension82 String True
FloodlightVariableDimension83 String True
FloodlightVariableDimension84 String True
FloodlightVariableDimension85 String True
FloodlightVariableDimension86 String True
FloodlightVariableDimension87 String True
FloodlightVariableDimension88 String True
FloodlightVariableDimension89 String True
FloodlightVariableDimension90 String True
FloodlightVariableDimension91 String True
FloodlightVariableDimension92 String True
FloodlightVariableDimension93 String True
FloodlightVariableDimension94 String True
FloodlightVariableDimension95 String True
FloodlightVariableDimension96 String True
FloodlightVariableDimension97 String True
FloodlightVariableDimension98 String True
FloodlightVariableDimension99 String True
FloodlightVariableDimension100 String True
HasRichMediaBackupImages Boolean True
HasRichMediaCustomCounters Boolean True
HasRichMediaCustomExits Boolean True
HasRichMediaCustomTimers Boolean True
HasRichMediaDynamicAdImpressions Boolean True
HasRichMediaExpansions Boolean True
HasRichMediaFullScreenImpressions Boolean True
HasRichMediaFullScreenVideoCompletions Boolean True
HasRichMediaFullScreenVideoPlays Boolean True
HasRichMediaFullScreenViews Boolean True
HasRichMediaHtml5Impressions Boolean True
HasRichMediaInteractiveImpressions Boolean True
HasRichMediaManualCloses Boolean True
HasRichMediaVideoCompanionClicks Boolean True
HasRichMediaVideoCompletions Boolean True
HasRichMediaVideoFirstQuartileCompletes Boolean True
HasRichMediaVideoFullScreens Boolean True
HasRichMediaVideoInteractions Boolean True
HasRichMediaVideoMidpoints Boolean True
HasRichMediaVideoMutes Boolean True
HasRichMediaVideoPauses Boolean True
HasRichMediaVideoPlays Boolean True
HasRichMediaVideoProgressEvents Boolean True
HasRichMediaVideoReplays Boolean True
HasRichMediaVideoSkips Boolean True
HasRichMediaVideoStops Boolean True
HasRichMediaVideoThirdQuartileCompletes Boolean True
HasRichMediaVideoUnmutes Boolean True
HasRichMediaVideoViews Boolean True
Hour String True
HoursSinceAttributedInteraction Long True
HoursSinceFirstInteraction Long True
ImpressionCount Long True
InteractionChannel String True
InteractionCountClickTracker Long True
InteractionCountMobileRichMedia Long True
InteractionCountMobileStaticImage Long True
InteractionCountMobileVideo Long True
InteractionCountNaturalSearch Long True
InteractionCountPaidSearch Long True
InteractionCountRichMedia Long True
InteractionCountStaticImage Long True
InteractionCountVideo Long True
InteractionType String True
MobileCarrier String True
Month String True
NaturalSearchEngineCountry String True
NaturalSearchEngineProperty String True
NaturalSearchEngineUrl String True
NaturalSearchLandingPage String True
NaturalSearchLandingPageQueryString String True
NaturalSearchProcessedLandingPage String True
NaturalSearchProcessedLandingPageQueryString String True
NaturalSearchQuery String True
NumValue String True
OperatingSystem String True
OperatingSystemVersion String True
OrdValue String True
PackageRoadblock String True
PackageRoadblockId Long True
PackageRoadblockStrategy String True
PaidSearchAd String True
PaidSearchAdGroup String True
PaidSearchAdGroupId Long True
PaidSearchAdId Long True
PaidSearchAdvertiser String True
PaidSearchAdvertiserId Long True
PaidSearchAgency String True
PaidSearchAgencyId Long True
PaidSearchBidStrategy String True
PaidSearchBidStrategyId Long True
PaidSearchCampaign String True
PaidSearchCampaignId Long True
PaidSearchEngineAccount String True
PaidSearchEngineAccountCategory String True
PaidSearchEngineAccountId Long True
PaidSearchExternalAdGroupId Long True
PaidSearchExternalAdId Long True
PaidSearchExternalCampaignId Long True
PaidSearchExternalKeywordId Long True
PaidSearchKeyword String True
PaidSearchKeywordId Long True
PaidSearchLabels String True
PaidSearchLandingPageUrl String True
PaidSearchLegacyKeywordId Long True
PaidSearchMatchType String True
PathLength Long True
PathType String True
Placement String True
PlacementEndDate String True
PlacementId Long True
PlacementSize String True
PlacementStartDate String True
PlatformType String True
RenderingId Long True
RichMediaVideoLength String True
Site String True
SiteDirectory String True
SiteDirectoryId Long True
SiteId Long True
SiteKeyname String True
StandardRichMediaEventCount Long True
StandardRichMediaEventPathSummary String True
State String True
TranValue String True
UValue String True
Week String True
ZipCode Long True
ActivityClickThroughConversions Double False
ActivityClickThroughRevenue Double False
ActivityViewThroughConversions Double False
ActivityViewThroughRevenue Double False
FloodlightImpressions Long False
FloodlightVariableMetric1 Double False
FloodlightVariableMetric2 Double False
FloodlightVariableMetric3 Double False
FloodlightVariableMetric4 Double False
FloodlightVariableMetric5 Double False
FloodlightVariableMetric6 Double False
FloodlightVariableMetric7 Double False
FloodlightVariableMetric8 Double False
FloodlightVariableMetric9 Double False
FloodlightVariableMetric10 Double False
FloodlightVariableMetric11 Double False
FloodlightVariableMetric12 Double False
FloodlightVariableMetric13 Double False
FloodlightVariableMetric14 Double False
FloodlightVariableMetric15 Double False
FloodlightVariableMetric16 Double False
FloodlightVariableMetric17 Double False
FloodlightVariableMetric18 Double False
FloodlightVariableMetric19 Double False
FloodlightVariableMetric20 Double False
FloodlightVariableMetric21 Double False
FloodlightVariableMetric22 Double False
FloodlightVariableMetric23 Double False
FloodlightVariableMetric24 Double False
FloodlightVariableMetric25 Double False
FloodlightVariableMetric26 Double False
FloodlightVariableMetric27 Double False
FloodlightVariableMetric28 Double False
FloodlightVariableMetric29 Double False
FloodlightVariableMetric30 Double False
FloodlightVariableMetric31 Double False
FloodlightVariableMetric32 Double False
FloodlightVariableMetric33 Double False
FloodlightVariableMetric34 Double False
FloodlightVariableMetric35 Double False
FloodlightVariableMetric36 Double False
FloodlightVariableMetric37 Double False
FloodlightVariableMetric38 Double False
FloodlightVariableMetric39 Double False
FloodlightVariableMetric40 Double False
FloodlightVariableMetric41 Double False
FloodlightVariableMetric42 Double False
FloodlightVariableMetric43 Double False
FloodlightVariableMetric44 Double False
FloodlightVariableMetric45 Double False
FloodlightVariableMetric46 Double False
FloodlightVariableMetric47 Double False
FloodlightVariableMetric48 Double False
FloodlightVariableMetric49 Double False
FloodlightVariableMetric50 Double False
FloodlightVariableMetric51 Double False
FloodlightVariableMetric52 Double False
FloodlightVariableMetric53 Double False
FloodlightVariableMetric54 Double False
FloodlightVariableMetric55 Double False
FloodlightVariableMetric56 Double False
FloodlightVariableMetric57 Double False
FloodlightVariableMetric58 Double False
FloodlightVariableMetric59 Double False
FloodlightVariableMetric60 Double False
FloodlightVariableMetric61 Double False
FloodlightVariableMetric62 Double False
FloodlightVariableMetric63 Double False
FloodlightVariableMetric64 Double False
FloodlightVariableMetric65 Double False
FloodlightVariableMetric66 Double False
FloodlightVariableMetric67 Double False
FloodlightVariableMetric68 Double False
FloodlightVariableMetric69 Double False
FloodlightVariableMetric70 Double False
FloodlightVariableMetric71 Double False
FloodlightVariableMetric72 Double False
FloodlightVariableMetric73 Double False
FloodlightVariableMetric74 Double False
FloodlightVariableMetric75 Double False
FloodlightVariableMetric76 Double False
FloodlightVariableMetric77 Double False
FloodlightVariableMetric78 Double False
FloodlightVariableMetric79 Double False
FloodlightVariableMetric80 Double False
FloodlightVariableMetric81 Double False
FloodlightVariableMetric82 Double False
FloodlightVariableMetric83 Double False
FloodlightVariableMetric84 Double False
FloodlightVariableMetric85 Double False
FloodlightVariableMetric86 Double False
FloodlightVariableMetric87 Double False
FloodlightVariableMetric88 Double False
FloodlightVariableMetric89 Double False
FloodlightVariableMetric90 Double False
FloodlightVariableMetric91 Double False
FloodlightVariableMetric92 Double False
FloodlightVariableMetric93 Double False
FloodlightVariableMetric94 Double False
FloodlightVariableMetric95 Double False
FloodlightVariableMetric96 Double False
FloodlightVariableMetric97 Double False
FloodlightVariableMetric98 Double False
FloodlightVariableMetric99 Double False
FloodlightVariableMetric100 Double False
LastClickAttributedTransactionCount Double False
LastImpressionAttributedTransactionCount Double False
RichMediaAverageExpansionTime Double False
RichMediaAverageFullScreenViewTime Double False
RichMediaAverageInteractionTime Double False
RichMediaAverageVideoViewTime Double False
RichMediaBackupImages Long False
RichMediaCustomAverageTime Double False
RichMediaCustomCounters Long False
RichMediaCustomExits Long False
RichMediaCustomTimers Long False
RichMediaDisplayTime Long False
RichMediaExpansionTime Long False
RichMediaExpansions Long False
RichMediaFullScreenImpressions Long False
RichMediaFullScreenVideoCompletes Long False
RichMediaFullScreenVideoPlays Long False
RichMediaHtml5Impressions Long False
RichMediaInteractionTime Long False
RichMediaInteractions Long False
RichMediaInteractiveImpressions Long False
RichMediaManualCloses Long False
RichMediaVideoCompanionClicks Long False
RichMediaVideoCompletions Long False
RichMediaVideoFirstQuartileCompletes Long False
RichMediaVideoFullScreens Long False
RichMediaVideoInteractionRate Double False
RichMediaVideoInteractions Long False
RichMediaVideoMidpoints Long False
RichMediaVideoMutes Long False
RichMediaVideoPauses Long False
RichMediaVideoPlays Long False
RichMediaVideoProgressEvents Long False
RichMediaVideoReplays Long False
RichMediaVideoSkips Long False
RichMediaVideoStops Long False
RichMediaVideoThirdQuartileCompletes Long False
RichMediaVideoUnmutes Long False
RichMediaVideoViewRate Double False
RichMediaVideoViews Long False
TotalConversions Double False
TotalConversionsRevenue Double False
TransactionCount Long False
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
ReportID String Optional input to pull a specific report by ID.
FileID String Optional input to pull a specific file by ID.

PathToConversionReport

Table for running PathToConversion reports saved in DCM or ad-hoc reports.

Columns
Name Type Dimension Description
ConversionId Long True
Activity String True
ActivityGroup String True
ActivityGroupId Long True
ActivityId Long True
ActivityTime String True
BrowserPlatform String True
ChannelMix String True
City String True
ClickCount Long True
ConnectionType String True
ConversionReferrer String True
ConversionUrl String True
Country String True
CustomRichMediaEventCount Long True
CustomRichMediaEventPathSummary String True
DaysSinceAttributedInteraction Long True
DaysSinceFirstInteraction Long True
DmaRegion String True
FloodlightAttributionType String True
FloodlightConfigId Long True
HoursSinceAttributedInteraction Long True
HoursSinceFirstInteraction Long True
ImpressionCount Long True
InteractionCountClickTracker Long True
InteractionCountMobileRichMedia Long True
InteractionCountMobileStaticImage Long True
InteractionCountMobileVideo Long True
InteractionCountNaturalSearch Long True
InteractionCountPaidSearch Long True
InteractionCountRichMedia Long True
InteractionCountStaticImage Long True
InteractionCountVideo Long True
MobileCarrier String True
NumValue String True
OperatingSystem String True
OperatingSystemVersion String True
OrdValue String True
PathLength Long True
PathType String True
PlatformType String True
RecalculatedAttributionType String True
StandardRichMediaEventCount Long True
StandardRichMediaEventPathSummary String True
State String True
TranValue String True
UValue String True
ZipCode Long True
InteractionNumber Long True
InteractionTime String True
Ad String True
AdId Long True
AdType String True
Advertiser String True
AdvertiserGroup String True
AdvertiserId Long True
Asset String True
AssetCategory String True
AssetId Long True
AssetOrientation String True
AudienceTargeted String True
Campaign String True
CampaignEndDate String True
CampaignId Long True
CampaignStartDate String True
ClickThroughUrl String True
Creative String True
CreativeGroup1 String True
CreativeGroup2 String True
CreativeId Long True
CreativeSize String True
CreativeType String True
CreativeVersion String True
DynamicProfile String True
DynamicProfileId Long True
Feed1 String True
Feed1ReportingDimension1 String True
Feed1ReportingDimension2 String True
Feed1ReportingDimension3 String True
Feed1ReportingLabel String True
Feed1UniqueId String True
Feed2 String True
Feed2ReportingDimension1 String True
Feed2ReportingDimension2 String True
Feed2ReportingDimension3 String True
Feed2ReportingLabel String True
Feed2UniqueId String True
Feed3 String True
Feed3ReportingDimension1 String True
Feed3ReportingDimension2 String True
Feed3ReportingDimension3 String True
Feed3ReportingLabel String True
Feed3UniqueId String True
Feed4 String True
Feed4ReportingDimension1 String True
Feed4ReportingDimension2 String True
Feed4ReportingDimension3 String True
Feed4ReportingLabel String True
Feed4UniqueId String True
Feed5 String True
Feed5ReportingDimension1 String True
Feed5ReportingDimension2 String True
Feed5ReportingDimension3 String True
Feed5ReportingLabel String True
Feed5UniqueId String True
FloodlightAttributedInteraction String True
InteractionChannel String True
InteractionType String True
NaturalSearchEngineCountry String True
NaturalSearchEngineProperty String True
NaturalSearchEngineUrl String True
NaturalSearchLandingPage String True
NaturalSearchLandingPageQueryString String True
NaturalSearchProcessedLandingPage String True
NaturalSearchProcessedLandingPageQueryString String True
NaturalSearchQuery String True
PackageRoadblock String True
PackageRoadblockId Long True
PackageRoadblockStrategy String True
PaidSearchAd String True
PaidSearchAdGroup String True
PaidSearchAdGroupId Long True
PaidSearchAdId Long True
PaidSearchAdvertiser String True
PaidSearchAdvertiserId Long True
PaidSearchAgency String True
PaidSearchAgencyId Long True
PaidSearchBidStrategy String True
PaidSearchBidStrategyId Long True
PaidSearchCampaign String True
PaidSearchCampaignId Long True
PaidSearchEngineAccount String True
PaidSearchEngineAccountCategory String True
PaidSearchEngineAccountId Long True
PaidSearchExternalAdGroupId Long True
PaidSearchExternalAdId Long True
PaidSearchExternalCampaignId Long True
PaidSearchExternalKeywordId Long True
PaidSearchKeyword String True
PaidSearchKeywordId Long True
PaidSearchLabels String True
PaidSearchLandingPageUrl String True
PaidSearchLegacyKeywordId Long True
PaidSearchMatchType String True
Placement String True
PlacementEndDate String True
PlacementId Long True
PlacementSize String True
PlacementStartDate String True
RecalculatedAttributedInteraction String True
RenderingId Long True
RichMediaBackupImagesDimension Long True
RichMediaCustomCountersDimension Long True
RichMediaCustomExitsDimension Long True
RichMediaCustomTimersDimension Long True
RichMediaDisplayTimeDimension Long True
RichMediaExpansionTimeDimension Long True
RichMediaExpansionsDimension Long True
RichMediaFullScreenImpressionsDimension Long True
RichMediaFullScreenVideoCompletionsDimension Long True
RichMediaFullScreenVideoPlaysDimension Long True
RichMediaHtml5ImpressionsDimension Long True
RichMediaInteractionTimeDimension Long True
RichMediaInteractiveImpressionsDimension Long True
RichMediaManualClosesDimension Long True
RichMediaVideoCompanionClicksDimension Long True
RichMediaVideoCompletionsDimension Long True
RichMediaVideoFirstQuartileCompletesDimension Long True
RichMediaVideoFullScreensDimension Long True
RichMediaVideoInteractionsDimension Long True
RichMediaVideoLength String True
RichMediaVideoMidpointsDimension Long True
RichMediaVideoMutesDimension Long True
RichMediaVideoPausesDimension Long True
RichMediaVideoPlaysDimension Long True
RichMediaVideoProgressEventsDimension Long True
RichMediaVideoReplaysDimension Long True
RichMediaVideoSkipsDimension Long True
RichMediaVideoStopsDimension Long True
RichMediaVideoThirdQuartileCompletesDimension Long True
RichMediaVideoUnmutesDimension Long True
RichMediaVideoViewsDimension Long True
Site String True
SiteDirectory String True
SiteDirectoryId Long True
SiteId Long True
SiteKeyname String True
TwitterImpressionId Long True
WithinFloodlightLookbackWindow String True
TotalConversions Double False
TotalConversionsRevenue Double False
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
ReportID String Optional input to pull a specific report by ID.
FileID String Optional input to pull a specific file by ID.

ReachReport

Table for running Reach reports saved in DCM or ad-hoc reports.

Columns
Name Type Dimension Description
PaidSearchAverageCostPerAction Double False
PaidSearchAverageCostPerTransaction Double False
PaidSearchAverageDfaTransactionAmount Double False
PaidSearchRevenue Double False
PaidSearchSpendPerTransactionRevenue Double False
PaidSearchTransactionConversionPercentage Double False
PaidSearchTransactionRevenuePerSpend Double False
PaidSearchTransactions Double False
TotalConversions Double False
TotalConversionsRevenue Double False
Advertiser String True
Ad String True
AdId Long True
AdStatus String True
AdType String True
AdvertiserGroup String True
AdvertiserId Long True
BrowserPlatform String True
Campaign String True
CampaignEndDate String True
CampaignExternalId String True
CampaignId Long True
CampaignStartDate String True
City String True
ConnectionType String True
ContentCategory String True
Country String True
Date String True
DmaRegion String True
FloodlightConfigId Long True
Hour String True
MobileCarrier String True
Month String True
OperatingSystem String True
OperatingSystemVersion String True
PackageRoadblock String True
PackageRoadblockId Long True
PackageRoadblockStrategy String True
PackageRoadblockTotalBookedUnits String True
PaymentSource String True
Placement String True
PlacementCompatibility String True
PlacementCostStructure String True
PlacementEndDate String True
PlacementExternalId String True
PlacementId Long True
PlacementRate String True
PlacementStartDate String True
PlacementStrategy String True
PlacementTotalBookedUnits String True
PlacementTotalPlannedMediaCost String True
PlatformType String True
Site String True
SiteId Long True
SiteKeyname String True
Week String True
ActiveViewAverageViewableTimeSecond Double False
ActiveViewCustomMetricMeasurableImpressions Long False
ActiveViewCustomMetricViewableImpressions Long False
ActiveViewCustomMetricViewableRate Double False
ActiveViewEligibleImpressions Long False
ActiveViewGroupmMeasurableImpressions Long False
ActiveViewGroupmTrvMeasurableImpressions Long False
ActiveViewGroupmTrvViewableImpressions Long False
ActiveViewGroupmViewableImpressions Long False
ActiveViewImpressionDistributionNotMeasurable Double False
ActiveViewImpressionDistributionNotViewable Double False
ActiveViewImpressionDistributionViewable Double False
ActiveViewImpressionsAudibleAndVisibleAtCompletion Long False
ActiveViewImpressionsVisible10Seconds Long False
ActiveViewMeasurableImpressions Long False
ActiveViewNotMeasurableImpressions Long False
ActiveViewNotViewableImpressions Long False
ActiveViewPercentAudibleAndVisibleAtCompletion Double False
ActiveViewPercentAudibleAndVisibleAtFirstQuartile Double False
ActiveViewPercentAudibleAndVisibleAtMidpoint Double False
ActiveViewPercentAudibleAndVisibleAtStart Double False
ActiveViewPercentAudibleAndVisibleAtThirdQuartile Double False
ActiveViewPercentAudibleImpressions Double False
ActiveViewPercentBackground Double False
ActiveViewPercentFullscreen Double False
ActiveViewPercentImpressionsAudibleAndFullyOnscreen Double False
ActiveViewPercentImpressionsAudibleAndFullyOnscreenForHalfDuration Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtCompletion Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtFirstQuartile Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtMidpoint Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtThirdQuartile Double False
ActiveViewPercentImpressionsVisibleAtCompletion Double False
ActiveViewPercentImpressionsVisibleAtFirstQuartile Double False
ActiveViewPercentImpressionsVisibleAtMidpoint Double False
ActiveViewPercentImpressionsVisibleAtThirdQuartile Double False
ActiveViewPercentPlayTimeAudible Double False
ActiveViewPercentPlayTimeAudibleAndVisible Double False
ActiveViewPercentPlayTimeVisible Double False
ActiveViewPercentVisible10Seconds Double False
ActiveViewPercentVisibleAtCompletion Double False
ActiveViewPercentVisibleAtFirstQuartile Double False
ActiveViewPercentVisibleAtMidpoint Double False
ActiveViewPercentVisibleAtStart Double False
ActiveViewPercentVisibleAtThirdQuartile Double False
ActiveViewPercentageMeasurableImpressions Double False
ActiveViewPercentageViewableImpressions Double False
ActiveViewViewableImpressionCookieReach Long False
ActiveViewViewableImpressions Long False
ActivityClickThroughConversions Double False
ActivityClickThroughRevenue Double False
ActivityDeliveryStatus Double False
ActivityPerClick Double False
ActivityPerThousandImpressions Double False
ActivityViewThroughConversions Double False
ActivityViewThroughRevenue Double False
BookedActivities Double False
BookedClicks Double False
BookedImpressions Double False
BookedViewableImpressions Double False
ClickDeliveryStatus Double False
ClickRate Double False
Clicks Long False
CookieReachAverageImpressionFrequency Double False
CookieReachClickReach Long False
CookieReachImpressionReach Long False
CookieReachIncrementalClickReach Long False
CookieReachIncrementalImpressionReach Long False
CookieReachIncrementalTotalReach Long False
CookieReachTotalReach Long False
CostPerActivity Double False
CostPerClick Double False
CostPerRevenue Double False
CrossDeviceClickThroughConversionQuantity Long False
CrossDeviceClickThroughConversionRevenue Double False
CrossDeviceClickThroughConversions Long False
CrossDeviceTotalConversionQuantity Long False
CrossDeviceTotalConversionRevenue Double False
CrossDeviceTotalConversions Long False
CrossDeviceViewThroughConversionQuantity Long False
CrossDeviceViewThroughConversionRevenue Double False
CrossDeviceViewThroughConversions Long False
DV360Cost Double False
DV360CostUsd Double False
DownloadedImpressions Long False
EffectiveCpm Double False
ImpressionDeliveryStatus Double False
Impressions Long False
MediaCost Double False
NaturalSearchActions Double False
NaturalSearchClicks Long False
NaturalSearchRevenue Double False
NaturalSearchTransactions Double False
PaidSearchActionConversionPercentage Double False
PaidSearchActions Double False
PaidSearchAveragePosition Double False
PaidSearchClickRate Double False
PaidSearchClicks Long False
PaidSearchCost Double False
PaidSearchImpressions Long False
PaidSearchVisits Long False
PlannedMediaCost Double False
RevenuePerClick Double False
RevenuePerThousandImpressions Double False
RichMediaAverageDisplayTime Double False
RichMediaAverageExpansionTime Double False
RichMediaAverageFullScreenViewTime Double False
RichMediaAverageInteractionTime Double False
RichMediaAverageVideoViewTime Double False
RichMediaBackupImages Long False
RichMediaClickRate Double False
RichMediaClicks Long False
RichMediaCodeServes Long False
RichMediaCustomAverageTime Double False
RichMediaCustomCounters Long False
RichMediaCustomExits Long False
RichMediaCustomTimers Long False
RichMediaDisplayTime Long False
RichMediaEngagements Long False
RichMediaEventCounters Long False
RichMediaEventTimers Double False
RichMediaExpansionTime Long False
RichMediaExpansions Long False
RichMediaFullScreenImpressions Long False
RichMediaFullScreenVideoCompletes Long False
RichMediaFullScreenVideoPlays Long False
RichMediaHtml5Impressions Long False
RichMediaImpressions Long False
RichMediaInteractionRate Double False
RichMediaInteractionTime Long False
RichMediaInteractions Long False
RichMediaInteractiveImpressions Long False
RichMediaManualCloses Long False
RichMediaScrolls Long False
RichMediaTrueViewViews Long False
RichMediaVideoCompanionClicks Long False
RichMediaVideoCompletions Long False
RichMediaVideoFirstQuartileCompletes Long False
RichMediaVideoFullScreens Long False
RichMediaVideoInteractionRate Double False
RichMediaVideoInteractions Long False
RichMediaVideoMidpoints Long False
RichMediaVideoMutes Long False
RichMediaVideoPauses Long False
RichMediaVideoPlays Long False
RichMediaVideoProgressEvents Long False
RichMediaVideoReplays Long False
RichMediaVideoSkips Long False
RichMediaVideoStops Long False
RichMediaVideoThirdQuartileCompletes Long False
RichMediaVideoUnmutes Long False
RichMediaVideoViewRate Double False
RichMediaVideoViews Long False
RoadblockImpressions Long False
SocialEmailShares Long False
SocialEngagementRate Double False
SocialFollows Long False
SocialLeadSubmissions Long False
SocialLikes Long False
SocialOfferAccepts Long False
SocialReplies Long False
SocialTotalEngagements Long False
TwitterAppClicks Long False
TwitterBuyNowCardClicks Long False
TwitterBuyNowPurchaseSuccessfuls Long False
TwitterOtherEngagements Long False
TwitterRetweets Long False
TwitterUrlClicks Long False
TwitterVideo50PercentInViewFor2Seconds Long False
TwitterVideo100PercentInViewFor3Seconds Long False
UniqueReachAverageImpressionFrequency Double False
UniqueReachClickReach Long False
UniqueReachImpressionReach Long False
UniqueReachTotalReach Long False
VerificationBlockedImpressions Long False
VerificationClassifiedImpressions Long False
VerificationMeasurableImpressionsForAudio Long False
VerificationMeasurableImpressionsForVideoPlayerLocation Long False
VerificationMeasurableImpressionsForVideoPlayerSize Long False
VerificationPercentageMeasurableImpressionsForAudio Double False
VerificationPercentageMeasurableImpressionsForVideoPlayerLocation Double False
VerificationPercentageMeasurableImpressionsForVideoPlayerSize Double False
VerificationPublisherProblems Long False
VerificationReportingProblems Long False
VerificationServingProblems Long False
VerificationVerifiableImpressions Long False
VerificationVideoMutedAtStart Long False
VerificationVideoPlayerHdSizeImpressions Long False
VerificationVideoPlayerLargeSizeImpressions Long False
VerificationVideoPlayerLocationAvgPixelsFromLeft Long False
VerificationVideoPlayerLocationAvgPixelsFromTop Long False
VerificationVideoPlayerSizeAvgHeight Long False
VerificationVideoPlayerSizeAvgWidth Long False
VerificationVideoPlayerSmallSizeImpressions Long False
VerificationVideoProminenceScore Double False
VerificationWarnings Long False
VideoCompanionClicks Long False
VideoCompanionImpressions Long False
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
ReportID String Optional input to pull a specific report by ID.
FileID String Optional input to pull a specific file by ID.
dateRange String Optional input to pull a specific date range. Defaults to LAST_30_DAYS. If startDate and endDate are specified, this is ignored.
startDate String Optional input to pull report from specific start date.
endDate String Optional input to pull report from specific end date.

Reports

Lists all DoubleClick Campaign Manager reports for the user.

Columns
Name Type Dimension Description
Id [KEY] Long The unique ID of the report.
Name String The name of the report.
Type String The type of the report.
FileName String The name of the report.
Format String The output format of the report. If not specified, default format is 'CSV'. Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. 'CSV' will then be the fallback format.
Criteria String The report criteria for a report of type STANDARD.
PathToConversionCriteria String The report criteria for a report of type PATH_TO_CONVERSION.
ReachCriteria String The report criteria for a report of type REACH.
CrossDimensionReachCriteria String The report criteria for a report of type CROSS_DIMENSION_REACH.
FloodlightCriteria String The report criteria for a report of type FLOODLIGHT.
Schedule String The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not 'TODAY'.
Delivery String The report's email delivery settings.
OwnerProfileId Long The user profile ID of the owner of this report.
AccountId Long Account ID to which this report belongs.
SubAccountId Long Sub account ID to which this report belongs, if applicable.
LastModifiedTime String The timestamp of when this report was last modified.
Kind String The kind of resource this is, in this case dfareporting#report.
eTag String The eTag of this response for caching purposes.
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
Scope String The scope that defines which results are returned. Values aer ALL or MINE (default).

StandardReport

Table for running Standard reports saved in DCM or ad-hoc reports.

Columns
Name Type Dimension Description
ActiveViewCustomMetricId Long True
ActiveViewCustomMetricName String True
Activity String True
ActivityGroup String True
ActivityGroupId Long True
ActivityId Long True
Ad String True
AdId Long True
AdStatus String True
AdType String True
Advertiser String True
AdvertiserGroup String True
AdvertiserId Long True
App String True
AppId String True
Asset String True
AssetCategory String True
AssetId Long True
AssetOrientation String True
AttributedEventConnectionType String True
AttributedEventEnvironment String True
AudienceTargeted String True
BrowserPlatform String True
Campaign String True
CampaignEndDate String True
CampaignExternalId String True
CampaignId Long True
CampaignStartDate String True
City String True
ClickThroughUrl String True
CompanionCreative String True
CompanionCreativeId Long True
CompanionCreativeSize String True
ConnectionType String True
ContentCategory String True
ContentClassification String True
Country String True
Creative String True
CreativeEndDate String True
CreativeField1 String True
CreativeField2 String True
CreativeField3 String True
CreativeField4 String True
CreativeField5 String True
CreativeField6 String True
CreativeField7 String True
CreativeField8 String True
CreativeField9 String True
CreativeField10 String True
CreativeField11 String True
CreativeField12 String True
CreativeGroup1 String True
CreativeGroup2 String True
CreativeId Long True
CreativeSize String True
CreativeStartDate String True
CreativeType String True
CreativeVersion String True
Date String True
DV360Advertiser String True
DV360AdvertiserId Long True
DV360Creative String True
DV360CreativeId Long True
DV360InsertionOrder String True
DV360InsertionOrderId Long True
DV360LineItem String True
DV360LineItemId Long True
DV360Partner String True
DV360PartnerId Long True
DV360Site String True
DV360SiteId Long True
DigitalContentLabel String True
DmaRegion String True
Domain String True
DynamicElement String True
DynamicElement1Field1Value String True
DynamicElement1Field2Value String True
DynamicElement1Field3Value String True
DynamicElement1Field4Value String True
DynamicElement1Field5Value String True
DynamicElement1Field6Value String True
DynamicElement2Field1Value String True
DynamicElement2Field2Value String True
DynamicElement2Field3Value String True
DynamicElement2Field4Value String True
DynamicElement2Field5Value String True
DynamicElement2Field6Value String True
DynamicElement3Field1Value String True
DynamicElement3Field2Value String True
DynamicElement3Field3Value String True
DynamicElement3Field4Value String True
DynamicElement3Field5Value String True
DynamicElement3Field6Value String True
DynamicElement4Field1Value String True
DynamicElement4Field2Value String True
DynamicElement4Field3Value String True
DynamicElement4Field4Value String True
DynamicElement4Field5Value String True
DynamicElement4Field6Value String True
DynamicElement5Field1Value String True
DynamicElement5Field2Value String True
DynamicElement5Field3Value String True
DynamicElement5Field4Value String True
DynamicElement5Field5Value String True
DynamicElement5Field6Value String True
DynamicElement6Field1Value String True
DynamicElement6Field2Value String True
DynamicElement6Field3Value String True
DynamicElement6Field4Value String True
DynamicElement6Field5Value String True
DynamicElement6Field6Value String True
DynamicElement7Field1Value String True
DynamicElement7Field2Value String True
DynamicElement7Field3Value String True
DynamicElement7Field4Value String True
DynamicElement7Field5Value String True
DynamicElement7Field6Value String True
DynamicElement8Field1Value String True
DynamicElement8Field2Value String True
DynamicElement8Field3Value String True
DynamicElement8Field4Value String True
DynamicElement8Field5Value String True
DynamicElement8Field6Value String True
DynamicElement9Field1Value String True
DynamicElement9Field2Value String True
DynamicElement9Field3Value String True
DynamicElement9Field4Value String True
DynamicElement9Field5Value String True
DynamicElement9Field6Value String True
DynamicElement10Field1Value String True
DynamicElement10Field2Value String True
DynamicElement10Field3Value String True
DynamicElement10Field4Value String True
DynamicElement10Field5Value String True
DynamicElement10Field6Value String True
DynamicElement11Field1Value String True
DynamicElement11Field2Value String True
DynamicElement11Field3Value String True
DynamicElement11Field4Value String True
DynamicElement11Field5Value String True
DynamicElement11Field6Value String True
DynamicElement12Field1Value String True
DynamicElement12Field2Value String True
DynamicElement12Field3Value String True
DynamicElement12Field4Value String True
DynamicElement12Field6Value String True
DynamicElement13Field1Value String True
DynamicElement13Field2Value String True
DynamicElement13Field4Value String True
DynamicElement13Field5Value String True
DynamicElement13Field6Value String True
DynamicElement14Field1Value String True
DynamicElement14Field2Value String True
DynamicElement14Field3Value String True
DynamicElement14Field4Value String True
DynamicElement14Field5Value String True
DynamicElement14Field6Value String True
DynamicElement15Field1Value String True
DynamicElement15Field2Value String True
DynamicElement15Field3Value String True
DynamicElement15Field4Value String True
DynamicElement15Field5Value String True
DynamicElement15Field6Value String True
DynamicElement16Field1Value String True
DynamicElement16Field2Value String True
DynamicElement16Field3Value String True
DynamicElement16Field4Value String True
DynamicElement16Field5Value String True
DynamicElement16Field6Value String True
DynamicElement17Field1Value String True
DynamicElement17Field2Value String True
DynamicElement17Field3Value String True
DynamicElement17Field4Value String True
DynamicElement17Field5Value String True
DynamicElement17Field6Value String True
DynamicElement18Field1Value String True
DynamicElement18Field2Value String True
DynamicElement18Field3Value String True
DynamicElement18Field4Value String True
DynamicElement18Field5Value String True
DynamicElement18Field6Value String True
DynamicElement19Field1Value String True
DynamicElement19Field2Value String True
DynamicElement19Field3Value String True
DynamicElement19Field4Value String True
DynamicElement19Field5Value String True
DynamicElement19Field6Value String True
DynamicElement20Field1Value String True
DynamicElement20Field2Value String True
DynamicElement20Field3Value String True
DynamicElement20Field4Value String True
DynamicElement20Field5Value String True
DynamicElement20Field6Value String True
DynamicElementValue String True
DynamicElementValueId String True
DynamicFieldValue1 String True
DynamicFieldValue2 String True
DynamicFieldValue3 String True
DynamicFieldValue4 String True
DynamicFieldValue5 String True
DynamicFieldValue6 String True
DynamicProfile String True
DynamicProfileId Long True
Environment String True
EventPlatformType String True
ExitUrl String True
Feed1 String True
Feed1ReportingLabel String True
Feed1UniqueId String True
Feed2 String True
Feed2ReportingLabel String True
Feed2UniqueId String True
Feed3 String True
Feed3ReportingLabel String True
Feed3UniqueId String True
Feed4 String True
Feed4ReportingLabel String True
Feed4UniqueId String True
Feed5 String True
Feed5ReportingLabel String True
Feed5UniqueId String True
Feed6 String True
Feed6UniqueId String True
Feed7 String True
Feed7UniqueId String True
Feed8 String True
Feed8UniqueId String True
Feed9 String True
Feed9UniqueId String True
Feed10 String True
Feed10UniqueId String True
Feed11 String True
Feed11UniqueId String True
Feed12 String True
Feed12UniqueId String True
Feed13 String True
Feed13UniqueId String True
Feed14 String True
Feed14UniqueId String True
Feed15 String True
Feed15UniqueId String True
Feed16 String True
Feed16UniqueId String True
Feed17 String True
Feed17UniqueId String True
Feed18 String True
Feed18UniqueId String True
Feed19 String True
Feed19UniqueId String True
Feed20 String True
Feed20UniqueId String True
FlightBookedCost String True
FlightBookedRate String True
FlightBookedUnits String True
FlightEndDate String True
FlightStartDate String True
FloodlightConfigId Long True
Hour String True
Keyword String True
LandingPageUrl String True
MeasurementSource String True
MobileCarrier String True
Month String True
NaturalSearchEngineCountry String True
NaturalSearchEngineProperty String True
NaturalSearchLandingPage String True
NaturalSearchLandingPageQueryString String True
NaturalSearchProcessedLandingPage String True
NaturalSearchProcessedLandingPageQueryString String True
NaturalSearchQuery String True
OperatingSystem String True
OperatingSystemVersion String True
PackageRoadblock String True
PackageRoadblockId Long True
PackageRoadblockStrategy String True
PackageRoadblockTotalBookedUnits String True
PaidSearchAd String True
PaidSearchAdGroup String True
PaidSearchAdGroupId Long True
PaidSearchAdId Long True
PaidSearchAdvertiser String True
PaidSearchAdvertiserId Long True
PaidSearchAgency String True
PaidSearchAgencyId Long True
PaidSearchBidStrategy String True
PaidSearchBidStrategyId Long True
PaidSearchCampaign String True
PaidSearchCampaignId Long True
PaidSearchEngineAccount String True
PaidSearchEngineAccountCategory String True
PaidSearchEngineAccountId Long True
PaidSearchExternalAdGroupId Long True
PaidSearchExternalAdId Long True
PaidSearchExternalCampaignId Long True
PaidSearchExternalKeywordId Long True
PaidSearchKeyword String True
PaidSearchKeywordId Long True
PaidSearchLandingPageUrl String True
PaidSearchLegacyKeywordId Long True
PaidSearchMatchType String True
PaymentSource String True
Placement String True
PlacementCompatibility String True
PlacementCostStructure String True
PlacementEndDate String True
PlacementExternalId String True
PlacementId Long True
PlacementRate String True
PlacementSize String True
PlacementStartDate String True
PlacementStrategy String True
PlacementTagType String True
PlacementTotalBookedUnits String True
PlacementTotalPlannedMediaCost String True
PlatformType String True
PlaybackMethod String True
RenderingId Long True
RichMediaCustomVariable String True
RichMediaEvent String True
RichMediaVideo4asaId String True
RichMediaVideoLength String True
ServedPixelDensity String True
Site String True
SiteDirectory String True
SiteDirectoryId Long True
SiteId Long True
SiteKeyname String True
State String True
TwitterCampaignId Long True
TwitterCreativeId Long True
TwitterCreativeMediaId Long True
TwitterCreativeType String True
TwitterImpressionType String True
TwitterLineItemId Long True
TwitterPlacementType String True
UserList String True
UserListCurrentSize String True
UserListDescription String True
UserListId Long True
UserListMembershipLifeSpan String True
VerificationVideoPlayerSize String True
VerificationVideoProminenceScoreDimension String True
Week String True
ZipCode Long True
ActiveViewAverageViewableTimeSecond Double False
ActiveViewCustomMetricMeasurableImpressions Long False
ActiveViewCustomMetricViewableImpressions Long False
ActiveViewCustomMetricViewableRate Double False
ActiveViewEligibleImpressions Long False
ActiveViewGroupmMeasurableImpressions Long False
ActiveViewGroupmTrvMeasurableImpressions Long False
ActiveViewGroupmTrvViewableImpressions Long False
ActiveViewGroupmViewableImpressions Long False
ActiveViewImpressionDistributionNotMeasurable Double False
ActiveViewImpressionDistributionNotViewable Double False
ActiveViewImpressionDistributionViewable Double False
ActiveViewImpressionsAudibleAndVisibleAtCompletion Long False
ActiveViewImpressionsVisible10Seconds Long False
ActiveViewMeasurableImpressions Long False
ActiveViewNotMeasurableImpressions Long False
ActiveViewNotViewableImpressions Long False
ActiveViewPercentAudibleAndVisibleAtCompletion Double False
ActiveViewPercentAudibleAndVisibleAtFirstQuartile Double False
ActiveViewPercentAudibleAndVisibleAtMidpoint Double False
ActiveViewPercentAudibleAndVisibleAtStart Double False
ActiveViewPercentAudibleAndVisibleAtThirdQuartile Double False
ActiveViewPercentAudibleImpressions Double False
ActiveViewPercentBackground Double False
ActiveViewPercentFullscreen Double False
ActiveViewPercentImpressionsAudibleAndFullyOnscreen Double False
ActiveViewPercentImpressionsAudibleAndFullyOnscreenForHalfDuration Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtCompletion Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtFirstQuartile Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtMidpoint Double False
ActiveViewPercentImpressionsAudibleAndVisibleAtThirdQuartile Double False
ActiveViewPercentImpressionsVisibleAtCompletion Double False
ActiveViewPercentImpressionsVisibleAtFirstQuartile Double False
ActiveViewPercentImpressionsVisibleAtMidpoint Double False
ActiveViewPercentImpressionsVisibleAtThirdQuartile Double False
ActiveViewPercentPlayTimeAudible Double False
ActiveViewPercentPlayTimeAudibleAndVisible Double False
ActiveViewPercentPlayTimeVisible Double False
ActiveViewPercentVisible10Seconds Double False
ActiveViewPercentVisibleAtCompletion Double False
ActiveViewPercentVisibleAtFirstQuartile Double False
ActiveViewPercentVisibleAtMidpoint Double False
ActiveViewPercentVisibleAtStart Double False
ActiveViewPercentVisibleAtThirdQuartile Double False
ActiveViewPercentageMeasurableImpressions Double False
ActiveViewPercentageViewableImpressions Double False
ActiveViewViewableImpressions Long False
ActivityClickThroughConversions Double False
ActivityClickThroughRevenue Double False
ActivityDeliveryStatus Double False
ActivityPerClick Double False
ActivityPerThousandImpressions Double False
ActivityViewThroughConversions Double False
ActivityViewThroughRevenue Double False
AudioCompanionClicks Long False
AudioCompanionImpressions Long False
BookedActivities Double False
BookedClicks Double False
BookedImpressions Double False
BookedViewableImpressions Double False
ClickDeliveryStatus Double False
ClickRate Double False
Clicks Long False
CostPerActivity Double False
CostPerClick Double False
CostPerRevenue Double False
CrossDeviceClickThroughConversionQuantity Long False
CrossDeviceClickThroughConversionRevenue Double False
CrossDeviceClickThroughConversions Long False
CrossDeviceTotalConversionQuantity Long False
CrossDeviceTotalConversionRevenue Double False
CrossDeviceTotalConversions Long False
CrossDeviceViewThroughConversionQuantity Long False
CrossDeviceViewThroughConversionRevenue Double False
CrossDeviceViewThroughConversions Long False
DV360Cost Double False
DV360CostUsd Double False
DownloadedImpressions Long False
DynamicElementClickRate Double False
DynamicElementClickThroughConversions Long False
DynamicElementClicks Long False
DynamicElementImpressions Long False
DynamicElementTotalConversions Long False
DynamicElementViewThroughConversions Long False
EffectiveCpm Double False
GeneralInvalidTrafficActiveViewEligibleImpressions Long False
GeneralInvalidTrafficActiveViewMeasurableImpressions Long False
GeneralInvalidTrafficActiveViewViewableImpressions Long False
GeneralInvalidTrafficClicks Long False
GeneralInvalidTrafficImpressions Long False
ImpressionDeliveryStatus Double False
Impressions Long False
InvalidActiveViewEligibleImpressions Long False
InvalidActiveViewMeasurableImpressions Long False
InvalidActiveViewViewableImpressions Long False
InvalidClicks Long False
InvalidImpressions Long False
MediaCost Double False
NaturalSearchActions Double False
NaturalSearchClicks Long False
NaturalSearchRevenue Double False
NaturalSearchTransactions Double False
PaidSearchActionConversionPercentage Double False
PaidSearchActions Double False
PaidSearchAverageCostPerAction Double False
PaidSearchAverageCostPerTransaction Double False
PaidSearchAverageDfaTransactionAmount Double False
PaidSearchAveragePosition Double False
PaidSearchClickRate Double False
PaidSearchClicks Long False
PaidSearchCost Double False
PaidSearchImpressions Long False
PaidSearchRevenue Double False
PaidSearchSpendPerTransactionRevenue Double False
PaidSearchTransactionConversionPercentage Double False
PaidSearchTransactionRevenuePerSpend Double False
PaidSearchTransactions Double False
PaidSearchVisits Long False
PercentInvalidClicks Double False
PercentInvalidImpressions Double False
PlannedMediaCost Double False
RevenuePerClick Double False
RevenuePerThousandImpressions Double False
RichMediaAudioCompletions Long False
RichMediaAudioFirstQuartileCompletes Long False
RichMediaAudioMidpoints Long False
RichMediaAudioMutes Long False
RichMediaAudioPauses Long False
RichMediaAudioPlays Long False
RichMediaAudioReplays Long False
RichMediaAudioThirdQuartileCompletes Long False
RichMediaAudioUnmutes Long False
RichMediaAverageDisplayTime Double False
RichMediaAverageExpansionTime Double False
RichMediaAverageFullScreenViewTime Double False
RichMediaAverageInteractionTime Double False
RichMediaAverageVideoViewTime Double False
RichMediaBackupImages Long False
RichMediaClickRate Double False
RichMediaClicks Long False
RichMediaCodeServes Long False
RichMediaCustomAverageTime Double False
RichMediaCustomCounters Long False
RichMediaCustomExits Long False
RichMediaCustomTimers Long False
RichMediaCustomVariableCount1 Long False
RichMediaCustomVariableCount2 Long False
RichMediaDisplayTime Long False
RichMediaEngagements Long False
RichMediaEventCounters Long False
RichMediaEventTimers Double False
RichMediaExpansionTime Long False
RichMediaExpansions Long False
RichMediaFullScreenImpressions Long False
RichMediaFullScreenVideoCompletes Long False
RichMediaFullScreenVideoPlays Long False
RichMediaHtml5Impressions Long False
RichMediaImpressions Long False
RichMediaInteractionRate Double False
RichMediaInteractionTime Long False
RichMediaInteractions Long False
RichMediaInteractiveImpressions Long False
RichMediaManualCloses Long False
RichMediaScrolls Long False
RichMediaTrueViewViews Long False
RichMediaVideoCompanionClicks Long False
RichMediaVideoCompletions Long False
RichMediaVideoFirstQuartileCompletes Long False
RichMediaVideoFullScreens Long False
RichMediaVideoInteractionRate Double False
RichMediaVideoInteractions Long False
RichMediaVideoMidpoints Long False
RichMediaVideoMutes Long False
RichMediaVideoPauses Long False
RichMediaVideoPlays Long False
RichMediaVideoProgressEvents Long False
RichMediaVideoReplays Long False
RichMediaVideoSkips Long False
RichMediaVideoStops Long False
RichMediaVideoThirdQuartileCompletes Long False
RichMediaVideoUnmutes Long False
RichMediaVideoViewRate Double False
RichMediaVideoViews Long False
RoadblockImpressions Long False
SocialEmailShares Long False
SocialEngagementRate Double False
SocialFollows Long False
SocialLeadSubmissions Long False
SocialLikes Long False
SocialOfferAccepts Long False
SocialReplies Long False
SocialTotalEngagements Long False
TotalConversions Double False
TotalConversionsRevenue Double False
TwitterAppClicks Long False
TwitterBuyNowCardClicks Long False
TwitterBuyNowPurchaseSuccessfuls Long False
TwitterOtherEngagements Long False
TwitterRetweets Long False
TwitterUrlClicks Long False
TwitterVideo50PercentInViewFor2Seconds Long False
TwitterVideo100PercentInViewFor3Seconds Long False
VerificationBlockedImpressions Long False
VerificationClassifiedImpressions Long False
VerificationMeasurableImpressionsForAudio Long False
VerificationMeasurableImpressionsForVideoPlayerLocation Long False
VerificationMeasurableImpressionsForVideoPlayerSize Long False
VerificationPercentageMeasurableImpressionsForAudio Double False
VerificationPercentageMeasurableImpressionsForVideoPlayerLocation Double False
VerificationPercentageMeasurableImpressionsForVideoPlayerSize Double False
VerificationPublisherProblems Long False
VerificationReportingProblems Long False
VerificationServingProblems Long False
VerificationVerifiableImpressions Long False
VerificationVideoMutedAtStart Long False
VerificationVideoPlayerHdSizeImpressions Long False
VerificationVideoPlayerLargeSizeImpressions Long False
VerificationVideoPlayerLocationAvgPixelsFromLeft Long False
VerificationVideoPlayerLocationAvgPixelsFromTop Long False
VerificationVideoPlayerSizeAvgHeight Long False
VerificationVideoPlayerSizeAvgWidth Long False
VerificationVideoPlayerSmallSizeImpressions Long False
VerificationVideoProminenceScore Double False
VerificationWarnings Long False
VideoCompanionClicks Long False
VideoCompanionImpressions Long False
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
ReportID String Optional input to pull a specific report by ID.
FileID String Optional input to pull a specific file by ID.
dateRange String Optional input to pull a specific date range. Defaults to LAST_30_DAYS. If startDate and endDate are specified, this is ignored.
startDate String Optional input to pull report from specific start date.
endDate String Optional input to pull report from specific end date.

UserProfiles

Lists all DoubleClick Campaign Manager user profiles to which the Google user has access.

Columns
Name Type Dimension Description
ProfileId [KEY] Long The unique ID of the user profile.
AccountId Long Account ID to which this profile belongs.
SubAccountId Long Sub account ID to which this profile belongs, if applicable.
AccountName String The account name this profile belongs to.
SubAccountName String The sub account name this profile belongs to, if applicable.
UserName String The user name.
Kind String The kind of resource this is, in this case dfareporting#userProfile.
eTag String The eTag of this response for caching purposes.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Google Campaign Manager.

Stored procedures accept a list of parameters, perform their intended function, and then return, if applicable, any relevant response data from Google Campaign Manager, along with an indication of whether the procedure succeeded or failed.

Jitterbit Connector for Google Campaign Manager Stored Procedures

Name Description
CheckReportStatus Checks the status of a report.
CreateCustomSchema Creates a custom schema file based for the given ReportID.
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 Obtains the OAuth access token to be used for authentication with various Google services.
RunReport Runs a given report and returns the file ID which can be used to retrieve the results after processing is complete.

CheckReportStatus

Checks the status of a report.

Input
Name Type Description
ReportId String The ID for the report in DoubleClick Campaign Manager.
FileId String The ID for the report file in DoubleClick Campaign Manager.
Result Set Columns
Name Type Description
FileId String The unique ID of the file.
ReportId String The ID of the report this file was generated from.
FileName String The name of the report.
Format String The output format of the report. If not specified, default format is 'CSV'. Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. 'CSV' will then be the fallback format.
Status String The status of the report file. Values can be CANCELLED, FAILED, PROCESSING, or REPORT_AVAILABLE.
DateRange String The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
URLs String The URLs where the completed report file can be downloaded.
LastModifiedTime String The timestamp of when this report was last modified.
Kind String The kind of resource this is, in this case dfareporting#file.
ETag String The eTag of this response for caching purposes.

CreateCustomSchema

Creates a custom schema file based for the given ReportID.

CreateCustomSchema

Creates a custom schema file based on the specified Dimensions and Metrics.

A custom schema may be used for a more tailored approach to your data. Custom options may include comma-separated lists for specific data.

Input
Name Type Accepts Output Streams Description
TableName String False The name for the new table.
Description String False An optional description for the table.
WriteToFile String False Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.
ReportID String False The ID for the report in DoubleClick Campaign Manager.
FileStream String True OutputStream to write the created schema.
Result Set Columns
Name Type Description
Success String Whether or not the schema was created successfully.
SchemaFile String The generated schema file.
FileData String The generated schema encoded in base64. Only returned if WriteToFile set to false and FileStream is not set.

GetOAuthAccessToken

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

Note

If, after running this stored procedure, the OAuthRefreshToken was not returned as part of the result set, change the Prompt value to CONSENT and run the procedure again. This forces the app to reauthenticate and send new token information.

Input
Name Type Description
AuthMode String The type of authentication mode to use. The allowed values are APP, WEB. The default value is WEB.
Verifier String The verifier code returned by Google after permission for the app to connect has been granted. WEB AuthMode only.
Scope String 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/dfareporting.
CallbackURL String 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 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 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 This field indicates any state that 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 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 Description
Scope String 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/dfareporting.
CallbackURL String 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, case, and trailing forward slash ('/').
Prompt String 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 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 This field indicates any state that 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. Possible 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

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

Input
Name Type Description
OAuthRefreshToken String 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 The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
ExpiresIn String The remaining lifetime on the access token.

RunReport

Runs a given report and returns the file ID which can be used to retrieve the results after processing is complete.

Input
Name Type Description
ReportId String The ID for the report in DoubleClick Campaign Manager.
Result Set Columns
Name Type Description
FileId String Whether or not the schema was created successfully.

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 Campaign 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 CampaignPerformance table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='CampaignPerformance'
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 GetOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' 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 CampaignPerformance table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='CampaignPerformance'
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_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
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.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary 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:googlecm: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.

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 Campaign Manager.
ProfileID The DFA Profile ID. If not specified, the first Profile returned from the UserProfiles service will be used.

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.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
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
APIVersion The version of the API to use to connect to Campaign Manager.
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.
PollingInterval The base time interval in seconds between requests that check the availability of the report response. The default value is 10 seconds.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
QueryTimeout The timeout in minutes for which the provider will wait for a asycnchronous report response. The default value is 60 minutes.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

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 Campaign Manager.
ProfileID The DFA Profile ID. If not specified, the first Profile returned from the UserProfiles service will be used.

AuthScheme

The type of authentication to use when connecting to Google Campaign 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.

ProfileID

The DFA Profile ID. If not specified, the first Profile returned from the UserProfiles service will be used.

Data Type

string

Default Value

""

Remarks

This value can be retrieved from the UserProfiles table or will be retrieved automatically if this value is not set.

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.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
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, this can be held in memory by specifying a value starting with memory://.

Data Type

string

Default Value

%APPDATA%\GoogleCM Data Provider\OAuthSettings.txt

Remarks

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

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\GoogleCM Data Provider\OAuthSettings.txt" 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

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 to 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

GOOGLEJSONBLOB, 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

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%\GoogleCM 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%\GoogleCM 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
APIVersion The version of the API to use to connect to Campaign Manager.
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.
PollingInterval The base time interval in seconds between requests that check the availability of the report response. The default value is 10 seconds.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
QueryTimeout The timeout in minutes for which the provider will wait for a asycnchronous report response. The default value is 60 minutes.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

APIVersion

The version of the API to use to connect to Campaign Manager.

Data Type

string

Default Value

v4

Remarks

The version of the API to use to connect to Campaign Manager.

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.

PollingInterval

The base time interval in seconds between requests that check the availability of the report response. The default value is 10 seconds.

Data Type

string

Default Value

10

Remarks

The base time interval between requests that check the availability of the asynchronous response. For long running reports, the connector starts an asycnchronous job in DoubleClick Campaign Manager when running a SELECT query. It then waits for the response by periodically polling the server to check the status of the running report. Exponential backoff is used to reduce the number of API requests made.

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, "*=*".

QueryTimeout

The timeout in minutes for which the provider will wait for a asycnchronous report response. The default value is 60 minutes.

Data Type

string

Default Value

60

Remarks

The timeout in minutes for which the connector will wait for a asycnchronous report response. The default value is 60 minutes. For long running reports, the connector starts an asycnchronous job in DoubleClick Campaign Manager when running a SELECT query. It then waits for the response to be ready by periodically polling the server to check status. This property controls the total time the connector will wait for a response.

Note that this property is very different from Timeout. The Timeout is an inactivity timeout that controls the time to wait for any response. This property controls the total length of time to wait for a bulk query to execute. ;

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.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

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 CampaignPerformance 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"