DoubleClick For Publishers Data Model

Connection String Options 

  1. Auto Cache
  2. Batch Size
  3. Cache Connection
  4. Cache Driver
  5. Cache Location
  6. Cache Metadata
  7. Cache Query Result
  8. Connection Life Time
  9. Connect On Open
  10. Firewall Password
  11. Firewall Port
  12. Firewall Server
  13. Firewall Type
  14. Firewall User
  15. Initiate OAuth
  16. Location
  17. Logfile
  18. Max Log File Size
  19. Max Rows
  20. Network Code
  21. OAuth Access Token
  22. OAuth Client Id
  23. OAuth Client Secret
  24. OAuth JWT Cert
  25. OAuth JWT Cert Password
  26. OAuth JWT Cert Subject
  27. OAuth JWT Cert Type
  28. OAuth JWT Issuer
  29. OAuth JWT Subject
  30. OAuth Refresh Token
  31. OAuth Settings Location
  32. OAuth Verifier
  33. Offline
  34. Other
  35. Pool Idle Timeout
  36. Pool Max Size
  37. Pool Min Size
  38. Pool Wait Time
  39. Proxy Auth Scheme
  40. Proxy Auto Detect
  41. Proxy Exceptions
  42. Proxy Password
  43. Proxy Port
  44. Proxy Server
  45. Proxy SSL Type
  46. Proxy User
  47. Pseudo Columns
  48. Readonly
  49. RTK
  50. SSL Server Cert
  51. Support Enhanced SQL
  52. Tables
  53. Timeout
  54. Use Connection Pooling
  55. Verbosity
  56. Version
  57. Views

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the DoubleClick for Publishers data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query DoubleClick for Publishers in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Orders#CACHE]

 

 

Setting the Caching Database

 

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

 

 

See Also

 

 

  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the DoubleClick for Publishers metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Batch Size

Data Type

int

Default Value

0

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.

 

Cache Connection

Data Type

string

Default Value

""

Remarks

 

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies 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 CacheProvider and CacheConnection. Below 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. Below 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. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below 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 username 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
Below 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 username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below 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
Below 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

 

Below 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
Below 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.
  • Username: 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.

 

 

Cache Driver

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 based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

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 is shipped in the JDK. You can find the JAR, 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:doubleclickfp: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:doubleclickfp:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

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

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:doubleclickfp:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;
  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for DoubleClick For Publishers 2018 installation directory.
SQL Server

 

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

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

 

Below is a JDBC URL for the Oracle Thin Client:

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

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:doubleclickfp:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';InitiateOAuth=GETANDREFRESH;

 

 

Cache Location

Data Type

string

Default Value

""

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 to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the DoubleClick for Publishers catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the DoubleClick for Publishers 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 metdata will change 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.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Connection Life Time

Data Type

string

Default Value

"0"

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.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to DoubleClick for Publishers 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 DoubleClick for Publishers 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).

 

Firewall Password

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.

 

Firewall Port

Data Type

string

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.

 

Firewall Server

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.

 

Firewall Type

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 DoubleClick for Publishers 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.

 

 

Firewall User

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.

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. 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.
  3. 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.

 

 

Location

Data Type

string

Default Value

""

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 Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

"100MB"

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). 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 100MB. Values lower than 100kB will use 100kB as the value instead.

 

Max Rows

Data Type

string

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.

 

Network Code

Data Type

string

Default Value

""

Remarks

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.

 

OAuth Access Token

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 username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

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.

 

OAuth Client Secret

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.

 

OAuth JWT Cert

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

 

OAuth JWT Cert Password

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.

 

OAuth JWT Cert Subject

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.

 

OAuth JWT Cert Type

Data Type

string

Default Value

""

Remarks

This property can take one of the following values:

 

   
USER - default 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.

 

 

OAuth JWT Issuer

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.

 

OAuth JWT Subject

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.

 

OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

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

 

OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\DoubleClickFP 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. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder. 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.

 

OAuth Verifier

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 the Getting Started section 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.

 

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to 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.

 

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

 

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

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

 

Pool Max Size

Data Type

string

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.

 

Pool Min Size

Data Type

string

Default Value

"1"

Remarks

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

 

Pool Wait Time

Data Type

string

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.

 

Proxy Auth Scheme

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.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Exceptions

Data Type

string

Default Value

""

Remarks

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

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

 

Proxy Password

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.

 

Proxy Port

Data Type

string

Default Value

"80"

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.

 

Proxy Server

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.

 

Proxy SSL Type

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.

 

 

Proxy User

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 username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

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; i.e., "*=*".

 

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. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to DoubleClick for Publishers and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the DoubleClick for Publishers API.

Execution of Predicates

 

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

 

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

 

The driver retrieves all rows necessary to process the aggregation in memory.

 

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. For example: Tables=TableA,TableB,TableC

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

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

 

Use Connection Pooling

Data Type

bool

Default Value

false

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

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 described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable, such as HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the request and the response.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

Version

Data Type

string

Default Value

"v201808"

Remarks

The lastest Double Click FP Api version. You will find this in their API documentation page.

 

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. For example: For example: Views=ViewsA,ViewsB,ViewsC




 

Tables

  1. Companies
  2. Contacts
  3. Creatives
  4. CustomFields
  5. CustomTargetingKeys
  6. Inventories
  7. Labels
  8. LineItems
  9. MobileApplications
  10. Orders
  11. Placements
  12. 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 ADVERTISER, HOUSE_ADVERTISER, HOUSE_AGENCY, AGENCY, AD_NETWORK, AFFILIATE_DISTRIBUTION_PARTNER, CONTENT_PARTNER, UNKNOWN.

CreditStatus String True

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.

LastModifiedDateTime Datetime True

The date and time this company was last modified.

 

 

 

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, CompanyId, and Email fields are required.

INSERT INTO [Contacts] (Name, CompanyId, Email) VALUES ('Cont', '4415064655', 'cont@email.com')
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 False

The status of the contact. This attribute is readonly and is assigned by Google.

Email String False

The e-mail address where the contact can be reached. This attribute is optional.

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.

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 DoubleClick for Publishers 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
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.

CompanyId Long False

The ID of the advertiser that owns the creative. This attribute is required.

Width Integer False

The width of the Creative.

Height Integer False

The height of the Creative.

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.

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

LastModifiedDateTime Datetime True

The date and time this creative was last modified.

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.

SslScanResult String True

The SSL compatibility scan result for this creative.

LockedOrientation String True

A locked orientation for this creative to be displayed in.

OverrideSize Boolean True

Allows the creative size to differ from the actual HTML5 asset size. This attribute is optional. thirdPartyImpressionTrackingUrls.

IsSafeFrameCompatible Boolean True

Whether the Creative is compatible for SafeFrame rendering.

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

CustomFieldName String True

This is the name of the custom field. There will be as many custom columns as custom fields are related to Creatives.

 

 

 

CustomFields

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

 

Select

 

The following queries are processed server side by the DoubleClick for Publishers 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 DoubleClick for Publishers 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, DisplayName, and Type fields are required.

INSERT INTO [CustomTargetingKeys] (Name, DisplayName, Type) VALUES ('tg_key', 'targeting 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.

 

 

 

Inventories

Create, update, and query DoubleClick for Publishers Inventories.

 

Select

 

The following queries are processed server side by the DoubleClick for Publishers 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] Long 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 Long 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.

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.

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.

AdUnitCode String True

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.

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.

MobilePlatform String True

The platform associated with a mobile AdUnit, i.e. whether this ad unit appears in a mobile application or in a mobile web site. This attribute can only be used with TargetPlatform.MOBILE ad units. This attribute is optional and defaults to MobilePlatform.SITE.

ExplicitlyTargeted Boolean True

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 DFP Premium accounts.

SmartSizeMode String True

The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes.

LastModifiedDateTime Datetime True

The date and time this ad unit was last modified.

IsSharedByDistributor Boolean True

Whether this ad unit is shared by a distributor network. When this field is true, then crossSellingDistributor will contain data for the distributor network. 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.

 

 

 

Labels

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

 

Select

 

The following queries are processed server side by the DoubleClick for Publishers 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 and Types fields are required.

INSERT INTO [Labels] (Name, Types) VALUES ('new lbl', 'COMPETITIVE_EXCLUSION')
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 is 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.

Types String False

The types of the Label.

The allowed values are COMPETITIVE_EXCLUSION, AD_UNIT_FREQUENCY_CAP, AD_EXCLUSION, CREATIVE_WRAPPER, UNKNOWN.

 

 

 

LineItems

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

 

Select

 

The following queries are processed server side by the DoubleClick for Publishers 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, StartDateTimeType, EndDateTime, TimeZoneId, CreativeRotationType, LineItemType, CurrencyCode, MicroAmount, CostType, CreativePlaceholdersAggregate, AllowOverbook, GoalType, GoalUnitType, GoalUnits, GeoTargetingAggregate, and InventoryTargetingAggregate.

INSERT INTO [LineItems] (OrderId, Name, StartDateTimeType, EndDateTime, TimeZoneId, 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
Id [KEY] Long True

Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created.

ExternalId Long True

An identifier for the LineItem that is meaningful to the publisher.

Name String False

The name of the line item. This attribute is required and has a maximum length of 255 characters.

OrderId Long False

The ID of the Order to which the LineItem belongs. This attribute is required.

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.

StartDateTimeType String False

Specifies whether to start serving to the LineItem right away, in an hour, etc.

The allowed values are USE_START_DATE_TIME, IMMEDIATELY, ONE_HOUR_FROM_NOW, UNKNOWN.

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.

TimeZoneId String False

The timezone id of the LineItem

AutoExtensionDays Integer True

The number of days to allow a line item to deliver past its endDateTime. A maximum of 7 days is allowed. This is a premium feature available for LineItemType.STANDARD line items.

UnlimitedEndDateTime Boolean True

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.

The allowed values are EVEN, OPTIMIZED, MANUAL, SEQUENTIAL.

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.

The allowed values are EVENLY, FRONTLOADED, AS_FAST_AS_POSSIBLE.

RoadblockingType String True

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.

LineItemType String False

Indicates the line item type of a LineItem. This attribute is required.

The allowed values are SPONSORSHIP, STANDARD, NETWORK, BULK, PRICE_PRIORITY, HOUSE, LEGACY_DFP, CLICK_TRACKING, ADSENSE, AD_EXCHANGE, BUMPER, ADMOB, UNKNOWN.

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.

CostType String False

The method used for billing this LineItem. This attribute is required.

The allowed values are CPA, CPC, CPD, CPM, UNKNOWN, VCPM.

Priority Integer True

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.

CreativePlaceholdersAggregate String False

Details about the creatives that are expected to serve through this LineItem. This attribute is required and replaces the creativeSizes attribute.

DiscountType String True

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

EnvironmentType String True

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.

CompanionDeliveryOption String True

The delivery option for companions

CreativePersistenceType String True

Specifies options to prevent ads from replacing or appearing with this LineItem.

AllowOverbook Boolean 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.

SkipInventoryCheck Boolean True

The flag indicates whether the inventory check should be skipped when performing an action on this line item. The default value is false.

SkipCrossSellingRuleWarningChecks Boolean True

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 Boolean True

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.

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 Boolean True

The archival status of the LineItem. This attribute is readonly.

DisableSameAdvertiserCompetitiveExclusion Boolean True

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 True

Provides any additional notes that may annotate the LineItem. This attribute is optional and has a maximum length of 65,535 characters.

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.

IsPrioritizedPreferredDealsEnabled Boolean True

Whether an AdExchange line item has prioritized preferred deals enabled. This attribute is optional and defaults to false.

AdExchangeAuctionOpeningPriority Integer True

The priority at which an Ad Exchange line item enters the open Ad Exchange auction if the preferred deal fails to transact. This attribute is optional. If prioritized preferred deals are enabled, it defaults to 12. Otherwise, it is ignored.

IsSetTopBoxEnabled Boolean True

Flag that specifies whether this LineItem is a set-top box enabled line item. Set-top box line items only support the following creative sizes: 1920x1080 and 640x480.

IsMissingCreatives Boolean True

Indicates if a LineItem is missing any creatives for the creativePlaceholders specified.

VideoMaxDuration Integer True

The max duration of a video creative associated with this LineItem in milliseconds. This attribute is optional, defaults to 0, and only meaningful if this is a video line item.

GoalType String False

The type of the goal for the LineItem. It defines the period over which the goal for LineItem should be reached.

The allowed values are NONE, LIFETIME, DAILY, UNKNOWN.

GoalUnitType String False

The type of the goal unit for the LineItem.

The allowed values are IMPRESSIONS, CLICKS, CLICK_THROUGH_CPA_CONVERSIONS, VIEW_THROUGH_CPA_CONVERSIONS, TOTAL_CPA_CONVERSIONS, UNKNOWN, VIEWABLE_IMPRESSIONS.

GoalUnits Integer False

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the LineItem.

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.

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 DoubleClick for Publishers 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 AppStore fields are required.

INSERT INTO [MobileApplications] (DisplayName, AppStoreId, AppStore) 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.

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.

AppStore String False

The app store the mobile application belongs to. This attribute is required for creation and then is read-only.

The allowed values are GOOGLE_PLAY, APPLE_ITUNES, UNKNOWN.

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.

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.

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 DoubleClick for Publishers 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, TraffickerId, and CreatorId fields are required.

INSERT INTO [Orders] (Name, AdvertiserId, TraffickerId, CreatorId) VALUES ('Ord313', '4410125029', '244525926' ,'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.

Status String False

The status of the Order. This attribute is read-only.

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

IsArchived Boolean False

The archival status of the Order. This attribute is readonly.

ExternalOrderId Long False

An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional.

CurrencyCode String False

Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters.

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

CreatorId Long False

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

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.

TotalImpressionsDelivered Long False

Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google.

TotalClicksDelivered Long False

Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google.

TotalViewableImpressionsDelivered Long False

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

LastModifiedByApp String False

The application which modified this order. This attribute is read only and is assigned by Google.

IsProgrammatic Boolean False

Specifies whether or not the Order is a programmatic order. This value is optional and defaults to false.

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 DoubleClick for Publishers 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, Description, and TargetedAdUnitIds fields are required.

INSERT INTO [Placements] (Name, Description, TargetedAdUnitIds ) VALUES ('placement', 'testtttttttt', '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.

IsAdSenseTargetingEnabled Boolean True

Describes whether the Placement is available for site targeting by AdWords advertisers.

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.

 

 

 

Users

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

 

Select

 

The following queries are processed server side by the DoubleClick for Publishers 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 True

Specifies whether or not the User wants to permit the Publisher Display Ads system to send email notifications to his or her email address. This attribute is optional and defaults to true.

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.

 

 




 

Views

  1. DeliveryReport
  2. InventoryReport
  3. Roles
  4. SalesReport

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

 

 

 

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.

 

 

 

Roles

Query DoubleClick for Publishers Roles.

 

Select

 

The following queries are processed server side by the DoubleClick for Publishers 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.

 

 

 

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.