The CData Sync App provides a straightforward way to continuously pipeline your Google Campaign Manager data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Google Campaign Manager connector can be used from the CData Sync application to pull data from Google Campaign Manager and move it to any of the supported destinations.
Create a connection to Google Campaign Manager by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Google Campaign Manager icon is not available, click the Add More icon to download and install the Google Campaign Manager connector from the CData site.
Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.
Provide the following connection properties before adding the authentication properties.
The Sync App 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 Sync App can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.
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 Sync App 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 Sync App.
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 Sync App. 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 Sync App 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'
This section details a selection of advanced features of the Google Campaign Manager Sync App.
The Sync App 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 Sync App 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 Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App 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.
By default, the Sync App 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:
The CData Sync App 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 Sync App.
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. |
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.
For more information on establishing a connection, see Establishing a Connection.
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. |
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 |
LogModules | Core modules to be included in the log file. |
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 |
APIVersion | The version of the API to use to connect to Campaign Manager. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
PollingInterval | The base time interval in seconds between requests that check the availability of the report response. The default value is 10 seconds. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryTimeout | The timeout in minutes for which the provider will wait for a asycnchronous report response. The default value is 60 minutes. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
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.
The DFA Profile ID. If not specified, the first Profile returned from the UserProfiles service will be used.
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. |
The client Id assigned when you register your application with an OAuth authorization server.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App 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 Sync App opens a connection to Google Campaign Manager and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App 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 Sync App 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.
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 Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
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.
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.
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.
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.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App 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 Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
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.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App 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.
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.
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 Sync App 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.
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 Sync App 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 .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App 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 |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
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.
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.
The path to a directory which contains the schema files for the Sync App (.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.
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.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
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.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
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 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. |
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.
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.
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.
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.
The base time interval between requests that check the availability of the asynchronous response. For long running reports, the Sync App 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.
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.
The timeout in minutes for which the Sync App will wait for a asycnchronous report response. The default value is 60 minutes. For long running reports, the Sync App 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 Sync App 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 value in seconds until the timeout error is thrown, canceling the operation.
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 Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App 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 Sync App.
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"