Getting Started

This page provides a guide to Establishing a Connection to Google Ad Manager in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Google Ad Manager

Establishing a Connection shows how to authenticate to Google Ad Manager and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Google Ad Manager through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Google Ad Manager by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

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 Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud. 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 Cloud 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 Cloud to enable the automatic refreshing of the access token.

GCP Instance Accounts

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

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

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.

Creating a Custom OAuth App

Introduction

You can use a custom OAuth app to authenticate a service account or a user account. You can always create a custom OAuth application, but note that desktop and headless connections support embedded OAuth, which simplifies the process of authentication. See "Establishing a Connection" for information about using the embedded OAuth application.

When To Create a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting via either a Desktop Application or from a Headless Machine.

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

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

Enable the Ad Manager API

Follow these steps to enable the API:

Navigate to the Google Ad Manager.
Select Admin > Global from the left-hand navigation menu.
On the Network Settings tab, click API access to enable the Ad Manager API.

Enabling the API is done in the Google Ad Manager, but the following sections require that you work in the Google Cloud Console.

Create an OAuth Application for User Accounts (OAuth)

When using AuthScheme=OAuth, and you're using web applicaiton, you must create an OAuth Client ID Application. For desktop and headless flows, creating a custom OAuth application is optional.

Follow these steps to create a custom OAuth application:

Navigate to the Google Cloud Console.
If you have not done so, follow the steps in the console to create an OAuth consent screen.
Select Credentials from the left-hand navigation menu.
On the Credentials page, select Create Credentials > OAuth Client ID.
In the Application Type menu, select Web application.
Specify a name for your OAuth custom web application.
Under Authorized redirect URIs, click ADD URI and enter a redirect URI. Press Enter.
Click CREATE, which returns you to the Credentials page.
A window opens that displays your client Id and client secret. Although the client secret is accessible from from the Google Cloud Console, we recommend you write down the client secret. You need both the client secret and client Id to specify the OAuthClientId and OAuthClientSecret connection properties.

Create an OAuth Application for Service Accounts (OAuthJWT)

When using AuthScheme=OAuthJWT, you must create a Service Account Application. Follow these steps:

Navigate to the Google Cloud Console.
If you have not done so, follow the steps in the console to create an OAuth consent screen.
Select Credentials from the left-hand navigation menu.
On the Credentials page, select Create Credentials > Service account.
On the Create service account page, enter the Service account name, the Service account ID, and, optionally, a description.
The console displays the email associated with the service account. Copy this and save it; you need it later for the OAuthJWTIssuer connection property.
Click DONE. This returns you to the Credentials page.
Click the name of your service account. In the window that opens, select the Key tab.
Click Add Key > Create new key. In the window that opens, choose JSON or P12; we recommend JSON.
Click Create. A private key in JSON or P12 file format is downloaded to your computer. Save this information; you need it later to for the OAuthJWTCert connection property.

SSL Configuration

Customizing the SSL Configuration

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

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 Cloud models the data in Google Ad Manager as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Google Ad Manager Tables


Name	Description
Companies	Create, update, and query DoubleClick for Publishers Companies.
Contacts	Create, update, and query DoubleClick for Publishers Contacts.
Creatives	Update and query DoubleClick for Publishers Creatives.
CustomFields	Create, update, and query DoubleClick for Publishers Custom Fields.
CustomTargetingKeys	Create, update, and query DoubleClick for Publishers Custom Targeting Keys.
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. The default value is TOP. 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 object 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 is null when retrieving associations between line items and creatives not belonging to a set.
ManualCreativeRotationWeight	Double	False	The weight of the Creative object. Only use this value 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. Only use this attribute info 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 attribute 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. Setting this attribute is optional and is only valid for Ad Manager 360 networks.
DestinationUrl	String	False	Overrides the value set for HasDestinationUrlCreative.destinationUrl. This attribute is optional and is only valid for Ad Manager 360 networks.
Sizes	String	True	Overrides the value set for Creative.size. This attribute contains the aggregated data regarding the size of the creative object. Note that this returns an aggregate XML value. This attribute is optional and read-only. The allowed values are ACTIVE, NOT_SERVING, 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.
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 the 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.

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 the 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 the User objects who are the sales planners of the Proposal. This attribute is optional. A proposal can 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 the 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.
IsEmailNotificationAllowed	Boolean	False	Specifies whether or not the User wants to permit the Publisher Display Ads system to send email notifications to their email address. This attribute is optional and defaults to true.
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.

CData Cloud - Google Ad Manager 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 Cloud 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.

CData Cloud - Google Ad Manager 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 Cloud 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.

System Tables

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

Schema Tables

The following tables return database metadata for Google Ad Manager:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


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

sys_tablecolumns

Describes the columns of the available tables and views.

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

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Orders'

Columns


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

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


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

sys_procedureparameters

Describes stored procedure parameters.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns


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

sys_keycolumns

Describes the primary and foreign keys.

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

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Orders'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


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

sys_primarykeys

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


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

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


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

sys_sqlinfo

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns


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

sys_identity

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity

Columns


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

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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	The type of authentication to use when connecting 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 lastest Google Ad Manager API version.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
DelegatedServiceAccounts	A space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	A service account email to make a delegated request.

JWT OAuth

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	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.

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

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

Miscellaneous

Property	Description
AWSWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via AWS.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Google Ad Manager, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
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	The type of authentication to use when connecting 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 lastest Google Ad Manager API version.

Remarks

The lastest Google Ad Manager API version. 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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
DelegatedServiceAccounts	A space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	A service account email to make a delegated request.

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

A service account email to make a delegated request.

Data Type

string

Default Value

""

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	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	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

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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


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

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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:


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

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

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

Logging

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

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

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

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

BrowsableSchemas

Overview

Key Features

Getting Started

Connecting to Google Ad Manager

Accessing Data from CData Cloud Services

Establishing a Connection

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

Creating a Custom OAuth App

Introduction

When To Create a Custom OAuth Application

Enable the Ad Manager API

Create an OAuth Application for User Accounts (OAuth)

Create an OAuth Application for Service Accounts (OAuthJWT)

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

CData Cloud - Google Ad Manager 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