Connection String OptionsBack To Top

AuthScheme
NetworkCode
Version
InitiateOAuth
OAuthClientId
OAuthClientSecret
OAuthAccessToken
OAuthSettingsLocation
OAuthVerifier
OAuthRefreshToken
OAuthExpiresIn
OAuthTokenTimestamp
OAuthJWTCert
OAuthJWTCertType
OAuthJWTCertPassword
OAuthJWTCertSubject
OAuthJWTIssuer
OAuthJWTSubject
SSLServerCert
FirewallType
FirewallServer
FirewallPort
FirewallUser
FirewallPassword
ProxyAutoDetect
ProxyServer
ProxyPort
ProxyAuthScheme
ProxyUser
ProxyPassword
ProxySSLType
ProxyExceptions
Logfile
Verbosity
LogModules
MaxLogFileSize
MaxLogFileCount
Location
BrowsableSchemas
Tables
Views
AutoCache
CacheDriver
CacheConnection
CacheLocation
CacheTolerance
Offline
CacheMetadata
BatchSize
ConnectionLifeTime
ConnectOnOpen
MaxRows
Other
Pagesize
PoolIdleTimeout
PoolMaxSize
PoolMinSize
PoolWaitTime
PseudoColumns
Readonly
RTK
Timeout
UseConnectionPooling
UserDefinedViews

AuthScheme

Data Type

string

Default Value

"Auto"

Remarks

Auto: Lets the driver decide automatically based on the other connection properties you have set.
OAuth: Set this to perform OAuth authentication using a standard user account.
OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
GCPInstanceAccount: Set this to get Access Token from Google Cloud Platform instance.

The NetWorkCode must be set in the connection string. You will find this in the URL when you are logged into your network. For example, in the URL https://www.google.com/dfp/2032576#delivery, 2032576 is your network code.

Version

Data Type

string

Default Value

"v202211"

Remarks

The lastest Google Ad Manager Api version. You will find this in their API documentation page.

InitiateOAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

Data Type

string

Default Value

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\GoogleAdsManager Data Provider\\OAuthSettings.txt"

Remarks

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

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

If left unspecified, the default location is "%APPDATA%\\CData\\GoogleAdsManager Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

OAuthVerifier

Data Type

string

Default Value

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

Data Type

string

Default Value

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

Data Type

string

Default Value

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

Data Type

string

Default Value

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

OAuthJWTCert

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

Data Type

string

Default Value

"USER"

Remarks

This property can take one of the following values:


USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
GOOGLEJSON	The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service.
GOOGLEJSONBLOB	The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service.

OAuthJWTCertPassword

Data Type

string

Default Value

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

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

OAuthJWTCertSubject

Data Type

string

Default Value

"*"

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

OAuthJWTIssuer

Data Type

string

Default Value

Remarks

The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.

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

OAuthJWTSubject

Data Type

string

Default Value

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

SSLServerCert

Data Type

string

Default Value

Remarks

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

This property can take the following forms:


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

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

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

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

FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the driver opens a connection to Google Ad Manager and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Data Type

string

Default Value

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

Data Type

int

Default Value

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

Data Type

string

Default Value

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

Data Type

string

Default Value

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

A search from the JVM properties (http.proxy, https.proxy, socksProxy, etc.) is performed.
In the case that the JVM properties don't exist, a search from java.home/lib/net.properties is performed.
In the case that java.net.useSystemProxies is set to True, a search from the SystemProxy is performed.
In Windows only, an attempt is made to retrieve these properties from the Internet Options in the registry.

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

ProxyServer

Data Type

string

Default Value

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

Data Type

int

Default Value

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The driver performs HTTP BASIC authentication.
DIGEST: The driver performs HTTP DIGEST authentication.
NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

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

ProxyUser

Data Type

string

Default Value

Remarks

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

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain

domain\user

ProxyPassword

Data Type

string

Default Value

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


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

ProxyExceptions

Data Type

string

Default Value

Remarks

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

Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logfile

Data Type

string

Default Value

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

LogModules

Data Type

string

Default Value

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.

MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.

Location

Data Type

string

Default Value

"%APPDATA%\\CData\\GoogleAdsManager Data Provider\\Schema"

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

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


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

BrowsableSchemas

Data Type

string

Default Value

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

Data Type

string

Default Value

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Data Type

string

Default Value

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

CacheLocation: Specifies the path to the file store.
CacheDriver and CacheConnection: Specifies a driver to a database and the connection string.

CacheDriver

Data Type

string

Default Value

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined by the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note: you must add the CacheDriver JAR file to the classpath.

Examples

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:googleadsmanager:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;

To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:

jdbc:googleadsmanager:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:googleadsmanager:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;

MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:googleadsmanager:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:googleadsmanager:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:googleadsmanager:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;

NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:googleadsmanager:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;

CacheConnection

Data Type

string

Default Value

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]

For example, to cache to an in-memory database, use the following:

jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache

The following are typical connection properties:

Server: The IP address or domain name of the server you want to connect to.
Port: The port that the server is running on.
User: The user name provided for authentication to the database.
Password: The password provided for authentication to the database.
Database: The name of the database.

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]

For example:

jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true

The following are typical SQL Server connection properties:

Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
Port: The port SQL Server is running on.
Database: The name of the SQL Server database.
Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
User Id: The user name provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
Password: The password provided for authentication with SQL Server. This property is only needed if you are not using integrated security.

Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]

For example:

jdbc:oracle:thin:scott/tiger@myhost:1521:orcl

The following are typical connection properties:

Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
Password: The password provided for authentication with the Oracle database.
User Id: The user Id provided for authentication with the Oracle database.

PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]

For example, the following connection string connects to a database on the default host (localhost) and port (5432):

jdbc:postgresql:postgres

The following are typical connection properties:

Host: The address of the server hosting the PostgreSQL database.
Port: The port used to connect to the server hosting the PostgreSQL database.
Database: The name of the database.
User name: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
Password: The password provided for authentication with the PostgreSQL database.

CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\GoogleAdsManager Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

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


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.

Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Google Ad Manager catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metadata changes often.
When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

BatchSize

Data Type

int

Default Value

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

ConnectionLifeTime

Data Type

int

Default Value

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.

ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to Google Ad Manager when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to Google Ad Manager and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).

MaxRows

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

Data Type

string

Default Value

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Caching Configuration


CachePartial=True	Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True	Passes the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Data Type

int

Default Value

100

Remarks

The Pagesize property affects the maximum number of results to return per page from Google Ad Manager. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PoolIdleTimeout

Data Type

int

Default Value

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.

PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

PoolMinSize

Data Type

int

Default Value

Remarks

The minimum number of connections in the pool. The default is 1.

PoolWaitTime

Data Type

int

Default Value

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

PseudoColumns

Data Type

string

Default Value

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

RTK

Data Type

string

Default Value

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

Timeout

Data Type

int

Default Value

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

UserDefinedViews

Data Type

string

Default Value

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The driver automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the driver.

This User Defined View configuration file is formatted as follows:

Each root element defines the name of a view.
Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{

	"MyView": {

		"query": "SELECT * FROM Orders WHERE MyColumn = 'value'"

	},

	"MyView2": {

		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"

	}

}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

TablesBack To Top

Companies
Contacts
Creatives
CustomFields
CustomTargetingKeys
CustomTargetingValues
Inventories
Labels
LineItemCreativeAssociations
lineitems
MobileApplications
orders
Placements
ProposalLineItems
Proposals
Users

Companies

Create, update, and query DoubleClick for Publishers Companies.

Select

The following queries are processed server side. The driver processes other SELECT queries client-side in memory.

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. The driver processes other SELECT queries client-side in memory.

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@yahoo.com' 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. The driver processes other SELECT queries client-side in memory.

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
CompanyId	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. The driver processes other SELECT queries client-side in memory .

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 is 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 fields 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 there exists a CustomFieldValue 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. The driver processes other SELECT queries client-side in memory.

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. The driver processes other SELECT queries client-side in memory.

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. The driver processes other SELECT queries client-side in memory.

Retrieve a list of Inventories. For example:

SELECT * FROM [Inventories]

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

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

Insert

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

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

Update

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

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

Delete

The delete operation is not supported for this table.

Columns


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

Labels

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

Select

The following queries are processed server side by the Google Ad Manager APIs. The driver processes other SELECT queries client-side in memory.

Retrieve a list of Labels. For example:

SELECT * FROM [Labels]

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

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

Insert

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

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

Update

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

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

Delete

The delete operation is not supported for this table.

Columns


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

LineItemCreativeAssociations

Query DoubleClick for Publishers LineItemCreativeAssociations.

Columns


Name	Type	ReadOnly	Description
LineItemId	Long	False	The ID of the LineItem to which the Creative should be associated. This attribute is required.
CreativeId	Long	False	The ID of the Creative being associated with a LineItem. This attribute is required if this is an association between a line item and a creative. This attribute is ignored if this is an association between a line item and a creative set. If this is an association between a line item and a creative, when retrieving the line item creative association, the creativeId will be the creative's ID. If this is an association between a line item and a creative set, when retrieving the line item creative association, the creativeId will be the ID of the master creative.
CreativeSetId	Long	False	The ID of the CreativeSet being associated with a LineItem. This attribute is required if this is an association between a line item and a creative set. This field will be null when retrieving associations between line items and creatives not belonging to a set.
ManualCreativeRotationWeight	Double	False	The weight of the Creative. This value is only used if the line item's creativeRotationType is set to CreativeRotationType.MANUAL. This attribute is optional and defaults to 10.
SequentialCreativeRotationIndex	Int	False	The sequential rotation index of the Creative. This value is used only if the associated line item's LineItem.creativeRotationType is set to CreativeRotationType.SEQUENTIAL. This attribute is optional and defaults to 1.
StartDateTime	Datetime	False	Overrides the value set for LineItem.startDateTime. This value is optional and is only valid for Ad Manager 360 networks.
StartDateTimeType	String	False	Specifies whether to start serving to the LineItemCreativeAssociation right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME. The allowed values are USE_START_DATE_TIME, IMMEDIATELY, ONE_HOUR_FROM_NOW, UNKNOWN.
EndDateTime	Datetime	False	Overrides LineItem.endDateTime. This value is optional and is only valid for Ad Manager 360 networks.
DestinationUrl	String	False	Overrides the value set for HasDestinationUrlCreative.destinationUrl. This value is optional and is only valid for Ad Manager 360 networks.
Sizes	String	False	Overrides the value set for Creative.size, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.
Status	String	True	The status of the association. This attribute is read-only. The allowed values are ACTIVE, 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. The driver processes other SELECT queries client-side in memory.

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. The driver processes other SELECT queries client-side in memory.

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. The driver processes other SELECT queries client-side in memory.

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. The driver processes other SELECT queries client-side in memory.

Retrieve a list of Placements. For example:

SELECT * FROM [Placements]

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

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

Insert

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

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

Update

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

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

Delete

The delete operation is not supported for this table.

Columns


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

ProposalLineItems

Create, update, and query DoubleClick for Publishers ProposalLineItems.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Long	True	The unique ID of the ProposalLineItem. This attribute is read-only.
ProposalId	Long	False	The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly.
Name	String	False	The name of the ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
StartDateTime	Datetime	False	The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The DateTime.timeZoneID is required if start date time is not null. This attribute becomes readonly once the ProposalLineItem has started delivering.
EndDateTime	Datetime	False	The date and time at which the line item associated with the ProposalLineItem stops beening served. This attribute is optional during creation, but required and must be after the startDateTime. The DateTime.timeZoneID is required if end date time is not null.
TimeZoneId	String	False	The time zone ID in tz database format (e.g. 'America/Los_Angeles') for this ProposalLineItem. The number of serving days is calculated in this time zone. So if rateType is RateType.CPD, it will affect the cost calculation. The startDateTime and endDateTime will be returned in this time zone. This attribute is optional and defaults to the network's time zone. This attribute is read-only when using programmatic guaranteed, using sales management, or when using programmatic guaranteed, not using sales management.
InternalNotes	String	False	Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
IsArchived	Boolean	True	The archival status of the ProposalLineItem. This attribute is read-only.
Goal	String	False	The goal(i.e. contracted quantity, quantity or limit) that this ProposalLineItem is associated with, which is used in its pacing and budgeting. Goal.units must be greater than 0 when the proposal line item turns into a line item, Goal.goalType and Goal.unitType are readonly. For a Preferred deal ProposalLineItem, the goal type can only be GoalType.NONE.
SecondaryGoals	String	False	The secondary goals that this ProposalLineItem is associated with. For a programmatic line item with the properties RateType.CPM and LineItemType.SPONSORSHIP, this field will have one goal which describes the impressions cap. For other cases, this field is an empty list.
ContractedUnitsBought	Long	False	The contracted number of impressions or clicks. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is false, then this represents the lifetime minimum impression. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is true, then this represents the daily minimum impression. This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only.
DeliveryRateType	String	False	The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is required. For a Preferred deal ProposalLineItem, the value can only be DeliveryRateType.FRONTLOADED. The allowed values are EVENLY, FRONTLOADED, AS_FAST_AS_POSSIBLE.
RoadblockingType	String	False	The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONE_OR_MORE if not specified by the product. The allowed values are ONLY_ONE, ONE_OR_MORE, AS_MANY_AS_POSSIBLE, ALL_ROADBLOCK, CREATIVE_SET.
CompanionDeliveryOption	String	False	The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error. The allowed values are OPTIONAL, AT_LEAST_ONE, ALL, UNKNOWN.
VideoMaxDuration	Long	False	The max duration of a video creative associated with this ProposalLineItem in milliseconds. This attribute is optional, defaults to the Product.videoMaxDuration on the Product it was created with, and only meaningful if this is a video proposal line item.
VideoCreativeSkippableAdType	String	False	The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType.NOT_SKIPPABLE. The allowed values are UNKNOWN, DISABLED, ENABLED, INSTREAM_SELECT, ANY.
FrequencyCaps	String	False	The set of frequency capping units for this ProposalLineItem. This attribute is optional during creation and defaults to the product's frequency caps if Product.allowFrequencyCapsCustomization is false.
DfpLineItemId	Long	True	The unique ID of corresponding LineItem. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
LineItemType	String	False	The corresponding LineItemType of the ProposalLineItem. For a programmatic ProposalLineItem, the value can only be one of: The allowed values are SPONSORSHIP, STANDARD, NETWORK, BULK, PRICE_PRIORITY, HOUSE, LEGACY_DFP, CLICK_TRACKING, ADSENSE, AD_EXCHANGE, BUMPER, ADMOB, PREFERRED_DEAL, UNKNOWN.
LineItemPriority	Int	False	The priority for the corresponding LineItem of the ProposalLineItem. This attribute is optional during creation and defaults to the default priority of the lineItemType. For forecasting, this attribute is optional and has a default value assigned by Google. See LineItem.priority for more information.
RateType	String	False	The method used for billing the ProposalLineItem. The allowed values are CPM, CPC, CPD, CPU, FLAT_FEE, VCPM, CPM_IN_TARGET, UNKNOWN.
CreativePlaceholders	String	False	Details about the creatives that are expected to serve through the ProposalLineItem. This attribute is optional during creation and defaults to the product's creative placeholders.
Targeting	String	False	Contains the targeting criteria for the ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting.
AppliedLabels	String	False	The set of labels applied directly to the ProposalLineItem. This attribute is optional.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.
DisableSameAdvertiserCompetitiveExclusion	Boolean	False	If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied. This attribute is optional and defaults to false.
IsSold	Boolean	True	Indicates whether this ProposalLineItem has been sold. This attribute is read-only.
NetRate	String	False	The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 100. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate,and ProposalLineItem.netCost is required.
NetCost	String	False	The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 10000. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required.
DeliveryIndicator	String	False	Indicates how well the line item generated from this proposal line item has been performing. This will be null if the delivery indicator information is not available due to one of the following reasons:
DeliveryData	String	False	Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This will be null if the delivery data cannot be computed due to one of the following reasons:
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 corresponding Order. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.
Name	String	False	The name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.name when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
StartDateTime	Datetime	True	The date and time at which the order and line items associated with the Proposal are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest ProposalLineItem.startDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only.
EndDateTime	Datetime	True	The date and time at which the order and line items associated with the Proposal stop being served. This attribute is derived from the proposal line item of the proposal which has the latest ProposalLineItem.endDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only.
Status	String	True	The status of the Proposal. This attribute is read-only. The allowed values are DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, UNKNOWN.
IsArchived	Boolean	True	The archival status of the Proposal. This attribute is read-only.
Advertiser	String	False	The advertiser, to which this Proposal belongs, and a set of Contact objects associated with the advertiser. The ProposalCompanyAssociation.type of this attribute should be ProposalCompanyAssociationType.ADVERTISER. This attribute is required when the proposal turns into an order, and its ProposalCompanyAssociation.companyId will be copied to Order.advertiserId. This attribute becomes readonly once the Proposal has been pushed.
Agencies	String	False	List of agencies and the set of Contact objects associated with each agency. This attribute is optional. A Proposal only has at most one Company with ProposalCompanyAssociationType.PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If primary agency exists, its ProposalCompanyAssociation.companyId will be copied to Order.agencyId when the proposal turns into an order.
InternalNotes	String	False	Provides any additional notes that may annotate the Proposal. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
PrimarySalesperson	String	False	The primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SalesPlannerIds	Long	False	List of unique IDs of User objects who are the sales planners of the Proposal. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
PrimaryTraffickerId	Long	False	The unique ID of the User who is primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.primaryTraffickerId . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
SellerContactIds	Long	False	Users who are the seller's contacts.
AppliedTeamIds	Long	False	The IDs of all teams that the Proposal is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
AppliedLabels	String	False	The set of labels applied directly to the Proposal. This attribute is optional.
EffectiveAppliedLabels	String	True	Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.
CurrencyCode	String	False	The currency code of this Proposal. This attribute is optional and defaults to network's currency code.
IsSold	Boolean	True	Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is OrderStatus.APPROVED or OrderStatus.PAUSED. This attribute is read-only.
LastModifiedDateTime	Datetime	True	The date and time this Proposal was last modified. This attribute is read-only.
MarketplaceInfo	String	False	The marketplace info of this proposal if it has a corresponding order in Marketplace.
BuyerRfp	String	False	The buyer RFP associated with this Proposal, which is optional. This field will be null if the proposal is not initiated from RFP.
HasBuyerRfp	Boolean	False	Whether a Proposal contains a BuyerRfp field. If this field is true, it indicates that the Proposal in question orignated from a buyer.
DeliveryPausingEnabled	Boolean	False	Whether pausing is consented for the Proposal. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.

Users

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

Select

The following queries are processed server side by the Google Ad Manager APIs. The driver processes other SELECT queries client-side in memory.

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@gmail.com', '-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 OAuth6 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.

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	This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderName	String	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerImpressions	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerClicks	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerCtr	Double	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerCpmAndCpcRevenue	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerWithoutCpdAverageEcpm	Double	This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderTrafficker	String	This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderStartDateTime	Datetime	This column maps to the field of the same name in the DoubleClick for Publishers API.
OrderEndDateTime	Datetime	This column maps to the field of the same name in the DoubleClick for Publishers API.

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

Query DoubleClick for Publishers Inventory Reports.

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	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerClicks	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
DynamicAllocationInventoryLevelImpressions	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
DynamicAllocationInventoryLevelClicks	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
TotalInventoryLevelImpressions	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
TotalInventoryLevelCpmAndCpcRevenue	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.

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. The driver processes other SELECT queries client-side in memory.

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

Query DoubleClick for Publishers Sales Reports.

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	This column maps to the field of the same name in the DoubleClick for Publishers API.
SalesPersonName	String	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerImpressions	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerCpmAndCpcRevenue	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.
AdServerWithoutCpdAverageEcpm	Long	This column maps to the field of the same name in the DoubleClick for Publishers API.

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.

Matillion Data Model for Google Ad ManagerVersion - 22.0.8389.0

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Authentication on Headless Machines

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Matillion Data Model for Google Ad Manager
Version - 22.0.8389.0