Establishing a Connection

Adding a Connection to Google Ad Manager

To add a connection to Google Ad Manager:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Google Ad Manager icon is not available, click the Add More icon to download and install the Google Ad Manager connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Google Ad Manager

Provide the following connection properties before adding the authentication properties.

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

Authenticating to Google Ad Manager

The Sync App supports using user accounts and GCP instance accounts for authentication.

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

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

User Accounts (OAuth)

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

Web Applications

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

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

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

Then call stored procedures to complete the OAuth exchange:

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

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

Automatic Refresh of the OAuth Access Token

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

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

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

Manual Refresh of the OAuth Access Token

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

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

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

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

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

Headless Machines

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

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

Option 1: Obtain and Exchange a Verifier Code

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

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

Choose one of these options:
- If you are using the Embedded OAuth Application click Google Ad Manager OAuth endpoint to open the endpoint in your browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

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

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

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

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

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

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

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

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

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

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

GCP Instance Accounts

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.

OAuth Scopes and Endpoints

Required Scopes and Endpoint Domains for Google Ad Manager

When integrating with Google Ad Manager, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the Google Ad Manager Sync App.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for Google Ad Manager


Scope	Description
googleapis.com/auth/dfp	This is the default scope and the only scope available.

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for Google Ad Manager


Domain	Always Required	Description
ads.google.com	TRUE	The subdomain used to make API calls and retrieve data. For example, `https://ads.google.com/apis/ads/publisher/v202402/ReportService`.
accounts.google.com	TRUE	The subdomain used for OAuth.
admanager.google.com	FALSE	This is not used by the driver to retrieve data. It may be used to retrieve the network code when establishing a connection. For example, `https://admanager.google.com/46219023#home` where 46219023 is the value of the NetworkCode.

Advanced Features

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

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

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

Data Model

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

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

Accessing Saved Query Reports

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

Inserting custom fields

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

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

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

Tables

The Sync App models the data in Google Ad Manager as a list of tables in a relational database that can be queried using standard SQL statements.

Google Ad Manager Connector for CData Sync Tables


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

Companies

Create, update, and query DoubleClick for Publishers Companies.

Select

The following queries are processed server side.

Retrieve a list of Companies. For example:

SELECT * FROM [Companies]

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

SELECT * FROM [Companies] WHERE Id = '4410125029'

Insert

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

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

Update

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

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

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Uniquely identifies the Company. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
Name	String	False	The full name of the company. This attribute is required and has a maximum length of 127 characters.
Type	String	False	Specifies what kind of company this is. This attribute is required. The allowed values are HOUSE_ADVERTISER, HOUSE_AGENCY, ADVERTISER, AGENCY, AD_NETWORK, PARTNER, CHILD_PUBLISHER, VIEWABILITY_PROVIDER, UNKNOWN.
Address	String	False	Specifies the address of the company. This attribute is optional and has a maximum length of 65,535 characters.
Email	String	False	Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters.
FaxPhone	String	False	Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters.
PrimaryPhone	String	False	Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters.
ExternalId	String	False	Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters.
Comment	String	False	Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters.
CreditStatus	String	False	Specifies the company's credit status. This attribute is optional and defaults to CreditStatus.ACTIVE when basic credit status settings are enabled, and CreditStatus.ON_HOLD when advanced credit status settings are enabled. The allowed values are ACTIVE, ON_HOLD, CREDIT_STOP, INACTIVE, BLOCKED.
Settings	String	False	Specifies the default billing settings of this Company. This attribute is optional.
AppliedLabels	String	False	The set of labels applied to this company.
PrimaryContactId	Long	False	The ID of the Contact who is acting as the primary contact for this company. This attribute is optional.
AppliedTeamIds	String	False	The IDs of all teams that this company is on directly.
ThirdPartyCompanyId	Int	False	Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional.
LastModifiedDateTime	Datetime	True	The date and time this company was last modified.
ChildPublisher	String	False	Info required for when Company Type is CHILD_PUBLISHER.
ViewabilityProvider	String	False	Info required for when Company Type is VIEWABILITY_PROVIDER.

Contacts

Create, update, and query DoubleClick for Publishers Contacts.

Select

The following queries are processed server side.

Retrieve a list of Contacts. For example:

SELECT * FROM [Contacts]

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

SELECT * FROM [Contacts] WHERE Id = '4940864'

Insert

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

INSERT INTO [Contacts] (Name, CompanyId) VALUES ('Cont', '4415064655')

Update

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

UPDATE [Contacts] SET Name = 'New Contact', Email = '[email protected]' WHERE Id = '4944377'

Delete

The DELETE operation is not supported for this table.

Columns


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

Creatives

Update and query DoubleClick for Publishers Creatives.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Creatives. For example:

SELECT * FROM [Creatives]

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

SELECT * FROM [Creatives] WHERE Id = '138206791680'

Update

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

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

Insert

The INSERT operation is not supported for this table.

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
AdvertiserId	Long	False	The ID of the advertiser that owns the creative. This attribute is required.
Id [KEY]	Long	True	Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
Name	String	False	The name of the creative. This attribute is required and has a maximum length of 255 characters.
Width	Int	False	The width of the Creative.
Height	Int	False	The height of the Creative.
IsAspectRatio	Bool	False	Whether the size defined by height and width represents an aspect ratio.
PreviewUrl	String	True	The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.
PolicyLabels	String	True	Set of policy labels detected for this creative. This attribute is read-only.
AppliedLabels	String	False	The set of labels applied to this creative.
LastModifiedDateTime	Datetime	True	The date and time this creative was last modified.
ThirdPartyDataDeclaration	String	False	The third party companies associated with this creative. This is distinct from any associated companies that Google may detect programmatically.
Snippet	String	True	The HTML snippet that this creative delivers. This attribute is required.
ExpandedSnippet	String	True	The HTML snippet that this creative delivers with macros expanded. This attribute is read-only and is set by Google.
CreativeTemplateVariableValues	String	False	Stores values of CreativeTemplateVariable in the CreativeTemplate.
SslScanResult	String	True	The SSL compatibility scan result for this creative.
SslManualOverride	String	False	The manual override for the SSL compatibility of this creative. This attribute is optional and defaults to SslManualOverride.NO_OVERRIDE.
LockedOrientation	String	True	A locked orientation for this creative to be displayed in.
AssetSize	String	True	The asset size of an internal redirect creative. Note that this may differ from size if users set overrideSize to true. This attribute is read-only and is populated by Google.
InternalRedirectUrl	String	False	The internal redirect URL of the DFA or DART for Publishers hosted creative. This attribute has a maximum length of 1024 characters.
IsSafeFrameCompatible	Bool	True	Whether the Creative is compatible for SafeFrame rendering.
Html5Asset	String	False	The HTML5 asset. To preview the HTML5 asset, use the CreativeAsset.assetUrl. In this field, the CreativeAsset.assetByteArray must be a zip bundle and the CreativeAsset.fileName must have a zip extension.
DestinationUrl	String	False	The URL the user is directed to if they click on the creative. This attribute is only required if the template snippet contains the %u or %%DEST_URL%% macro. It has a maximum length of 1024 characters
DestinationUrlType	String	False	The action that should be performed if the user clicks on the creative. This attribute is optional and defaults to DestinationUrlType.CLICK_TO_WEB.
HtmlSnippet	String	False	The HTML snippet that this creative delivers.
CustomCreativeAssets	String	False	A list of file assets that are associated with this creative, and can be referenced in the snippet.
OverrideSize	Bool	True	Allows the creative size to differ from the actual HTML5 asset size. This attribute is optional. thirdPartyImpressionTrackingUrls.
IsInterstitial	Bool	False	True if this internal redirect creative is interstitial.
PrimaryImageId	Long	True	Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.
PrimaryImageName	String	True	The name of the creative. This attribute is required and has a maximum length of 255 characters.
PrimaryImageSize	Long	True	Primary image size.
PrimaryImageUrl	String	True	Primary image url.
AltText	String	False	Alternative text to be rendered along with the creative used mainly for accessibility. This field is optional and has a maximum length of 500 characters.
ThirdPartyImpressionTrackingUrls	String	False	A list of impression tracking URL to ping when this creative is displayed. This field is optional and each string has a maximum length of 1024 characters.
AmpRedirectUrl	String	False	The URL of the AMP creative.

CustomFields

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of CustomFields. For example:

SELECT * FROM [CustomFields]

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

SELECT * FROM [CustomFields] WHERE Id = '1238676'

Insert

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

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

Update

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

UPDATE [CustomFields] SET Description = 'New Description' WHERE Id = '1238676'

Delete

The DELETE operation is not supported for this table.

Columns


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

CustomTargetingKeys

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of CustomFields. For example:

SELECT * FROM [CustomTargetingKeys]

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

SELECT * FROM [CustomTargetingKeys] WHERE Id = '10721398'

INSERT

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

INSERT INTO [CustomTargetingKeys] (Name, Type) VALUES ('tg_key', 'PREDEFINED')

Update

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

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

Delete

The DELETE operation is not supported for this table.

Columns


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

CustomTargetingValues

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of custom targeting values. For example:

SELECT * FROM [CustomTargetingValues] WHERE CustomTargetingKeyId IN (SELECT Id FROM [CustomTargetingKeys])

The CustomTargetingKeyId is required to execute a SELECT query.

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

SELECT * FROM [CustomTargetingValues] WHERE CustomTargetingKeyId = '13684797' AND Id = '448574026142'

Insert

To create a new Custom Targeting Value, the CustomTargetingKeyId, and Name fields are required.

INSERT INTO [CustomTargetingValues] (CustomTargetingKeyId, Name) VALUES ('13684797', 'TestName')

Update

You can update the DisplayName only by specifying the CustomTargetingKeyId column (to update multiple values), and optionally the Id column (to update a specific value).

UPDATE [CustomTargetingValues] SET DisplayName = 'OtherValue' WHERE CustomTargetingKeyId = '13684797' AND Id = '448579390145'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
CustomTargetingKeyId	Long	False	The ID of the CustomTargetingKey for which this is the value.
Id [KEY]	Long	True	The ID of the CustomTargetingValue. This value is readonly and is populated by Google.
Name	String	False	Name of the value. This can be used for encoding . If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values. For example, you can create key/value g1=abc to represent gender=female. Values can contain up to 40 characters each.
DisplayName	String	False	Descriptive name for the value.
MatchType	String	False	The way in which the CustomTargetingValue.name strings will be matched. This match type can not be used within an audience segment rule. This match type can not be used within an audience segment rule. This match type can not be used within line item targeting. This match type can not be used within line item targeting. The allowed values are EXACT, BROAD, PREFIX, BROAD_PREFIX, SUFFIX, CONTAINS, UNKNOWN.
Status	String	True	Status of the CustomTargetingValue. This field is read-only. A value can be activated and deactivated by calling CustomTargetingService.performCustomTargetingValueAction. The allowed values are ACTIVE, INACTIVE, UNKNOWN.

Inventories

Create, update, and query DoubleClick for Publishers Inventories.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Inventories. For example:

SELECT * FROM [Inventories]

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

SELECT * FROM [Inventories] WHERE Id = '21619885919'

Insert

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

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

Update

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

UPDATE [Inventories] SET Name = 'NewAdUnitName' WHERE Id = '45429003'

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Uniquely identifies the AdUnit. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.
ParentId	String	False	The ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.
HasChildren	Boolean	True	This field is set to true if the ad unit has any children. This attribute is read-only and is populated by Google.
ParentPath	String	True	The path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.
Name	String	False	The name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.
Description	String	False	A description of the ad unit. This value is optional and its maximum length is 65,535 characters.
TargetWindow	String	False	The value to use for the HTML link's target attribute. This value is optional and will be interpreted as TargetWindow.TOP if left blank. The allowed values are TOP, BLANK.
Status	String	True	The status of this ad unit. It defaults to InventoryStatus.ACTIVE. This value cannot be updated directly using InventoryService.updateAdUnit. It can only be modified by performing actions via InventoryService.performAdUnitAction. The allowed values are ACTIVE, INACTIVE, ARCHIVED.
AdUnitCode	String	False	A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its adUnitCode cannot be changed.
AdUnitSizes	String	False	The permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the sizes attribute.
IsInterstitial	Boolean	False	Whether this is an interstitial ad unit.
IsNative	Boolean	False	Whether this is a native ad unit.
IsFluid	Boolean	False	Whether this is a fluid ad unit.
ExplicitlyTargeted	Boolean	False	If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.
AdSenseSettings	String	False	AdSense specific settings. To overwrite this, set the adSenseSettingsSource to PropertySourceType.DIRECTLY_SPECIFIED when setting the value of this field.
AdSenseSettingsSource	String	False	Specifies the source of adSenseSettings value. To revert an overridden value to its default, set this field to PropertySourceType.PARENT. The allowed values are PARENT, DIRECTLY_SPECIFIED, UNKNOWN.
AppliedLabelFrequencyCaps	String	False	The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.
EffectiveLabelFrequencyCaps	String	True	Contains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.
AppliedLabels	String	True	The set of labels applied directly to this ad unit.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
EffectiveTeamIds	String	True	The IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.
AppliedTeamIds	String	False	The IDs of all teams that this ad unit is on directly.
LastModifiedDateTime	Datetime	False	The date and time this ad unit was last modified.
SmartSizeMode	String	False	The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes. The allowed values are UNKNOWN, NONE, SMART_BANNER, DYNAMIC_SIZE.
RefreshRate	Int	False	The interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.
ExternalSetTopBoxChannelId	String	True	Specifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if isSetTopBoxEnabled is true. This attribute is read-only.
IsSetTopBoxEnabled	Boolean	True	Flag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.
ApplicationId	Long	False	The MobileApplication.applicationId for the CTV application that this ad unit is within. This attribute is optional.

Labels

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Labels. For example:

SELECT * FROM [Labels]

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

SELECT * FROM [Labels] WHERE Id = '370450571'

Insert

To create a new Label, the Name field is required.

INSERT INTO [Labels] (Name) VALUES ('new lbl')

Update

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

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

Delete

The DELETE operation is not supported for this table.

Columns


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

LineItemCreativeAssociations

Query DoubleClick for Publishers LineItemCreativeAssociations.

Columns


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

LineItems

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of LineItems. For example:

SELECT * FROM [LineItems]

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

SELECT * FROM [LineItems] WHERE Id = '4377540922'

Insert

To create a new LineItem, the following fields are required: OrderId, Name, LineItemType, CurrencyCode, MicroAmount, CostType, CreativePlaceholdersAggregate, GoalType, GoalUnits, and InventoryTargetingAggregate. Note that other columns could be required depending on data chosen for certain columns.

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

Update

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

UPDATE [LineItems] SET DeliveryRateType = 'EVENLY' WHERE Id = '4377540922'

Delete

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

DELETE FROM [LineItems] WHERE Id = '4377865094'

Columns


Name	Type	ReadOnly	Description
OrderId	Long	False	The ID of the Order to which the LineItem belongs. This attribute is required.
Id [KEY]	Long	True	Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created.
Name	String	False	The name of the line item. This attribute is required and has a maximum length of 255 characters.
ExternalId	String	False	An identifier for the LineItem that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
OrderName	String	True	The name of the Order. This value is read-only.
StartDateTime	Datetime	False	The date and time on which the LineItem is enabled to begin serving. This attribute is required unless LineItem.StartDateTimeType is set to IMMEDIATELY or ONE_HOUR_FROM_NOW.
StartTimeZoneId	String	False	The start date time timezone id of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles).
StartDateTimeType	String	False	Specifies whether to start serving to the LineItem right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.
EndDateTime	Datetime	False	The date and time on which the LineItem will stop serving. This attribute is required unless LineItem.unlimitedEndDateTime is set to true. If specified, it must be after the LineItem.startDateTime. This end date and time does not include auto extension days.
EndTimeZoneId	String	False	The end date time timezone id of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles).
AutoExtensionDays	Int	False	The number of days to allow a line item to deliver past its endDateTime. A maximum of 7 days is allowed. This feature is only available for Ad Manager 360 accounts.
UnlimitedEndDateTime	Bool	False	Specifies whether or not the LineItem has an end time. This attribute is optional and defaults to false. It can be be set to true for only line items of type LineItemType.SPONSORSHIP, LineItemType.NETWORK, LineItemType.PRICE_PRIORITY and LineItemType.HOUSE.
CreativeRotationType	String	False	The strategy used for displaying multiple Creative objects that are associated with the LineItem. This attribute is required.
DeliveryRateType	String	False	The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY or DeliveryRateType.FRONTLOADED depending on the network's configuration.
DeliveryForecastSource	String	False	Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and defaults to DeliveryForecastSource.HISTORICAL.
CustomPacingCurve	String	False	The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is DeliveryForecastSource.CUSTOM_PACING_CURVE.
RoadblockingType	String	False	The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional and defaults to RoadblockingType.ONE_OR_MORE.
SkippableAdType	String	False	The nature of the line item's creatives' skippability. This attribute is optional, only applicable for video line items, and defaults to SkippableAdType.NOT_SKIPPABLE.
FrequencyCaps	String	False	The set of frequency capping units for this LineItem. This attribute is optional.
LineItemType	String	False	Indicates the line item type of a LineItem. This attribute is required. The line item type determines the default priority of the line item. More information can be found on the Ad Manager Help Center.
Priority	Int	False	The priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the LineItemType. Each line item type has a default, minimum, and maximum priority value. This field can only be edited by certain networks, otherwise a PermissionError will occur.
CurrencyCode	String	False	Three letter currency code in string format.
MicroAmount	Long	False	Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
ValueCostPerUnit	String	False	An amount to help the adserver rank inventory. LineItem.valueCostPerUnit artificially raises the value of inventory over the LineItem.costPerUnit but avoids raising the actual LineItem.costPerUnit. This attribute is optional and defaults to a Money object in the local currency with Money.microAmount 0.
CostType	String	False	The method used for billing this LineItem. This attribute is required.
DiscountType	String	False	The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to LineItemDiscountType.PERCENTAGE.
Discount	Double	True	The number here is either a percentage or an absolute value depending on the LineItemDiscountType. If the LineItemDiscountType is LineItemDiscountType.PERCENTAGE, then only non-fractional values are supported.
ContractedUnitsBought	Long	True	This attribute is only applicable for certain line item types and acts as an 'FYI' or note, which does not impact adserving or other backend systems. For LineItemType.SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For LineItemType.STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a 'FYI' for traffickers to manually intervene with the LineItem when needed. This attribute is only available for LineItemType.STANDARD line items if you have this feature enabled on your network.
CreativePlaceholdersAggregate	String	False	Details about the creatives that are expected to serve through this LineItem. This attribute is required and replaces the creativeSizes attribute.
ActivityAssociations	String	False	This attribute is required and meaningful only if the LineItem.costType is CostType.CPA.
EnvironmentType	String	False	The environment that the LineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
AllowedFormats	String	False	The set of allowedFormats that this programmatic line item can have. If the set is empty, this line item allows all formats.
CompanionDeliveryOption	String	False	The delivery option for companions. Setting this field is only meaningful if the following conditions are met: the Guaranteed roadblocks feature is enabled on your network, and environmentType is EnvironmentType.VIDEO_PLAYER or roadblockingType is RoadblockingType.CREATIVE_SET. This field is optional and defaults to CompanionDeliveryOption.OPTIONAL if the conditions are met. In all other cases it defaults to CompanionDeliveryOption.UNKNOWN and is not meaningful.
AllowOverbook	Bool	False	The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types LineItemType.SPONSORSHIP and LineItemType.STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field will not persist on the line item itself, and the value will only affect the current request.
SkipInventoryCheck	Bool	False	The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field will not persist on the line item itself, and the value will only affect the current request.
SkipCrossSellingRuleWarningChecks	Bool	False	True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false.
ReserveAtCreation	Bool	False	The flag indicates whether inventory should be reserved when creating a line item of types LineItemType.SPONSORSHIP and LineItemType.STANDARD in an unapproved Order. The default value is false.
Stats	String	True	Contains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for a line item yet.
DeliveryIndicator	String	True	Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be null if the delivery indicator information is not available due to one of the following reasons: The line item is not delivering, has an unlimited goal or cap or has a percentage based goal or cap.
DeliveryData	String	True	Delivery data provides the number of clicks or impressions delivered for a LineItem in the last 7 days. This attribute is readonly and is populated by Google. This will be null if the delivery data cannot be computed due to one of the following reasons: The line item is not deliverable, has completed delivering more than 7 days ago or has an absolute-based goal.
Budget	String	True	The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
Status	String	True	The status of the LineItem. This attribute is readonly.
ReservationStatus	String	True	Describes whether or not inventory has been reserved for the LineItem. This attribute is readonly and is assigned by Google.
IsArchived	Bool	True	The archival status of the LineItem. This attribute is readonly.
WebPropertyCode	String	False	The web property code used for dynamic allocation line items. This web property is only required with line item types LineItemType.AD_EXCHANGE and LineItemType.ADSENSE.
AppliedLabels	String	False	The set of labels applied directly to this line item.
EffectiveAppliedLabels	String	True	Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
DisableSameAdvertiserCompetitiveExclusion	Bool	False	If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
LastModifiedByApp	String	True	The application that last modified this line item. This attribute is read only and is assigned by Google.
Notes	String	False	Provides any additional notes that may annotate the LineItem. This attribute is optional and has a maximum length of 65,535 characters.
CompetitiveConstraintScope	String	False	The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field is optional, defaults to CompetitiveConstraintScope.POD, and only applies to video line items.
LastModifiedDateTime	Datetime	True	The date and time this line item was last modified.
CreationDateTime	Datetime	True	This attribute may be null for line items created before this feature was introduced.
IsMissingCreatives	Bool	True	Indicates if a LineItem is missing any creatives for the creativePlaceholders specified. Creatives can be considered missing for several reasons including: Not enough creatives of a certain size have been uploaded or The Creative.appliedLabels of an associated Creative do not match the CreativePlaceholder.effectiveAppliedLabels of the LineItem.
ProgrammaticCreativeSource	String	False	Indicates the ProgrammaticCreativeSource of the programmatic line item. This is a read-only field. Any changes must be made on the ProposalLineItem.
ThirdPartyMeasurementSettings	String	False
YoutubeKidsRestricted	Bool	False	Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the Ad Manager Help Center for more information.
VideoMaxDuration	Long	True	The max duration of a video creative associated with this LineItem in milliseconds. This attribute is only meaningful for video line items. For version v202011 and earlier, this attribute is optional and defaults to 0. For version v202102 and later, this attribute is required for video line items and must be greater than 0.
GoalType	String	False	The type of the goal for the LineItem. It defines the period over which the goal for LineItem should be reached.
GoalUnitType	String	False	The type of the goal unit for the LineItem.
GoalUnits	Int	False	If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the LineItem.
SecondaryGoals	String	False	The secondary goals that this LineItem is associated with. It is required and meaningful only if the LineItem.costType is CostType.CPA or if the LineItem.lineItemType is LineItemType.SPONSORSHIP and LineItem.costType is CostType.CPM.
GrpSettings	String	False	Contains the information for a line item which has a target GRP demographic.
DealInfo	String	False	The deal information associated with this line item, if it is programmatic.
ViewabilityProviderCompanyIds	String	False	Optional IDs of the Company that provide ad verification for this line item. Company.Type.VIEWABILITY_PROVIDER.
ChildContentEligibility	String	True	Child content eligibility designation for this line item. This field is optional and defaults to ChildContentEligibility.DISALLOWED.
CustomVastExtension	String	True	Custom XML to be rendered in a custom VAST response at serving time.
RepeatedCreativeServingEnabled	Bool	False	Indicates whether repeated creative serving is enabled for this line item.
GeoTargetingAggregate	String	False	Specifies what geographical locations are targeted by the LineItem. This attribute is optional.
InventoryTargetingAggregate	String	False	Specifies what inventory is targeted by the LineItem. This attribute is required. The line item must target at least one ad unit or placement.
CustomTargetingAggregate	String	False	Specifies the collection of custom criteria that is targeted by the LineItem.
CreativeTargetings	String	False	A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a creative placeholder's CreativePlaceholder.targetingName field by referencing the creative targeting's name. It also needs to be re-specified in the LineItemCreativeAssociation.targetingName field when associating a line item with a creative that fits into that placeholder.
CustomFieldName	String	True	This is the name of the custom field. There will be as many custom columns as custom fields are related to LineItems.

MobileApplications

Create and query DoubleClick for Publishers Mobile Applications.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of MobileApplications. For example:

SELECT * FROM [MobileApplications]

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

SELECT * FROM [MobileApplications] WHERE Id = '370450571'

Insert

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

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

Update

The UPDATE operation is not supported for this table.

Delete

The DELETE operation is not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Uniquely identifies the mobile application. This attribute is read-only and is assigned by Google when a mobile application is claimed.
ApplicationId	Long	True	Uniquely identifies the mobile application. This attribute is read-only and is assigned by Google when a mobile application is claimed. The id field is being deprecated in favor of this new ID space.
DisplayName	String	False	The display name of the mobile application. This attribute is required and has a maximum length of 255 characters.
AppStoreId	String	False	The app store ID of the app to claim. This attribute is required for creation and then is read-only.
AppStores	String	False	The app stores the mobile application belongs to. This attribute is required for creation and is mutable to allow for third party app store linking. Possible values include APPLE_ITUNES, GOOGLE_PLAY, ROKU, AMAZON_FIRETV, PLAYSTATION, XBOX, SAMSUNG_TV, AMAZON_APP_STORE, OPPO_APP_STORE, SAMSUNG_APP_STORE, VIVO_APP_STORE, and XIAOMI_APP_STORE.
IsArchived	Boolean	True	The archival status of the mobile application. This attribute is read-only.
AppStoreName	String	True	The name of the application on the app store. This attribute is read-only and populated by Google.
ApplicationCode	String	True	The application code used to identify the app in the SDK. This attribute is read-only and populated by Google. Note that the UI refers to this as 'App ID'.
DeveloperName	String	True	The name of the developer of the mobile application. This attribute is read-only and populated by Google.
Platform	String	True	The platform the mobile application runs on. This attribute is read-only and populated by Google. The allowed values are UNKNOWN, ANDROID, IOS, ROKU, AMAZON_FIRETV, PLAYSTATION, XBOX, SAMSUNG_TV.
IsFree	Boolean	True	Whether the mobile application is free on the app store it belongs to. This attribute is read-only and populated by Google.
DownloadUrl	String	True	The download URL of the mobile application on the app store it belongs to. This attribute is read-only and populated by Google.

Orders

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Orders. For example:

SELECT * FROM [ Orders ]

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

SELECT * FROM [Orders] WHERE Id = '2112977260'

Insert

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

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

Update

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

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

Delete

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

DELETE FROM [Orders] WHERE Id = '2108997295'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	False	The unique ID of the Order. This value is readonly and is assigned by Google.
Name	String	False	The name of the Order. This value is required to create an order and has a maximum length of 255 characters.
StartDateTime	Datetime	True	The date and time at which the Order and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest LineItem.startDateTime.
EndDateTime	Datetime	True	The date and time at which the Order and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest LineItem.endDateTime.
UnlimitedEndDateTime	Bool	False	Specifies whether or not the Order has an unlimited end date. This attribute is readonly and is true if any of the order's line items has LineItem.unlimitedEndDateTime set to true.
Status	String	True	The status of the Order. This attribute is read-only.
IsArchived	Bool	False	The archival status of the Order. This attribute is readonly.
Notes	String	False	Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters.
ExternalOrderId	Int	False	An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional.
PoNumber	String	False	The purchase order number for the Order. This value is optional and has a maximum length of 63 characters.
CurrencyCode	String	True	The ISO currency code for the currency used by the Order. This value is read-only and is the network's currency code.
AdvertiserId	Long	False	The unique ID of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. This attribute is required.
AdvertiserContactIds	String	False	List of IDs for advertiser contacts of the order.
AgencyId	Long	False	The unique ID of the Company, which is of type Company.Type.AGENCY, with which this order is associated. This attribute is optional.
AgencyContactIds	String	False	List of IDs for agency contacts of the order.
CreatorId	Long	True	The unique ID of the User who created the Order on behalf of the advertiser. This value is readonly and is assigned by Google.
TraffickerId	Long	False	The unique ID of the User responsible for trafficking the Order. This value is required for creating an order
SecondaryTraffickerIds	String	False	The IDs of the secondary traffickers associated with the order. This value is optional.
SalespersonId	Long	False	The unique ID of the User responsible for the sales of the Order. This value is optional.
SecondarySalespersonIds	String	False	The IDs of the secondary salespeople associated with the order. This value is optional.
TotalImpressionsDelivered	Long	True	Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google.
TotalClicksDelivered	Long	True	Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google.
TotalViewableImpressionsDelivered	Long	True	Total viewable impressions delivered for all line items of this Order. This value is read-only and is assigned by Google. Starting in v201705, this will be null when the order does not have line items trafficked against a viewable impressions goal.
TotalBudget	String	False	Total budget for all line items of this Order. This value is a readonly field assigned by Google and is calculated from the associated LineItem.costPerUnit values.
AppliedLabels	String	False	The set of labels applied directly to this order.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
LastModifiedByApp	String	True	The application which modified this order. This attribute is read only and is assigned by Google.
IsProgrammatic	Bool	False	Specifies whether or not the Order is a programmatic order. This value is optional and defaults to false.
AppliedTeamIds	String	False	The IDs of all teams that this order is on directly.
LastModifiedDateTime	Datetime	True	The date and time this order was last modified.
CustomFieldName	String	True	This is the name of the custom field. There will be as many custom columns as custom fields are related to Orders.

Placements

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Placements. For example:

SELECT * FROM [Placements]

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

SELECT * FROM [Placements] WHERE Id = '28544791'

Insert

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

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

Update

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

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

Delete

The DELETE operation is not supported for this table.

Columns


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

ProposalLineItems

Create, update, and query DoubleClick for Publishers ProposalLineItems.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the ProposalLineItem. This attribute is read-only.
ProposalId	Long	False	The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly.
Name	String	False	The name of the ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
StartDateTime	Datetime	False	The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The DateTime.timeZoneID is required if start date time is not null. This attribute becomes readonly once the ProposalLineItem has started delivering.
EndDateTime	Datetime	False	The date and time at which the line item associated with the ProposalLineItem stops beening served. This attribute is optional during creation, but required and must be after the startDateTime. The DateTime.timeZoneID is required if end date time is not null.
TimeZoneId	String	False	The time zone ID in tz database format (e.g. 'America/Los_Angeles') for this ProposalLineItem. The number of serving days is calculated in this time zone. So if rateType is RateType.CPD, it will affect the cost calculation. The startDateTime and endDateTime will be returned in this time zone. This attribute is optional and defaults to the network's time zone. This attribute is read-only when using programmatic guaranteed, using sales management, or when using programmatic guaranteed, not using sales management.
InternalNotes	String	False	Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
IsArchived	Boolean	True	The archival status of the ProposalLineItem. This attribute is read-only.
Goal	String	False	The goal(i.e. contracted quantity, quantity or limit) that this ProposalLineItem is associated with, which is used in its pacing and budgeting. Goal.units must be greater than 0 when the proposal line item turns into a line item, Goal.goalType and Goal.unitType are readonly. For a Preferred deal ProposalLineItem, the goal type can only be GoalType.NONE.
SecondaryGoals	String	False	The secondary goals that this ProposalLineItem is associated with. For a programmatic line item with the properties RateType.CPM and LineItemType.SPONSORSHIP, this field will have one goal which describes the impressions cap. For other cases, this field is an empty list.
ContractedUnitsBought	Long	False	The contracted number of impressions or clicks. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is false, then this represents the lifetime minimum impression. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is true, then this represents the daily minimum impression. This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only.
DeliveryRateType	String	False	The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is required. For a Preferred deal ProposalLineItem, the value can only be DeliveryRateType.FRONTLOADED. The allowed values are EVENLY, FRONTLOADED, AS_FAST_AS_POSSIBLE.
RoadblockingType	String	False	The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONE_OR_MORE if not specified by the product. The allowed values are ONLY_ONE, ONE_OR_MORE, AS_MANY_AS_POSSIBLE, ALL_ROADBLOCK, CREATIVE_SET.
CompanionDeliveryOption	String	False	The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error. The allowed values are OPTIONAL, AT_LEAST_ONE, ALL, UNKNOWN.
VideoMaxDuration	Long	False	The max duration of a video creative associated with this ProposalLineItem in milliseconds. This attribute is optional, defaults to the Product.videoMaxDuration on the Product it was created with, and only meaningful if this is a video proposal line item.
VideoCreativeSkippableAdType	String	False	The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType.NOT_SKIPPABLE. The allowed values are UNKNOWN, DISABLED, ENABLED, INSTREAM_SELECT, ANY.
FrequencyCaps	String	False	The set of frequency capping units for this ProposalLineItem. This attribute is optional during creation and defaults to the product's frequency caps if Product.allowFrequencyCapsCustomization is false.
DfpLineItemId	Long	True	The unique ID of corresponding LineItem. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
LineItemType	String	False	The corresponding LineItemType of the ProposalLineItem. For a programmatic ProposalLineItem, the value can only be one of: The allowed values are SPONSORSHIP, STANDARD, NETWORK, BULK, PRICE_PRIORITY, HOUSE, LEGACY_DFP, CLICK_TRACKING, ADSENSE, AD_EXCHANGE, BUMPER, ADMOB, PREFERRED_DEAL, UNKNOWN.
LineItemPriority	Int	False	The priority for the corresponding LineItem of the ProposalLineItem. This attribute is optional during creation and defaults to the default priority of the lineItemType. For forecasting, this attribute is optional and has a default value assigned by Google. See LineItem.priority for more information.
RateType	String	False	The method used for billing the ProposalLineItem. The allowed values are CPM, CPC, CPD, CPU, FLAT_FEE, VCPM, CPM_IN_TARGET, UNKNOWN.
CreativePlaceholders	String	False	Details about the creatives that are expected to serve through the ProposalLineItem. This attribute is optional during creation and defaults to the product's creative placeholders.
Targeting	String	False	Contains the targeting criteria for the ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting.
AppliedLabels	String	False	The set of labels applied directly to the ProposalLineItem. This attribute is optional.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.
DisableSameAdvertiserCompetitiveExclusion	Boolean	False	If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied. This attribute is optional and defaults to false.
IsSold	Boolean	True	Indicates whether this ProposalLineItem has been sold. This attribute is read-only.
NetRate	String	False	The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 100. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate,and ProposalLineItem.netCost is required.
NetCost	String	False	The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 10000. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required.
DeliveryIndicator	String	False	Indicates how well the line item generated from this proposal line item has been performing. This will be null if the delivery indicator information is not available due to one of the following reasons:
DeliveryData	String	False	Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This will be null if the delivery data cannot be computed due to one of the following reasons: 1) The proposal line item has not pushed to Ad Manager. 2) The line item is not deliverable. 3) The line item has completed delivering more than 7 days ago. 4) The line item has an absolute-based goal. ProposalLineItem.deliveryIndicator should be used to track its progress in this case.
ComputedStatus	String	True	The status of the LineItem generated from this proposal line item. This will be null if the proposal line item has not pushed to Ad Manager. This attribute is read-only. The allowed values are DELIVERY_EXTENDED, DELIVERING, READY, PAUSED, INACTIVE, PAUSED_INVENTORY_RELEASED, PENDING_APPROVAL, COMPLETED, DISAPPROVED, DRAFT, CANCELED.
LastModifiedDateTime	Datetime	True	The date and time this ProposalLineItem was last modified. This attribute is assigned by Google when a ProposalLineItem is updated. This attribute is read-only.
ReservationStatus	String	True	The reservation status of the ProposalLineItem. This attribute is read-only. The allowed values are RESERVED, NOT_RESERVED, RELEASED, CHECK_LINE_ITEM_RESERVATION_STATUS, UNKNOWN.
LastReservationDateTime	Datetime	True	The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only.
EnvironmentType	String	True	The environment that the ProposalLineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER. This field is read-only and set to Product.environmentType of the product this proposal line item was created from. The allowed values are BROWSER, VIDEO_PLAYER.
AllowedFormats	String	False	The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats. The allowed values are AUDIO, UNKNOWN.
IsProgrammatic	Boolean	True	Whether or not the Proposal for this ProposalLineItem is a programmatic deal. This attribute is populated from Proposal.isProgrammatic. This attribute is read-only.
AdditionalTerms	String	False	Additional terms shown to the buyer in Marketplace.
ProgrammaticCreativeSource	String	False	Indicates the ProgrammaticCreativeSource of the programmatic line item. The allowed values are PUBLISHER, ADVERTISER, UNKNOWN.
GrpSettings	String	False	Contains the information for a proposal line item which has a target GRP demographic.
EstimatedMinimumImpressions	Long	False	The estimated minimum impressions that should be delivered for a proposal line item.
ThirdPartyMeasurementSettings	String	False	Contains third party measurement settings for cross-sell Partners
MakegoodInfo	String	False	Makegood info for this proposal line item. Immutable once created. Null if this proposal line item is not a makegood.
HasMakegood	Boolean	True	Whether this proposal line item has an associated makegood. This attribute is read-only.
CanCreateMakegood	Boolean	True	Whether a new makegood associated with this line item can be created. This attribute is read-only.
PauseRole	String	True	The NegotiationRole that paused the proposal line item, i.e. NegotiationRole.seller or NegotiationRole.buyer, or null when the proposal is not paused. This attribute is read-only. The allowed values are BUYER, SELLER, UNKNOWN.
PauseReason	String	True	The reason for pausing the ProposalLineItem, provided by the pauseRole. It is null when the ProposalLineItem is not paused. This attribute is read-only.
BuyerPermissionType	String	False	The options for allowing buyers to transact on the deal. NEGOTIATOR_ONLY means that only the buyer listed on the deal can bid on the deal. BIDDER means that all buyers under the listed buyer's bidder can bid on the deal. The allowed values are NEGOTIATOR_ONLY, BIDDER, UNKNOWN.

Proposals

Create, update, and query DoubleClick for Publishers Proposals.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the Proposal. This attribute is read-only.
IsProgrammatic	Boolean	False	Flag that specifies whether this Proposal is for programmatic deals. This value is default to false.
DfpOrderId	Long	True	The unique ID of corresponding Order. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
Name	String	False	The name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.name when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
StartDateTime	Datetime	True	The date and time at which the order and line items associated with the Proposal are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest ProposalLineItem.startDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only.
EndDateTime	Datetime	True	The date and time at which the order and line items associated with the Proposal stop being served. This attribute is derived from the proposal line item of the proposal which has the latest ProposalLineItem.endDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only.
Status	String	True	The status of the Proposal. This attribute is read-only. The allowed values are DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, UNKNOWN.
IsArchived	Boolean	True	The archival status of the Proposal. This attribute is read-only.
Advertiser	String	False	The advertiser, to which this Proposal belongs, and a set of Contact objects associated with the advertiser. The ProposalCompanyAssociation.type of this attribute should be ProposalCompanyAssociationType.ADVERTISER. This attribute is required when the proposal turns into an order, and its ProposalCompanyAssociation.companyId will be copied to Order.advertiserId. This attribute becomes readonly once the Proposal has been pushed.
Agencies	String	False	List of agencies and the set of Contact objects associated with each agency. This attribute is optional. A Proposal only has at most one Company with ProposalCompanyAssociationType.PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If primary agency exists, its ProposalCompanyAssociation.companyId will be copied to Order.agencyId when the proposal turns into an order.
InternalNotes	String	False	Provides any additional notes that may annotate the Proposal. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
PrimarySalesperson	String	False	The primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SalesPlannerIds	Long	False	List of unique IDs of User objects who are the sales planners of the Proposal. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
PrimaryTraffickerId	Long	False	The unique ID of the User who is primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.primaryTraffickerId . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SellerContactIds	Long	False	Users who are the seller's contacts.
AppliedTeamIds	Long	False	The IDs of all teams that the Proposal is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
AppliedLabels	String	False	The set of labels applied directly to the Proposal. This attribute is optional.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.
CurrencyCode	String	False	The currency code of this Proposal. This attribute is optional and defaults to network's currency code.
IsSold	Boolean	True	Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is OrderStatus.APPROVED or OrderStatus.PAUSED. This attribute is read-only.
LastModifiedDateTime	Datetime	True	The date and time this Proposal was last modified. This attribute is read-only.
MarketplaceInfo	String	False	The marketplace info of this proposal if it has a corresponding order in Marketplace.
BuyerRfp	String	False	The buyer RFP associated with this Proposal, which is optional. This field will be null if the proposal is not initiated from RFP.
HasBuyerRfp	Boolean	False	Whether a Proposal contains a BuyerRfp field. If this field is true, it indicates that the Proposal in question orignated from a buyer.
DeliveryPausingEnabled	Boolean	False	Whether pausing is consented for the Proposal. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.

Users

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

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Users. For example:

SELECT * FROM [Users]

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

SELECT * FROM [Users] WHERE Id = '244555723'

Insert

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

INSERT INTO [Users] (Name, Email, RoleId ) VALUES ('murat', '[email protected]', '-1')

Update

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

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

Delete

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

DELETE FROM [Users] WHERE Id = '244555723'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the User. This attribute is readonly and is assigned by Google.
Name	String	False	The name of the User. It has a maximum length of 128 characters.
Email	String	False	The email or login of the User. In order to create a new user, you must already have a Google Account.
RoleId	Long	False	The unique role ID of the User. Roles that are created by Google will have negative IDs.
RoleName	String	True	The name of the role assigned to the User. This attribute is readonly.
IsActive	Boolean	True	Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
ExternalId	String	False	An identifier for the User that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
IsServiceAccount	Boolean	True	Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
OrdersUiLocalTimeZoneId	String	False	The long format timezone id (e.g. 'America/Los_Angeles') used in the orders and line items UI for this User. Set this to null to indicate that no such value is defined for the User - UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Google Ad Manager Connector for CData Sync Views


Name	Description
DeliveryReport	Query DoubleClick for Publishers Delivery Reports.
InventoryReport	A template inventory report.
Roles	Query DoubleClick for Publishers Roles.
SalesReport	A template sales report.

DeliveryReport

Query DoubleClick for Publishers Delivery Reports.

Select

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

SELECT * FROM [DeliveryReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'

Columns


Name	Type	Description
OrderId	String	The unique ID of the Order. This value is read-only and is assigned by Google.
OrderName	String	The name of the Order. This value is required to create an Order and has a maximum length of 255 characters.
AdServerImpressions	Long	The number of impressions delivered by the ad server. Corresponds to 'Ad server impressions' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerClicks	Long	The number of clicks delivered by the ad server. Corresponds to 'Ad server clicks' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerCtr	Double	The CTR for an ad delivered by the ad server. Corresponds to 'Ad server CTR' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerCpmAndCpcRevenue	Long	The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server.Corresponds to 'Ad server CPM and CPC revenue' in the Ad Manager UI. Compatible with the 'Historical' report type.
AdServerWithoutCpdAverageEcpm	Double	The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server. Corresponds to 'Ad server average eCPM' in the Ad Manager UI. Compatible with the 'Historical' report type.
OrderTrafficker	String	The name and email address in the form of name (email) of the trafficker for Dimension.ORDER_NAME. Corresponds to 'Trafficker' in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.
OrderStartDateTime	Datetime	Represents the start date (in YYYY-MM-DD format) for Dimension.ORDER_NAME. Corresponds to 'Order start date' in the Ad Manager UI.
OrderEndDateTime	Datetime	Represents the end date (in YYYY-MM-DD format) for Dimension.ORDER_NAME. Corresponds to 'Order end date' in the Ad Manager UI.

Pseudo-Columns

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


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

InventoryReport

A template inventory report.

Select

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

SELECT * FROM [InventoryReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'

Columns


Name	Type	Description
AdUnitId	String	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdUnitName	String	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerImpressions	Long	The number of impressions delivered by the ad server.
AdServerClicks	Long	The number of clicks delivered by the ad server.
AdExchangeLineItemLevelImpressions	Long	The number of impressions an Ad Exchange ad delivered for line item-level dynamic allocation.
AdExchangeLineItemLevelClicks	Long	The number of clicks an Ad Exchange ad delivered for line item-level dynamic allocation.
TotalLineItemLevelImpressions	Long	The total number of impressions delivered including line item-level dynamic allocation.
TotalLineItemLevelCPMAndCPCRevenue	Long	The total CPM and CPC revenue generated by the ad servers including line item-level dynamic allocation.

Pseudo-Columns

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


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

Roles

Query DoubleClick for Publishers Roles.

Select

The following queries are processed server side by the Google Ad Manager APIs.

Retrieve a list of Roles. For example:

SELECT * FROM [Roles]

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

SELECT * FROM [Roles] WHERE Id = '-28'

Columns


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

SalesReport

A template sales report.

Select

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

SELECT * FROM [SalesReport] WHERE StartDate = '01-01-2018' AND EndDate = '01-02-2018'

Columns


Name	Type	Description
SalesPersonId	String	Breaks down reporting data by salesperson User.id.
SalesPersonName	String	Breaks down reporting data by salesperson.
AdServerImpressions	Long	The number of impressions delivered by the ad server.
AdServerCpmAndCpcRevenue	Long	The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server.
AdServerWithoutCpdAverageEcpm	Long	The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server.

Pseudo-Columns

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


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

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Google Ad Manager.

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

Google Ad Manager Connector for CData Sync Stored Procedures


Name	Description
CreateReportSchema	Creates a schema file based on an existing report in the Google Ad Manager UI by setting the BaseReportName input to the original report. If you want to generate a report from scratch, leave the BaseReportName blank.

CreateReportSchema

Creates a schema file based on an existing report in the Google Ad Manager UI by setting the BaseReportName input to the original report. If you want to generate a report from scratch, leave the BaseReportName blank.

CreateReportSchema

CreateReportSchema creates a schema file based on the specified report. This schema adds a table to your existing list that corresponds with the results of your report, which can then be queried like other tables. (Reports from the Google Ad Manager are not modeled by Sync App as queryable tables by default.)

The generated schema file outlines the metadata for the report, such as columns and column data types. You can edit the file to adjust data types, rename columns, and include or exclude columns.

Updating a Report Schema

In the following example, the SP CreateReportSchema creates a new report using TestReportTest1 as a base template. It appends new columns to TestReportTest1 and creates a new report, named TestReport2. The new report is saved as ...\\TestReportTest2.rsd.

EXECUTE [CreateReportSchema] 
    [ReportName] = "TestReportTest2",
    [CustomFieldIdsPrimitive] = "1459925,1459928",
    [CustomFieldIdsDropdown] = "1469785",
    [CustomDimensionKeyIds] = "13539564",
    [BaseReportName] = "TestReportTest1", 
    [FileName] = "...\\TestReportTest2.rsd"

Input


Name	Type	Required	Description
ReportName	String	True	The name of the report.
BaseReportName	String	False	The original report name that the new report will be based on. To generate a report from scratch, leave this field blank.
FileName	String	False	The full file path and name of the schema to generate. Ex : 'C:/Users/User/Desktop/SampleReport.rsd'
Metrics	String	False	Metrics of the report separated by comma. Ex: 'AD_SERVER_IMPRESSIONS,AD_SERVER_TARGETED_IMPRESSIONS,AD_SERVER_CLICKS,AD_SERVER_TARGETED_CLICKS'. This input is required if you are creating the report schema from scratch (have omitted the BaseReportName). If you have set the BaseReportName to an original report name, either leave this input empty or add only those values that do not exist in the original report.
Dimensions	String	False	Dimensions of the report separated by comma. Ex: 'MONTH_AND_YEAR,WEEK,DATE,DAY,CUSTOM_DIMENSION,ORDER_NAME'. This input is required if you are creating the report schema from scratch (have omitted the BaseReportName). If you have set the BaseReportName to an original report name, either leave this input empty or add only those values that do not exist in the original report.
CustomFieldIdsPrimitive	String	False	The list of CustomField.id (Number, Toggle or Text type) separated by comma. Ex: '1459925,1459958'. To add a CustomField to the report, you must also include its corresponding dimension in the list of Dimensions.
CustomFieldIdsDropdown	String	False	The list of CustomField.id (Drop-down type) separated by comma. Ex: '1459925,1459958'. To add a CustomField to the report, you must also include its corresponding dimension in the list of Dimensions.
CustomDimensionKeyIds	String	False	The list of custom dimension custom targeting key IDs separated by comma. Ex: '13539564,13539567'. To add a custom dimension key ID, you must include 'CUSTOM_DIMENSION' in the list of Dimensions.
AdUnitView	String	False	The view for an ad unit report. With TOP_LEVEL, only the top level ad units are included, and metrics include events for their descendants that are not filtered out. With FLAT, all ad units are included, and metrics do not include events for the descendants. The allowed values are TOP_LEVEL, FLAT.
ReportCurrency	String	False	The currency for revenue metrics. Defaults to the network currency if left null. The supported currency codes can be found in 'support.google.com/admanager/answer/6019533'.
TimeZoneType	String	False	Time zone that is used in the report. Set to 'PUBLISHER' to use the the publisher's time zone. For Ad Manager reports, this time zone is compatible with all metrics. For Ad Exchange reports, this time zone is not compatible with 'Bids' and 'Deals' metrics. If your report includes 'time unit' dimensions, only the Ad Manager 'time unit' dimensions are compatible. Set to 'PACIFIC' to use the PT time zone. This time zone is only compatible with Ad Exchange metrics in Historical report type. If your report includes 'time unit' dimensions, only the PT 'time unit' dimensions are compatible. The allowed values are PUBLISHER, PACIFIC.

Result Set Columns


Name	Type	Description
FileData	String	The schema's content encoded in BASE64. Only used if FileName and FileStream are not set.
Success	String	Returns True if the report is successfully created.

GetOAuthAccessToken

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

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

Input


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

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken	String	A token that may be used to obtain a new access token.
ExpiresIn	String	The remaining lifetime on the access token.

GetOAuthAuthorizationURL

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

Input


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

Result Set Columns


Name	Type	Description
URL	String	The URL to complete user authentication.

RefreshOAuthAccessToken

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

Input


Name	Type	Required	Description
OAuthRefreshToken	String	True	The refresh token returned from the original authorization code exchange.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken	String	A token that may be used to obtain a new access token.
ExpiresIn	String	The remaining lifetime on the access token.

Connection String Options

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.

Authentication

Property	Description
AuthScheme	Specifies the authentication method used to connect to Google Ad Manager.
NetworkCode	This value can be obtained from the URL after signing in to Google Ad Manager. For example, in the URL https://admanager.google.com/2032576/#inventory, 2032576 is your network code.
Version	The Google Ad Manager API version used by the driver.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
DelegatedServiceAccounts	Specifies a space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	Specifies a service account email to make a delegated request.

JWT OAuth

Property	Description
OAuthJWTCert	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

SSL

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

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
AWSWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via AWS.
AzureWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via Azure.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Google Ad Manager.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
WorkloadPoolId	The ID of your Workload Identity Federation pool.
WorkloadProjectId	The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderId	The ID of your Workload Identity Federation pool provider.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	Specifies the authentication method used to connect to Google Ad Manager.
NetworkCode	This value can be obtained from the URL after signing in to Google Ad Manager. For example, in the URL https://admanager.google.com/2032576/#inventory, 2032576 is your network code.
Version	The Google Ad Manager API version used by the driver.

AuthScheme

Specifies the authentication method used to connect to Google Ad Manager.

Remarks

OAuth: Set this to perform OAuth authentication using a standard user account.
OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
GCPInstanceAccount: Set this to get Access Token from Google Cloud Platform instance.
AWSWorkloadIdentity: Set this to authenticate using Workload Identity Federation via AWS. The Sync App authenticates to AWS according to the AWSWorkloadIdentityConfig and provides Google Security Token Service with an authentication token. The Google STS validates this token and produces an OAuth token that can access Google services.
AzureWorkloadIdentity: Set this to authenticate using Workload Identity Federation via Azure. The Sync App authenticates to Azure according to the AzureWorkloadIdentityConfig and provides Google Security Token Service with an authentication token. The Google STS validates this token and produces an OAuth token that can access Google services.

NetworkCode

This value can be obtained from the URL after signing in to Google Ad Manager. For example, in the URL https://admanager.google.com/2032576/#inventory, 2032576 is your network code.

Remarks

The network code must be set in the connection string. You will find the value for this connection property in the URL after signing in to Google Ad Manager. For example, in the URL https://admanager.google.com/2032576/#inventory, 2032576 is your network code.

Version

The Google Ad Manager API version used by the driver.

Remarks

The Google Ad Manager API version used by the driver. The value for this connection property can be found in the Google Ad Manager API documentation.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
DelegatedServiceAccounts	Specifies a space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	Specifies a service account email to make a delegated request.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

DelegatedServiceAccounts

Specifies a space-delimited list of service account emails for delegated requests.

Remarks

The service account emails must be specified in a space-delimited list.

Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain.

The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the requesting service account. The requesting service account is the one specified in the RequestingServiceAccount property.

Note that for delegated requests, the requesting service account must have the permission iam.serviceAccounts.getAccessToken, which can also be granted through the serviceAccountTokenCreator role.

RequestingServiceAccount

Specifies a service account email to make a delegated request.

Remarks

The service account email of the account for which the credentials are requested in a delegated request. With the list of delegated service accounts in DelegatedServiceAccounts, this property is used to make a delegated request.

You must have the IAM permission iam.serviceAccounts.getAccessToken on this service account.

JWT OAuth

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthJWTCert	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

OAuthJWTCert

Supplies the name of the client certificate's JWT Certificate store.

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Sync App initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

The most common User and Machine certificate stores in Windows include:
- MY: A certificate store holding personal certificates with their associated private keys.
- CA: Certifying authority certificates.
- ROOT: Root certificates.
- SPC: Software publisher certificates.
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file.
When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType

Identifies the type of key store containing the JWT Certificate.

Remarks


Value	Description	Notes
USER	A certificate store owned by the current user.	Only available in Windows.
MACHINE	A machine store.	Not available in Java or other non-Windows environments.
PFXFILE	A PFX (PKCS12) file containing certificates.
PFXBLOB	A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	A Java key store (JKS) file containing certificates.	Only available in Java.
JKSBLOB	A string (base-64-encoded) representing a certificate store in Java key store (JKS) format.	Only available in Java.
PEMKEY_FILE	A PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	A string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	A file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	A file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	A string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	A PKCS7 file containing certificates.
PPKFILE	A file that contains a PPK (PuTTY Private Key).
XMLFILE	A file that contains a certificate in XML format.
XMLBLOB	Astring that contains a certificate in XML format.
BCFKSFILE	A file that contains an Bouncy Castle keystore.
BCFKSBLOB	A string (base-64-encoded) that contains a Bouncy Castle keystore.
GOOGLEJSON	A JSON file containing the service account information.	Only valid when connecting to a Google service.
GOOGLEJSONBLOB	A string that contains the service account JSON.	Only valid when connecting to a Google service.

OAuthJWTCertPassword

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

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

OAuthJWTCertSubject

Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

If an exact match for the subject is found, the corresponding certificate is selected.
If no exact match is found, the store is searched for certificates whose subjects contain the property value.
If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].

Common fields include:


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, enclose it in quotes. For example: "O=ACME, Inc.".

OAuthJWTIssuer

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. Enter the value of the service account email address.

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

OAuthJWTSubject

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

Remarks

The user subject for which the application is requesting delegated access. Enter the email address of the user for which the application is requesting delegated access.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

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

SSLServerCert

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

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Google Ad Manager. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Google Ad Manager. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Google Ad Manager. If the SOCKS 5 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.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

BASIC: The Sync App performs HTTP basic authentication.
DIGEST: The Sync App performs HTTP digest authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: 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, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

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


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

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
AWSWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via AWS.
AzureWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via Azure.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Google Ad Manager.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
WorkloadPoolId	The ID of your Workload Identity Federation pool.
WorkloadProjectId	The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderId	The ID of your Workload Identity Federation pool provider.

AWSWorkloadIdentityConfig

Configuration properties to provide when using Workload Identity Federation via AWS.

Remarks

The properties are formatted as a semicolon-separated list of Key=Value properties, where the value is optionally quoted. For example, this setting authenticates in AWS using a user's root keys:

AWSWorkloadIdentityConfig="AuthScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"

AzureWorkloadIdentityConfig

Configuration properties to provide when using Workload Identity Federation via Azure.

Remarks

The properties are formatted as a semicolon-separated list of Key=Value properties, where the value is optionally quoted. For example, this setting authenticates in Azure using client credentials:

AzureWorkloadIdentityConfig="AuthScheme=AzureServicePrincipal;AzureTenant=directory (tenant) id;OAuthClientID=application (client) id;OAuthClientSecret=client secret;AzureResource=application id uri;"

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting


Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from Google Ad Manager.

Remarks

When processing a query, instead of requesting all of the queried data at once from Google Ad Manager, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

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

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

WorkloadPoolId

The ID of your Workload Identity Federation pool.

Remarks

The ID of your Workload Identity Federation pool.

WorkloadProjectId

The ID of the Google Cloud project that hosts your Workload Identity Federation pool.

Remarks

The ID of the Google Cloud project that hosts your Workload Identity Federation pool.

WorkloadProviderId

The ID of your Workload Identity Federation pool provider.

Remarks

The ID of your Workload Identity Federation pool provider.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Google Ad Manager Connector for CData Sync

Google Ad Manager Connector for CData Sync

Overview

Google Ad Manager Version Support

Establishing a Connection

Adding a Connection to Google Ad Manager

Connecting to Google Ad Manager

Authenticating to Google Ad Manager

User Accounts (OAuth)

Web Applications

Headless Machines

GCP Instance Accounts

OAuth Scopes and Endpoints

Required Scopes and Endpoint Domains for Google Ad Manager

Understanding Scopes

Required Scopes for Google Ad Manager

Understanding Endpoint Domains

Required Endpoint Domains for Google Ad Manager

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Accessing Saved Query Reports

Inserting custom fields

Tables

Google Ad Manager Connector for CData Sync Tables

Companies

Select

Insert

Update

Delete

Columns

Contacts

Select

Insert

Update

Delete

Columns

Creatives

Select

Update

Insert

Delete

Columns

CustomFields

Select

Insert

Update

Delete

Columns

CustomTargetingKeys

Select

INSERT

Update

Delete

Columns

CustomTargetingValues

Select

Insert

Update

Delete

Columns

Inventories

Select

Insert

Update

Delete

Columns

Labels

Select

Insert