CData Cloud offers access to Google Campaign Manager across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Google Campaign Manager through CData Cloud.
CData Cloud allows you to standardize and configure connections to Google Campaign Manager as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Google Campaign Manager in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Google Campaign Manager and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Google Campaign Manager through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Google Campaign Manager by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Provide the following connection properties before adding the authentication properties.
The Cloud supports using user accounts and GCP instance accounts for authentication.
The following sections discuss the available authentication schemes for Google Campaign Manager:
AuthScheme must be set to OAuth in all user account flows.
Get an OAuth Access Token
Set the following connection properties to obtain the OAuthAccessToken:
Then call stored procedures to complete the OAuth exchange:
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:
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:
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.
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.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, you need to re-set the following properties to connect:
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:
When running on a GCP virtual machine, the Cloud can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.
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
To obtain the necessary authentication properties, follow the steps below to create an OAuth application and generate a private key:
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 Cloud 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 Cloud.
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:
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 Cloud. Finally, the report definition is deleted from DCM.
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.
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.
The Cloud 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'
| Date | Build Number | Change Type | Description |
| 12/14/2022 | 8383 | General | Changed
|
| 12/08/2022 | 8377 | Google Campaign Manager | Added
|
| 10/14/2022 | 8322 | Google Campaign Manager | Added
|
| 09/30/2022 | 8308 | General | Changed
|
| 09/30/2022 | 8308 | Google Campaign Manager | Added
|
| 08/17/2022 | 8264 | General | Changed
|
| 08/05/2022 | 8252 | Google Campaign Manager | Changed
|
| 04/22/2022 | 8146 | Google Campaign Manager | Added
|
| 02/11/2022 | 8077 | Google Campaign Manager | Changed
|
| 02/09/2022 | 8075 | Google Campaign Manager | Added
|
| 09/02/2021 | 7915 | General | Added
|
| 08/07/2021 | 7889 | General | Changed
|
| 08/06/2021 | 7888 | General | Changed
|
| 07/23/2021 | 7874 | General | Changed
|
| 07/08/2021 | 7859 | General | Added
|
| 06/18/2021 | 7839 | Google Campaign Manager | Added
|
| 04/23/2021 | 7785 | General | Added
|
| 04/23/2021 | 7783 | General | Changed
|
| 04/16/2021 | 7776 | General | Added
Changed
|
| 04/15 /2021 | 7775 | General | Changed
|
This section details a selection of advanced features of the Google Campaign Manager Cloud.
The Cloud 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.
Use SSL Configuration to adjust how Cloud handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Cloud for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Cloud 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.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
The CData Cloud 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 a tool. 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:
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 Cloud.
This User Defined View configuration file is formatted as follows:
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"
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.
By default, the Cloud 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.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
For sources that do not support SQL-92, the Cloud offloads as much of SQL statement processing as possible to Google Campaign Manager and then processes the rest of the query in memory (client-side). This results in optimal performance.
For data sources with limited query capabilities, the Cloud handles transformations of the SQL query to make it simpler for the Cloud. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The Google Campaign Manager Query Evaluation component examines SQL queries and returns information indicating what parts of the query the Cloud is not capable of executing natively.
The Google Campaign Manager Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.
There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.
Capturing Cloud logging can be very helpful when diagnosing error messages or other unexpected behavior.
You will simply need to set two connection properties to begin capturing Cloud logging.
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described in the following list:
| 1 | Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors. |
| 2 | Setting Verbosity to 2 will log everything included in Verbosity 1 and additional information about the request. |
| 3 | Setting Verbosity to 3 will additionally log HTTP headers, as well as the body of the request and the response. |
| 4 | Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation. |
| 5 | Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands. |
The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.
To refine the logged content further by showing/hiding specific categories of information, see LogModules.
Best Practices for Data Security
Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.
You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property.
This property allows you to filter the logging using a semicolon-separated list of logging modules.
All modules are four characters long. Please note that modules containing three letters have a required trailing blank space. The available modules are:
LogModules=INFO;EXEC;SSL ;SQL ;META;
Note that these modules refine the information as it is pulled after taking the Verbosity into account.
See SELECT Statements for a syntax reference and examples.
See Data Model for information on the capabilities of the Google Campaign Manager API.
Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.
A SELECT statement can consist of the following basic clauses.
The following syntax diagram outlines the syntax supported by the SQL engine of the Cloud:
SELECT {
[ TOP <numeric_literal> | DISTINCT ]
{
*
| {
<expression> [ [ AS ] <column_reference> ]
| { <table_name> | <correlation_name> } .*
} [ , ... ]
}
[ INTO csv:// [ filename= ] <file_path> [ ;delimiter=tab ] ]
{
FROM <table_reference> [ [ AS ] <identifier> ]
} [ , ... ]
[ [
INNER | { { LEFT | RIGHT | FULL } [ OUTER ] }
] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ]
] [ ... ]
[ WHERE <search_condition> ]
[ GROUP BY <column_reference> [ , ... ]
[ HAVING <search_condition> ]
[ UNION [ ALL ] <select_statement> ]
[
ORDER BY
<column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
]
[
LIMIT <expression>
[
{ OFFSET | , }
<expression>
]
]
}
<expression> ::=
| <column_reference>
| @ <parameter>
| ?
| COUNT( * | { [ DISTINCT ] <expression> } )
| { AVG | MAX | MIN | SUM | COUNT } ( <expression> )
| NULLIF ( <expression> , <expression> )
| COALESCE ( <expression> , ... )
| CASE <expression>
WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
[ ELSE { <expression> | NULL } ]
END
| <literal>
| <sql_function>
<search_condition> ::=
{
<expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN } [ <expression> ]
} [ { AND | OR } ... ]
SELECT * FROM CampaignPerformance
SELECT [Device] AS MY_Device FROM CampaignPerformance
SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM CampaignPerformance
SELECT * FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'
SELECT COUNT(*) AS MyCount FROM CampaignPerformance
SELECT COUNT(DISTINCT Device) FROM CampaignPerformance
SELECT DISTINCT Device FROM CampaignPerformance
SELECT Device, MAX(AnnualRevenue) FROM CampaignPerformance GROUP BY DeviceSee Aggregate Functions for details.
SELECT Clicks, Device FROM CampaignPerformance ORDER BY Device ASC
SELECT Clicks, Device FROM CampaignPerformance LIMIT 10
SELECT * FROM CampaignPerformance WHERE Device = @param
Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not
appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from Google Campaign Manager.
SELECT * FROM CampaignPerformance WHERE PseudoColumn = '@PseudoColumn'
Returns the number of rows matching the query criteria.
SELECT COUNT(*) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'
Returns the number of distinct, non-null field values matching the query criteria.
SELECT COUNT(DISTINCT Clicks) AS DistinctValues FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'
Returns the average of the column values.
SELECT Device, AVG(AnnualRevenue) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers' GROUP BY Device
Returns the minimum column value.
SELECT MIN(AnnualRevenue), Device FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers' GROUP BY Device
Returns the maximum column value.
SELECT Device, MAX(AnnualRevenue) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers' GROUP BY Device
Returns the total sum of the column values.
SELECT SUM(AnnualRevenue) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'
The CData Cloud supports standard SQL joins like the following examples.
An inner join selects only rows from both tables that match the join condition:
A left join selects all rows in the FROM table and only matching rows in the JOIN table:
The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.
The current day.
SELECT * FROM MyTable WHERE MyDateField = L_TODAY()
The previous day.
SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()
The following day.
SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()
Every day in the preceding week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()
Every day in the current week.
SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()
Every day in the following week.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()Also available:
The previous n days, excluding the current day.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)
The following n days, including the current day.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)Also available:
Every day in every week, starting n weeks before current week, and ending in the previous week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)
Every day in every week, starting the following week, and ending n weeks in the future.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)Also available:
You can use the SELECT INTO statement to export formatted data to a file.
The following query exports data into a file formatted in comma-separated values (CSV):
SELECT Clicks, Device INTO [csv://CampaignPerformance.txt] FROM [CampaignPerformance] WHERE Device = 'Mobile devices with full browsers'You can specify other formats in the file URI. The possible delimiters are tab, semicolon, and comma with the default being a comma. The following example exports tab-separated values:
SELECT Clicks, Device INTO [csv://CampaignPerformance.txt;delimiter=tab] FROM [CampaignPerformance] WHERE Device = 'Mobile devices with full browsers'You can specify other file formats in the URI. The following example exports tab-separated values:
The Cloud provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.
The Cloud interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and Cloud syntax for the DATENAME function:
SELECT DATENAME(yy,GETDATE())
SELECT DATENAME('yy',GETDATE())
These functions perform string manipulations and return a string value. See STRING Functions for more details.
SELECT CONCAT(firstname, space(4), lastname) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'
These functions perform date and date time manipulations. See DATE Functions for more details.
SELECT CURRENT_TIMESTAMP() FROM CampaignPerformance
These functions provide mathematical operations. See MATH Functions for more details.
SELECT RAND() FROM CampaignPerformance
SELECT CONCAT('Mr.', SPACE(2), firstname, SPACE(4), lastname) FROM CampaignPerformance
Returns the ASCII code value of the left-most character of the character expression.
SELECT ASCII('0');
-- Result: 48
Converts the integer ASCII code to the corresponding character.
SELECT CHAR(48);
-- Result: '0'
Returns the starting position of the specified expression in the character string.
SELECT CHARINDEX('456', '0123456');
-- Result: 4
SELECT CHARINDEX('456', '0123456', 5);
-- Result: -1
Returns the number of UTF-8 characters present in the expression.
SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
-- Result: 11
Returns the string that is the concatenation of two or more string values.
SELECT CONCAT('Hello, ', 'world!');
-- Result: 'Hello, world!'
Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.
SELECT CONTAINS('0123456', '456');
-- Result: 1
SELECT CONTAINS('0123456', 'Not a number');
-- Result: 0
Returns 1 if character_expression ends with character_suffix; otherwise, 0.
SELECT ENDSWITH('0123456', '456');
-- Result: 1
SELECT ENDSWITH('0123456', '012');
-- Result: 0
Returns the number of bytes present in the file at the specified file path.
SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
-- Result: 23684
Returns the value formatted with the specified format.
SELECT FORMAT(12.34, '#');
-- Result: 12
SELECT FORMAT(12.34, '#.###');
-- Result: 12.34
SELECT FORMAT(1234, '0.000E0');
-- Result: 1.234E3
SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
-- Result: 2019-01-01
SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
-- Result: '2019-01-01'
Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.
SELECT FROM_UNIXTIME(1540495231, 1);
-- Result: 2018-10-25 19:20:31
SELECT FROM_UNIXTIME(1540495357385, 0);
-- Result: 2018-10-25 19:22:37
Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.
SELECT HASHBYTES('MD5', 'Test');
-- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
Returns the starting position of the specified expression in the character string.
SELECT INDEXOF('0123456', '456');
-- Result: 4
SELECT INDEXOF('0123456', '456', 5);
-- Result: -1
Replaces null with the specified replacement value.
SELECT ISNULL(42, 'Was NULL');
-- Result: 42
SELECT ISNULL(NULL, 'Was NULL');
-- Result: 'Was NULL'
Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4.5
Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 2
Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
-- Result: '{"data":1}'
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
-- Result: 1
SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
-- Result: 2
Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
-- Result: 4
Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4
Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.
SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 9
Returns the specified number of characters counting from the left of the specified string.
SELECT LEFT('1234567890', 3);
-- Result: '123'
Returns the number of characters of the specified string expression.
SELECT LEN('12345');
-- Result: 5
Returns an integer representing how many characters into the string the substring appears.
SELECT LOCATE('sample','XXXXXsampleXXXXX');
-- Result: 6
Returns the character expression with the uppercase character data converted to lowercase.
SELECT LOWER('MIXED case');
-- Result: 'mixed case'
Returns the character expression with leading blanks removed.
SELECT LTRIM(' trimmed');
-- Result: 'trimmed'
Replaces the characters between start_index and end_index with the mask_character within the string.
SELECT MASK('1234567890','*',);
-- Result: '**********'
SELECT MASK('1234567890','*', 4);
-- Result: '1234******'
SELECT MASK('1234567890','*', 4, 2);
-- Result: '1234****90'
Returns the Unicode character with the specified integer code as defined by the Unicode standard.
Returns the number of bytes present in the expression.
SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
-- Result: 4
Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.
SELECT PATINDEX('123%', '1234567890');
-- Result: 1
SELECT PATINDEX('%890', '1234567890');
-- Result: 8
SELECT PATINDEX('%456%', '1234567890');
-- Result: 4
Returns the starting position of the specified expression in the character string.
SELECT POSITION('456' IN '123456');
-- Result: 4
SELECT POSITION('x' IN '123456');
-- Result: 0
Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.
SELECT QUOTENAME('table_name');
-- Result: '[table_name]'
SELECT QUOTENAME('table_name', '"');
-- Result: '"table_name"'
SELECT QUOTENAME('table_name', '[');
-- Result: '[table_name]'
Replaces all occurrences of a string with another string.
SELECT REPLACE('1234567890', '456', '|');
-- Result: '123|7890'
SELECT REPLACE('123123123', '123', '.');
-- Result: '...'
SELECT REPLACE('1234567890', 'a', 'b');
-- Result: '1234567890'
Repeats the string value the specified number of times.
SELECT REPLACE('x', 5);
-- Result: 'xxxxx'
Returns the reverse order of the string expression.
SELECT REVERSE('1234567890');
-- Result: '0987654321'
Returns the right part of the string with the specified number of characters.
SELECT RIGHT('1234567890', 3);
-- Result: '890'
Returns the character expression after it removes trailing blanks.
SELECT RTRIM('trimmed ');
-- Result: 'trimmed'
Returns the four-character Soundex code, based on how the string sounds when spoken.
SELECT SOUNDEX('smith');
-- Result: 'S530'
Returns the string that consists of repeated spaces.
SELECT SPACE(5);
-- Result: ' '
Returns a section of the string between to delimiters.
SELECT SPLIT('a/b/c/d', '/', 1);
-- Result: 'a'
SELECT SPLIT('a/b/c/d', '/', -2);
-- Result: 'c'
Returns 1 if character_expression starts with character_prefix; otherwise, 0.
SELECT STARTSWITH('0123456', '012');
-- Result: 1
SELECT STARTSWITH('0123456', '456');
-- Result: 0
Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.
SELECT STR('123.456');
-- Result: '123'
SELECT STR('123.456', 2);
-- Result: '**'
SELECT STR('123.456', 10, 2);
-- Result: '123.46'
Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.
SELECT STUFF('1234567890', 3, 2, 'xx');
-- Result: '12xx567890'
Returns the part of the string with the specified length; starts at the specified index.
SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
-- Result: '34'
SELECT SUBSTRING('1234567890' FROM 3);
-- Result: '34567890'
Converts the value of this instance to its equivalent string representation.
SELECT TOSTRING(123);
-- Result: '123'
SELECT TOSTRING(123.456);
-- Result: '123.456'
SELECT TOSTRING(null);
-- Result: ''
Returns the character expression with leading and/or trailing blanks removed.
SELECT TRIM(' trimmed ');
-- Result: 'trimmed'
SELECT TRIM(LEADING FROM ' trimmed ');
-- Result: 'trimmed '
SELECT TRIM('-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
-- Result: '-----trimmed'
Returns the integer value defined by the Unicode standard of the first character of the input expression.
Returns the character expression with lowercase character data converted to uppercase.
SELECT UPPER('MIXED case');
-- Result: 'MIXED CASE'
Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
-- Result: 'a,e,i,o,u'
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
-- Result: 'a;e;i;o;u'
Returns the current date value.
SELECT CURRENT_DATE();
-- Result: 2018-02-01
Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.
SELECT CURRENT_TIMESTAMP();
-- Result: 2018-02-01 03:04:05
Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.
SELECT DATEADD('d', 5, '2018-02-01');
-- Result: 2018-02-06
SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
-- Result: 2018-02-01 05:00:00
Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.
SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
-- Result: 9
SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
-- Result: 12
Returns the datetime value for the specified year, month, and day.
SELECT DATEFROMPARTS(2018, 2, 1);
-- Result: 2018-02-01
Returns the character string that represents the specified date part of the specified date.
SELECT DATENAME('yy', '2018-02-01');
-- Result: '2018'
SELECT DATENAME('dw', '2018-02-01');
-- Result: 'Thursday'
Returns a character string that represents the specified date part of the specified date.
SELECT DATEPART('yy', '2018-02-01');
-- Result: 2018
SELECT DATEPART('dw', '2018-02-01');
-- Result: 5
Returns the datetime value for the specified date parts.
SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
-- Result: 2018-02-01 01:02:03.456
Returns the datetime value for the specified date parts.
SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
-- Result: 2018-02-01 01:02:03.456
Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.
SELECT DATE_TRUNC('05-04-2005', 'YY');
-- Result: '1/1/2005'
SELECT DATE_TRUNC('05-04-2005', 'MM');
-- Result: '5/1/2005'
Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.
SELECT DATE_TRUNC2('year', '2020-02-04');
-- Result: '2020-01-01'
SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
-- Result: '2020-02-02', which is the previous Monday
Returns the integer that specifies the day component of the specified date.
SELECT DAY('2018-02-01');
-- Result: 1
SELECT DAYOFMONTH('04/15/2000');
-- Result: 15
SELECT DAYOFWEEK('04/15/2000');
-- Result: 7
SELECT DAYOFYEAR('04/15/2000');
-- Result: 106
Returns the last day of the month that contains the specified date with an optional offset.
SELECT EOMONTH('2018-02-01');
-- Result: 2018-02-28
SELECT LAST_DAY('2018-02-01');
-- Result: 2018-02-28
SELECT EOMONTH('2018-02-01', 2);
-- Result: 2018-04-30
SELECT FDWEEK('02-08-2018');
-- Result: 2/4/2018
SELECT FDMONTH('02-08-2018');
-- Result: 2/1/2018
SELECT FDQUARTER('05-08-2018');
-- Result: 4/1/2018
Returns the time stamp associated with the Date Modified of the relevant file.
SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
-- Result: 6/25/2019 10:06:58 AM
Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.
SELECT FROM_DAYS(736000); -- Result: 2/6/2015
Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.
SELECT GETDATE();
-- Result: 2018-02-01 03:04:05
Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.
SELECT GETUTCDATE();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the hour component from the provided datetime.
SELECT HOUR('02-02-2020 11:30:00');
-- Result: 11
Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.
SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
-- Result: 1
SELECT ISDATE('Not a date');
-- Result: 0
Returns a time stamp equivalent to exactly one week before the current date.
SELECT LAST_WEEK(); //Assume the date is 3/17/2020 -- Result: 3/10/2020
Returns a time stamp equivalent to exactly one month before the current date.
SELECT LAST_MONTH(); //Assume the date is 3/17/2020 -- Result: 2/17/2020
Returns a time stamp equivalent to exactly one year before the current date.
SELECT LAST_YEAR(); //Assume the date is 3/17/2020 -- Result: 3/10/2019
Returns the last day of the provided week.
SELECT LDWEEK('02-02-2020');
-- Result: 2/8/2020
Returns the last day of the provided month.
SELECT LDMONTH('02-02-2020');
-- Result: 2/29/2020
Returns the last day of the provided quarter.
SELECT LDQUARTER('02-02-2020');
-- Result: 3/31/2020
Returns a date value from a year and a number of days.
SELECT MAKEDATE(2020, 1);
-- Result: 2020-01-01
Returns the minute component from the provided datetime.
SELECT MINUTE('02-02-2020 11:15:00');
-- Result: 15
Returns the month component from the provided datetime.
SELECT MONTH('02-02-2020');
-- Result: 2
Returns the quarter associated with the provided datetime.
SELECT QUARTER('02-02-2020');
-- Result: 1
Returns the second component from the provided datetime.
SELECT SECOND('02-02-2020 11:15:23');
-- Result: 23
Returns the datetime value for the specified date and time.
SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
-- Result: 2018-02-01 01:02:00
Parses the provided string value and returns the corresponding datetime.
SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
-- Result: 4/3/2020
Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.
SELECT SYSDATETIME();
-- Result: 2018-02-01 03:04:05
Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.
SELECT SYSUTCDATETIME();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the time value for the specified time and with the specified precision.
SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
-- Result: 01:02:03.456
Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.
SELECT TO_DAYS('02-06-2015');
-- Result: 736000
Returns the week (of the year) associated with the provided datetime.
SELECT WEEK('02-17-2020 11:15:23');
-- Result: 8
Returns the integer that specifies the year of the specified date.
SELECT YEAR('2018-02-01');
-- Result: 2018
Returns the absolute (positive) value of the specified numeric expression.
SELECT ABS(15);
-- Result: 15
SELECT ABS(-15);
-- Result: 15
Returns the arc cosine, the angle in radians whose cosine is the specified float expression.
SELECT ACOS(0.5);
-- Result: 1.0471975511966
Returns the arc sine, the angle in radians whose sine is the specified float expression.
SELECT ASIN(0.5);
-- Result: 0.523598775598299
Returns the arc tangent, the angle in radians whose tangent is the specified float expression.
SELECT ATAN(10);
-- Result: 1.47112767430373
Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.
SELECT ATN2(1, 1);
-- Result: 0.785398163397448
Returns the smallest integer greater than or equal to the specified numeric expression.
SELECT CEILING(1.3);
-- Result: 2
SELECT CEILING(1.5);
-- Result: 2
SELECT CEILING(1.7);
-- Result: 2
Returns the trigonometric cosine of the specified angle in radians in the specified expression.
SELECT COS(1);
-- Result: 0.54030230586814
Returns the trigonometric cotangent of the angle in radians specified by float_expression.
SELECT COT(1);
-- Result: 0.642092615934331
Returns the angle in degrees for the angle specified in radians.
SELECT DEGREES(3.1415926);
-- Result: 179.999996929531
Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.
SELECT EXP(2);
-- Result: 7.38905609893065
Evaluates the expression.
SELECT EXPR('1 + 2 * 3');
-- Result: 7
SELECT EXPR('1 + 2 * 3 == 7');
-- Result: true
Returns the largest integer less than or equal to the numeric expression.
SELECT FLOOR(1.3);
-- Result: 1
SELECT FLOOR(1.5);
-- Result: 1
SELECT FLOOR(1.7);
-- Result: 1
Returns the greatest of the supplied integers.
SELECT GREATEST(3,5,8,10,1) -- Result: 10
Returns a the equivalent hex for the input value.
SELECT HEX(866849198);
-- Result: 33AB11AE
SELECT HEX('Sample Text');
-- Result: 53616D706C652054657874
Returns the least of the supplied integers.
SELECT LEAST(3,5,8,10,1) -- Result: 1
Returns the natural logarithm of the specified float expression.
SELECT LOG(7.3890560);
-- Result: 1.99999998661119
Returns the base-10 logarithm of the specified float expression.
SELECT LOG10(10000);
-- Result: 4
Returns the integer value associated with the remainder when dividing the dividend by the divisor.
SELECT MOD(10,3); -- Result: 1
Returns the opposite to the real number input.
SELECT NEGATE(10); -- Result: -10 SELECT NEGATE(-12.4) --Result: 12.4
Returns the constant value of pi.
SELECT PI()
-- Result: 3.14159265358979
Returns the value of the specified expression raised to the specified power.
SELECT POWER(2, 10);
-- Result: 1024
SELECT POWER(2, -2);
-- Result: 0.25
Returns the angle in radians of the angle in degrees.
SELECT RADIANS(180);
-- Result: 3.14159265358979
Returns a pseudorandom float value from 0 through 1, exclusive.
SELECT RAND();
-- This result may be different, since the seed is randomized
-- Result: 0.873159630165044
SELECT RAND(1);
-- This result will always be the same, since the seed is constant
-- Result: 0.248668584157093
Returns the numeric value rounded to the specified length or precision.
SELECT ROUND(1.3, 0);
-- Result: 1
SELECT ROUND(1.55, 1);
-- Result: 1.6
SELECT ROUND(1.7, 0, 0);
-- Result: 2
SELECT ROUND(1.7, 0, 1);
-- Result: 1
SELECT ROUND (1.24);
-- Result: 1.0
Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.
SELECT SIGN(0);
-- Result: 0
SELECT SIGN(10);
-- Result: 1
SELECT SIGN(-10);
-- Result: -1
Returns the trigonometric sine of the angle in radians.
SELECT SIN(1);
-- Result: 0.841470984807897
Returns the square root of the specified float value.
SELECT SQRT(100);
-- Result: 10
Returns the square of the specified float value.
SELECT SQUARE(10);
-- Result: 100
SELECT SQUARE(-10);
-- Result: 100
Returns the tangent of the input expression.
SELECT TAN(1);
-- Result: 1.5574077246549
Returns the supplied decimal number truncated to have the supplied decimal precision.
SELECT TRUNC(10.3423,2); -- Result: 10.34
To execute stored procedures, you can use EXECUTE or EXEC statements.
EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.
To execute a stored procedure as an SQL statement, use the following syntax:
{ EXECUTE | EXEC } <stored_proc_name>
{
[ @ ] <input_name> = <expression>
} [ , ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
Reference stored procedure inputs by name:
EXECUTE my_proc @second = 2, @first = 1, @third = 3;
Execute a parameterized stored procedure statement:
EXECUTE my_proc second = @p1, first = @p2, third = @p3;
PIVOT and UNPIVOT can be used to change a table-valued expression into another table.
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"
For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)
The CData Cloud 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.
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 Cloud.
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 are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.
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 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.
| 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. |
Table for running CrossDimensionReach reports saved in DCM or ad-hoc reports.
| 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 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. |
Lists all DoubleClick Campaign Manager files for the user.
| 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 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. |
Table for running Floodlight reports saved in DCM or ad-hoc reports.
| 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 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. |
Table for running PathToConversion reports saved in DCM or ad-hoc reports.
| 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 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. |
Table for running Reach reports saved in DCM or ad-hoc reports.
| 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 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. |
Lists all DoubleClick Campaign Manager reports for the user.
| 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 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). |
Table for running Standard reports saved in DCM or ad-hoc reports.
| 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 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. |
Lists all DoubleClick Campaign Manager user profiles to which the Google user has access.
| 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 are function-like interfaces that extend the functionality of the Cloud 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.
| Name | Description |
| CheckReportStatus | Checks the status of a report. |
| CreateCustomSchema | Creates a custom schema file based for the given ReportID. |
| RunReport | Runs a given report and returns the file ID which can be used to retrieve the results after processing is complete. |
Checks the status of a report.
| 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. |
| 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. |
Creates a custom schema file based for the given ReportID.
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.
| 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. |
| 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. |
Obtains the OAuth access token to be used for authentication with various Google services.
| 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. |
| 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. |
Obtains the OAuth authorization URL used for authentication with various Google services.
| 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. |
| Name | Type | Description |
| URL | String | The URL to complete user authentication. |
Obtains the OAuth access token to be used for authentication with various Google services.
| Name | Type | Description |
| OAuthRefreshToken | String | The refresh token returned from the original authorization code exchange. |
| 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. |
Runs a given report and returns the file ID which can be used to retrieve the results after processing is complete.
| Name | Type | Description |
| ReportId | String | The id for the report in DoubleClick Campaign Manager. |
| Name | Type | Description |
| FileId | String | Whether or not the schema was created successfully. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Google Campaign Manager:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| 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. |
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'
| 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. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| 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. |
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
| 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. |
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'
| 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. |
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'
| 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. |
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'
| 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. |
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 <> ''
| 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. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the Cloud 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 |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| 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 CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData 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.
| 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. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| 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. |
The connection string 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 in the connection string for this provider. Click the links for further details.
| 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. |
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| 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. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| 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. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| 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. |
| RTK | The runtime key used for licensing. |
| 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. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| 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. |
The type of authentication to use when connecting to Google Campaign Manager.
string
"Auto"
The DFA Profile ID. If not specified, the first Profile returned from the UserProfiles service will be used.
string
""
This value can be retrieved from the UserProfiles table or will be retrieved automatically if this value is not set.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
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.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
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.
The access token for connecting using OAuth.
string
""
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.
The verifier code returned from the OAuth authorization URL.
string
""
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.
See to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the Cloud exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file.
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.
The OAuth refresh token for the corresponding OAuth access token.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
The lifetime in seconds of the OAuth AccessToken.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
The Unix epoch timestamp in milliseconds when the current Access Token was created.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| 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. |
The JWT Certificate store.
string
""
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:
| 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).
The type of key store containing the JWT Certificate.
string
"USER"
This property can take one of the following values:
| 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. |
The password for the OAuth JWT certificate.
string
""
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.
The subject of the OAuth JWT certificate.
string
"*"
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, [email protected]". 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.
The issuer of the Java Web Token.
string
""
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.
The user subject for which the application is requesting delegated access.
string
""
The user subject for which the application is requesting delegated access. Typically, the user account name or email address.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
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.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
string
"NONE"
This property specifies the protocol that the Cloud will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Cloud connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Cloud opens a connection to Google Campaign Manager and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Cloud sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Cloud sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
string
""
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Cloud uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
int
0
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
bool
true
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
string
""
The hostname or IP address of a proxy to route HTTP traffic through. The Cloud can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Cloud uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
int
80
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
string
"BASIC"
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Cloud will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
string
""
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Cloud uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
string
"AUTO"
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Cloud will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Cloud uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
A filepath which designates the name and location of the log file.
string
""
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
Core modules to be included in the log file.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
string
"100MB"
When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
A string specifying the maximum file count of log files.
int
-1
When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| 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. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
string
"%APPDATA%\\CData\\GoogleCM Data Provider\\Schema"
The path to a directory which contains the schema files for the Cloud (.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%\\CData\\GoogleCM Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Cloud.
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.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Cloud.
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.
This section provides a complete list of the Caching properties you can configure in the connection string for this provider.
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
bool
false
When AutoCache = true, the Cloud automatically maintains a cache of your table's data in the database of your choice.
When AutoCache = true, the Cloud caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
Specifies the path to the cache when caching to a file.
string
"%APPDATA%\\CData\\GoogleCM Data Provider"
The CacheLocation is a simple, file-based cache.
If left unspecified, the default location is "%APPDATA%\\CData\\GoogleCM Data Provider" with %APPDATA% being set to the user's configuration directory:
The tolerance for stale data in the cache specified in seconds when using AutoCache .
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The Cloud checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
Use offline mode to get the data from the cache instead of the live source.
bool
false
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
This property determines whether or not to cache the table metadata to a file store.
bool
false
As you execute queries with this property set, table metadata in the Google Campaign Manager catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
The Cloud automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| 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. |
| RTK | The runtime key used for licensing. |
| 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. |
The version of the API to use to connect to Campaign Manager.
string
"v4.0"
The version of the API to use to connect to Campaign Manager.
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.
int
-1
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.
These hidden properties are used only in specific use cases.
string
""
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.
| 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. |
The base time interval in seconds between requests that check the availability of the report response. The default value is 10 seconds.
string
"10"
The base time interval between requests that check the availability of the asynchronous response. For long running reports, the Cloud 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.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
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, "*=*".
The timeout in minutes for which the provider will wait for a asycnchronous report response. The default value is 60 minutes.
string
"60"
The timeout in minutes for which the Cloud will wait for a asycnchronous report response. The default value is 60 minutes. For long running reports, the Cloud 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 Cloud 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. ;
The runtime key used for licensing.
string
""
The RTK property may be used to license a build.
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
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 Cloud throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Cloud 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 Cloud.
This User Defined View configuration file is formatted as follows:
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"