Connection String OptionsBack To Top

APIVersion
InitiateOAuth
OAuthClientId
OAuthClientSecret
OAuthAccessToken
OAuthSettingsLocation
CallbackURL
Scope
OAuthVerifier
OAuthRefreshToken
OAuthExpiresIn
OAuthTokenTimestamp
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
RTK
Timeout
UseConnectionPooling
UserDefinedViews

APIVersion

Data Type

string

Default Value

"202210"

Remarks

The API version used by default is 202210. To use a different API version set this to the format YYYYMM.

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.

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\\LinkedInAds 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\\LinkedInAds 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

CallbackURL

Data Type

string

Default Value

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

Scope

Data Type

string

Default Value

Remarks

This property must be set in the connection string to get a scoped token with specific privileges.

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.

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 LinkedIn Marketing Solutions 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\\LinkedInAds 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\\LinkedInAds 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:linkedinads:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;

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:linkedinads:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;

SQLite

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

jdbc:linkedinads:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;

MySQL

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

  jdbc:linkedinads:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;

SQL Server

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

jdbc:linkedinads:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;

Oracle

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

jdbc:linkedinads:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;

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:linkedinads:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;

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\\LinkedInAds 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\\LinkedInAds 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 LinkedIn Marketing Solutions 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 LinkedIn Marketing Solutions 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 LinkedIn Marketing Solutions 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 LinkedIn Marketing Solutions. 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, "*=*".

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 Analytics 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"

ViewsBack To Top

Accounts
AdFormResponses
Analytics
AudienceCount
BudgetPricing
CampaignGroups
CampaignInsights
CampaignRecommendations
Campaigns
Conversions
Creatives
Degrees
FieldsOfStudy
Forms
Industries
JobFunctions
Locations
Posts
Seniorities
Skills
SocialActions
ThirdPartyTracking
Titles

Accounts

The Account status finder returns all accounts in a specified status that the authenticated user has access to.

Table Specific Information

Select

The Accounts view returns a list of the accounts that belong to the authenticated user so they can be used as dimensions in analytic requests.

The driver uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The driver processes other filters client-side within the driver. For example, the following queries are processed server side.

SELECT * FROM Accounts



SELECT * FROM Accounts WHERE Status='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Id of the account
Name	String	A label for the account
Currency	String	The account's ISO-4217currency code.
Type	String	The type of account.
NotifiedOnCreativeRejection	Boolean	Indicates if creative contact is notified when a creative has been rejected due to content.
NotifiedOnEndOfCampaign	Boolean	Indicates if campaign contact is notified when an associated campaign has been completed.
Status	String	Status of the account
NotifiedOnCampaignOptimization	Boolean	Indicates if campaign contact is notified about campaign optimization opportunities.
Version	String	Version of the account
Reference	String	The entity on whose behalf the account advertises.
NotifiedOnCreativeApproval	Boolean	Indicates if creative contact is notified when a creative has been reviewed and approved.
AuditStampsCreator	String	The person who created audit stamps for the first time
AuditStampsCreatedAt	Datetime	The datetime in which the audit stamp was created first
AuditStampsLastModifier	String	Last modifier of the Audit stamps
AuditStampsLastModifiedAt	Datetime	Last modified datetime of the audit stamps

AdFormResponses

The response data for leads that filled out a form within the last 90 days. Older responses are not included.

Columns


Name	Type	Description
Id	String
Account	String	The URN which describes which account the response is generated under.
Campaign	String	URN identifying the campaign to which the form response is responding.
Creative	String	URN identifying the creative to which the form response is responding.
Form	String	URN identifying which form this response responds to.
SubmitedAt	Datetime	The time when the form response was submited
LeadType	String	Type of the lead. This field indicates whether the lead is collected from sponsored content or viral share. Defaults to SPONSORED.
TestLead	Boolean	If the lead is a test lead
ConsentResponses	String	A Json object containing all the consent responses.
Answers	String	A Json object containing all the answers and the respective questions.

Analytics

The Analytics API provides account, campaign, and creative level insights on click intelligence numbers.

Table Specific Information

Select

The Analytics view provides account, campaign, and creative level insights on click intelligence numbers. Examples of these insights include clicks, shares, and impressions.

The driver uses the LinkedIn Marketing Solutions API to process search criteria. The driver processes other filters client-side within the driver. For example, the following queries are processed server side.

SELECT ReportStartTime, ReportEndTime, Clicks, Impressions, Follows, TotalEngagements From Analytics WHERE ReportStartTime='07/20/2016' AND Account='123456789' AND Granularity='MONTHLY'

Select Rules

Analytic reports:


Dimensions	Required	FinderMethod, ReportStartTime, Granularity
	Optional	ReportEndTime, CampaignType
If FinderMethod is Analytics	Use 0 or 1 (Default is Campaign)	Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex, MemberCompanySize, MemberIndustry, MemberSeniority, MemberJobTitle, MemberJobFunction, MemberCountry, MemberRegion, MemberCompany
If FinderMethod is Statistics	Use 1 or 2 (Default is Campaign)	Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex Note: The default value for FinderMethod will be Analytics. The default value for Granularity will be MONTHLY. The default time window will be the last year period.
Metrics	Use 1 or more	ActionClicks, AdUnitClicks, CardClicks, CardImpressions, Clicks, CommentLikes, Comments, CompanyPageClicks, ConversionValueInLocalCurrency, CostInLocalCurrency, CostInUsd, StartPeriod, EndPeriod, ExternalWebsiteConversions, ExternalWebsitePostClickConversions, ExternalWebsitePostViewConversions, Follows, FullScreenPlays, Impressions, LandingPageClicks, LeadGenerationMailContactInfoShares, LeadGenerationMailInterestedClicks, Likes, OneClickLeadFormOpens, OneClickLeads, Opens, OtherEngagements, Pivot, PivotValue, Shares, TextUrlClicks, TotalEngagements, VideoCompletions, VideoFirstQuartileCompletions, VideoMidpointCompletions, VideoStarts, VideoThirdQuartileCompletions, VideoViews, ViralCardClicks, ViralCardImpressions, ViralClicks, ViralComments, ViralCompanyPageClicks, ViralExternalWebsiteConversions, ViralExternalWebsitePostClickConversions, ViralExternalWebsitePostViewConversions, ViralFollows, ViralFullScreenPlays, ViralImpressions, ViralLandingPageClicks, ViralLikes, ViralOneClickLeadFormOpens, ViralOneClickLeads, ViralOtherEngagements, ViralShares, ViralTotalEngagements, ViralVideoCompletions, ViralVideoFirstQuartileCompletions, ViralVideoMidpointCompletions, ViralVideoStarts, ViralVideoThirdQuartileCompletions, ViralVideoViews, AverageDailyReachMetricsApproximateReach, AverageDailyReachMetricsApproximateFrequency, AverageDailyReachMetricsApproximateCost, AveragePreviousSevenDayReachMetricsApproximateReach, AveragePreviousSevenDayReachMetricsApproximateFrequency, AveragePreviousSevenDayReachMetricsApproximateCost, AveragePreviousThirtyDayReachMetricsApproximateReach, AveragePreviousThirtyDayReachMetricsApproximateFrequency, AveragePreviousThirtyDayReachMetricsApproximateCost
Filter	Use 1 or more	Account, Campaign, Creative Note: If there are no filters specified the default filter will be all the accounts that belong to the user.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Company	String	Pivot value which groups the result by advertiser's company.
Account	String	Pivot value which groups the result by account.
Share	String	Pivot value which groups the result by sponsored share.
Campaign	String	Pivot value which groups the result by campaign.
Creative	String	Pivot value which groups the result by creative.
CampaignGroup	String	Pivot value which groups the result by campaign group.
Conversion	String	Pivot value which groups the result by conversion.
ServingLocation	String	Pivot value which groups the result by serving location.
CardIndex	String	Pivot value which groups the result by card index.
MemberCompanySize	String	Pivot value which groups the result by member company size.
MemberIndustry	String	Pivot value which groups the result by member industry.
MemberSeniority	String	Pivot value which groups the result by member seniority.
MemberJobTitle	String	Pivot value which groups the result by member job title.
MemberJobFunction	String	Pivot value which groups the result by member job function.
MemberCountry	String	Pivot value which groups the result by member country.
MemberRegion	String	Pivot value which groups the result by member region.
MemberCounty	String	Pivot value which groups the result by member county.
MemberCompany	String	Pivot value which groups the result by member company.
CampaignType	String	Match result by campaign type.
Granularity	String	Time granularity of results. The default value is MONTHLY.
FinderMethod	String	Designates the query finder. The only allowed values are The default value is analytics.
ReportStartTime	String	The start time of the period.
ReportEndTime	String	The end time of the period.
ActionClicks	Long	The count of clicks on the action button of the Sponsored InMail.
AdUnitClicks	Long	The count of clicks on the ad unit displayed alongside the Sponsored InMail.
CardClicks	Long	The number of clicks for each card of a carousel ad.
CardImpressions	Long	The number of impressions shown for each card of a carousel ad.
Clicks	Long	The count of chargeable clicks.
CommentLikes	Long	The count of likes of a comment.
Comments	Long	The count of comments. Sponsored
CompanyPageClicks	Long	The count of clicks to view the company page.
ConversionValueInLocalCurrency	Decimal	Value of the conversions in the account's local currency based on rules defined by the advertiser.
CostInLocalCurrency	Decimal	Cost in the account's local currency based on the pivot and timeGranularity.
CostInUsd	Decimal	Cost in USD based on the pivot and timeGranularity.
UsageStartTime	String	Date start covered by the report data point.
UsageEndTime	String	Date end covered by the report data point.
ExternalWebsiteConversions	Long	The count of conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostClickConversions	Long	The count of post-click conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostViewConversions	Long	The count of post-view conversions indicated by pixel loads on an external advertiser website.
Follows	Long	The count of follows. Sponsored
FullScreenPlays	Long	A user taps on the video, going into video view mode.
Impressions	Long	This is the count of 'impressions' for Direct Ads and Sponsored Updates and 'sends' for InMails.
LandingPageClicks	Long	The count of clicks which take the user to the creative landing page.
LeadGenerationMailContactInfoShares	Long	The number of times a user shared contact info through the One Click Leadgen for Sponsored InMail.
LeadGenerationMailInterestedClicks	Long	The count of InMail recipients showing interest.
Likes	Long	The count of likes.
OneClickLeadFormOpens	Long	The count of times a user opened the lead form for a One Click Lead Gen campaign.
OneClickLeads	Long	The count of leads generated through One Click Lead Gen.
Opens	Long	The count of opens of Sponsored InMail.
OtherEngagements	Long	The count of user interactions with the ad unit that do not fit into any other more specific category.
Shares	Long	The count of shares.
TextUrlClicks	Long	The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail.
TotalEngagements	Long	The count of all user interactions with the ad unit.
VideoCompletions	Long	The count of video ads that played 97-100% of the video.
VideoFirstQuartileCompletions	Long	The count of video ads that played through the first quartile of the video.
VideoMidpointCompletions	Long	The count of video ads that played through the midpoint of the video.
VideoStarts	Long	The count of video ads that were started by a user.
VideoThirdQuartileCompletions	Long	The count of video ads that played through the third quartile of the video.
VideoViews	Long	A video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
ViralCardClicks	Long	The number of viralClicks for each card of a carousel ad.
ViralCardImpressions	Long	The number of viralImpressions shown for each card of a carousel ad.
ViralClicks	Long	The count of clicks on viral impressions.
ViralComments	Long	The count of comments from viral impressions for this activity.
ViralCompanyPageClicks	Long	The count of clicks to view the company page from viral impressions for this activity.
ViralExternalWebsiteConversions	Long	The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.
ViralExternalWebsitePostClickConversions	Long	The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click.
ViralExternalWebsitePostViewConversions	Long	The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression.
ViralFollows	Long	The count of follows from viral impressions for this activity.
ViralFullScreenPlays	Long	A user taps on the video, going into video view mode.
ViralImpressions	Long	The count of viral impressions for this activity.
ViralLandingPageClicks	Long	The count of clicks on viral impressions to take the user to the creative landing page.
ViralLikes	Long	The count of likes from viral impressions for this activity.
ViralOneClickLeadFormOpens	Long	The count of times a user opened the lead form for viral impressions from a Lead Gen campaign.
ViralOneClickLeads	Long	The count of leads generated through One Click Lead Gen from viral impressions for this activity.
ViralOtherEngagements	Long	The count of user interactions with viral impressions that do not fit into any other more specific category.
ViralShares	Long	The count of shares from viral impressions for this activity.
ViralTotalEngagements	Long	The count of all user interactions with a viral ad unit.
ViralVideoCompletions	Long	The count of viral video ads that played 97-100% of the video.
ViralVideoFirstQuartileCompletions	Long	The count of viral video ads that played through the first quartile of the video.
ViralVideoMidpointCompletions	Long	The count of viral video ads that played through the midpoint of the video.
ViralVideoStarts	Long	The count of viral video ads that were started by a user.
ViralVideoThirdQuartileCompletions	Long	The count of viral video ads that played through the third quartile of the video.
ViralVideoViews	Long	A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
AverageDailyReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (daily).
AverageDailyReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (daily).
AverageDailyReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (daily).
AveragePreviousSevenDayReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 7 days).
AveragePreviousThirtyDayReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 30 days).
ApproximateUniqueImpressions	Long	The estimated number of unique member accounts with at least one impression.

AudienceCount

The Audience Count API allows advertisers to forecast the reach of targeting criteria.

Table Specific Information

Select

The AudienceCount view allows advertisers to forecast the reach of targeting criteria.

The driver uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The driver processes other filters client-side within the driver. For example, the following queries are processed server side.

SELECT * FROM AudienceCount WHERE AgeRanges='(25,34)'



SELECT * FROM AudienceCount WHERE DegreesId='1234'



SELECT * FROM AudienceCount WHERE FieldsOfStudyId='1234'



SELECT * FROM AudienceCount WHERE Genders='MALE'



SELECT * FROM AudienceCount WHERE IndustriesId='1234'



SELECT * FROM AudienceCount WHERE JobFunctionsId='1234'



SELECT * FROM AudienceCount WHERE LocationsId='1234'



SELECT * FROM AudienceCount WHERE ProfileLocationsId='1234'



SELECT * FROM AudienceCount WHERE SenioritiesId='1234'



SELECT * FROM AudienceCount WHERE SkillsId='1234'



SELECT * FROM AudienceCount WHERE StaffCountRanges='(11,50)'



SELECT * FROM AudienceCount WHERE TitlesId='1234'

Select Rules

Audience count reports:


Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
ActiveAudience	Integer	Active audience count for the given targeting criteria.
TotalAudience	Integer	Total audience count for the given targeting criteria.

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
AgeRange	String	Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeId	String	Educational degrees attained to match against those of the member.
FieldOfStudyId	String	Fields of study to match against those listed by the member.
Gender	String	Genders to match against member. Supported values are: MALE, FEMALE
IndustryId	String	Industries to be targeted.
JobFunctionId	String	Top level groupings of supertitles to be targeted.
LocationId	String	Location to be targeted.
ProfileLocationId	String	The values are similar to
SeniorityId	String	Seniorities to be targeted.
SkillId	String	Skills to match against the member's listed skills.
StaffCountRange	String	Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleId	String	Job titles to match against the member's current title.
AudienceMatchingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerId	String	Employer ID to match against member's listed companies.
CompanyId	String	Company ID to match against member's listed companies.
InterfaceLocaleId	String	Locale ID to match against member's preferred locale settings.

BudgetPricing

The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.

Table Specific Information

Select

The BudgetPricing view provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.

SELECT * FROM BudgetPricing WHERE AgeRanges='(25,34)' AND Account='1234'



SELECT * FROM BudgetPricing WHERE DegreesId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE FieldsOfStudyId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE Genders='MALE' AND Account='1234'



SELECT * FROM BudgetPricing WHERE IndustriesId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE JobFunctionsId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE LocationsId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE ProfileLocationsId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE SenioritiesId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE SkillsId='1234' AND Account='1234'



SELECT * FROM BudgetPricing WHERE StaffCountRanges='(11,50)' AND Account='1234'



SELECT * FROM BudgetPricing WHERE TitlesId='1234' AND Account='1234'

Select Rules

Budget pricing reports:


Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.
Filter	Required	CampaignType, Account, BidType, MatchType Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. The default value for CampaignType will be TEXT_AD. The default value for BidType will be CPM. The default value for MatchType will be EXACT. If there is no Account specified there will be records for every account that belongs to the user.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
SuggestedBidDefault	String	The suggested bid
SuggestedBidMin	String	Low end of suggested bid range
SuggestedBidMax	String	High end of suggested bid range
DailyBudgetLimitsDefault	String	Default daily budget
DailyBudgetLimitsMin	String	Minimum daily budget
DailyBudgetLimitsMax	String	Maximum daily budget
BidLimitsMax	String	The maximum bid allowed
BidLimitsMin	String	The minimum bid allowed, also known as the floor price
Account	String	Sponsored account URN.
CampaignType	String	The campaign type. The default value is TEXT_AD.
BidType	String	The bidding type. The default value is CPM.
MatchType	String	The matching type. The default value is EXACT.

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
AgeRange	String	Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeId	String	Educational degrees attained to match against those of the member.
FieldOfStudyId	String	Fields of study to match against those listed by the member.
Gender	String	Genders to match against member. Supported values are: MALE, FEMALE
IndustryId	String	Industries to be targeted.
JobFunctionId	String	Top level groupings of supertitles to be targeted.
LocationId	String	Location to be targeted.
ProfileLocationId	String	The values are similar to
SeniorityId	String	Seniorities to be targeted.
SkillId	String	Skills to match against the member's listed skills.
StaffCountRange	String	Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleId	String	Job titles to match against the member's current title.
AudienceMatchingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerId	String	Employer ID to match against member's listed companies.
CompanyId	String	Company ID to match against member's listed companies.
InterfaceLocaleId	String	Locale ID to match against member's preferred locale settings.

CampaignGroups

The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.

Table Specific Information

Select

The CampaignGroups view returns a list of the campaign groups that belong to the authenticated user so they can be used as dimensions in analytic requests.

SELECT * FROM CampaignGroups



SELECT * FROM CampaignGroups WHERE Status='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Numerical identifier for the campaign group
Account	String	URN identifying the advertising account associated with the Campaign Group. This value is immutable once set
Name	String	The name of the Campaign Group. Primarily used to make it easier to reference a Campaign Group and to recall its purpose
Status	String	Current Status of the campaign group
TotalBudgetAmount	Decimal	Maximum amount to spend over the life of the Campaign Group.
TotalBudgetCurrencyCode	String	ISO currency code. The currency code must match that of the parent account.
ScheduleStartTime	Datetime	Represents the inclusive (greater than or equal to) value in which to start the range.
ScheduleEndTime	Datetime	Scheduled date range to run associated objects.
Backfilled	Boolean	Flag that denotes whether the Campaign Group was created organically or was created to backfill existing campaigns.

CampaignInsights

The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.

Table Specific Information

Select

The CampaignInsights view returns a list of the analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.

SELECT * FROM CampaignInsights



SELECT * FROM CampaignInsights WHERE Campaign='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Campaign	String	The campaign to which this recommendation belongs.
AverageSpendAmount	String	The average spend of the entity.
AverageSpendCurrencyCode	String	The currency code of the average spend.
BidAmount	String	A prediction of how much additional impressions could be generated from a different bid.
BidCurrencyCode	String	The currency code of additional impressions.
RelativeImpressions	Decimal	A prediction of how much additional impressions could be generated from a different bid.
BudgetExhaustedAt	Timestamp	Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.
CampaignRelevanceScore	Long	A score between 0 and 10 (inclusive) indicating how relevant this campaign is compared to its competitors.
DailyBudgetUtilization	Decimal	The average daily budget utilization.
TotalBudgetUtilization	Decimal	The fraction of the total budget this ad entity has spent so far.

CampaignRecommendations

The Recommendations API offers recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.

Table Specific Information

Select

The CampaignInsights view returns a list of the recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.

SELECT * FROM CampaignRecommendations



SELECT * FROM CampaignRecommendations WHERE Campaign='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Campaign	String	The campaign to which this recommendation belongs.
CreatedAt	Timestamp	The epoch timestamp in milliseconds of when this recommendation was generated.
ExpandAudience	Boolean	If true, the recommendation is to expand the audience of this campaign.
ImproveCreativeQuality	Long	If true, the recommendation is to improve the quality of this campaign's creatives.
NumOfCreatives	Long	The recommended number of creatives in the campaign.
Priority	Long	The priority of the recommendation, 0 indexed, with 0 being the highest priority.
Type	String	The type of recommendation.

Campaigns

The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.

Table Specific Information

Select

The Campaigns view returns a list of the campaigns that belong to the authenticated user so they can be used as dimensions in analytic requests.

SELECT * FROM Campaigns



SELECT * FROM Campaigns WHERE Status='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Numerical identifier for the campaign
Account	String	URN identifying the advertising account associated with the Campaign.
CampaignGroup	String	Numerical identifier for the campaign group.
AssociatedEntity	String	An URN for a strongly associated object, with semantics varying based on the Campaign type.
AudienceExpansionEnabled	Boolean	Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria
CostType	String	CPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link
CreativeSelection	String	ROUND_ROBIN - Rotate through available creatives to serve them as easily as possible. OPTIMIZED - Bias selection taking into account such things as expected performance
DailyBudgetAmount	String	The amount of money as a real number string
DailyBudgetCurrency	String	ISO currency code
Country	String	An uppercase two-letter country code as defined by ISO-3166.
Language	String	A lowercase two-letter language code as defined by ISO-639.
Name	String	The name of the Campaign
OffsiteDeliveryEnabled	Boolean	Allow this campaign access to be served on the LinkedIn Advertising Network.
ScheduleStartTime	Datetime	Scheduled date range to run associated creatives.
ScheduleEndTime	Datetime	Scheduled date range to run associated creatives.
Status	String	Current Status of the campaign
Type	String	Type of campaign
UnitCostAmount	String	Amount to bid per click, impression, or other event depending on the pricing model.
UnitCostCurrency	String	Currency of the UnitCostAmount
ObjectiveType	String	The Campaign Objective type.

Conversions

Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business.

Table Specific Information

Select

The Conversions view returns a list of the insights into post-click and view-through conversions of your LinkedIn ads campaigns, giving you the ability to measure the impact and ROI of your ads.

SELECT * FROM Conversions



SELECT * FROM Conversions WHERE Account='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Numerical identifier for the Conversion.
Account	String	URN identifying the advertising account associated with the Conversion.
DomainId	String	The insightTagDomain key that this Conversion resides under.
Name	String	A short name for this rule, which will be shown in the UI and in reports.
Created	String	The timestamp when the Conversion was created.
LastModified	String	The timestamp when the Conversion was last modified.
LastCallbackAt	String	The timestamp of the last callback from the Conversion.
Amount	String	The amount of money as a real number string.
CurrencyCode	String	Identifying code for currency type. See currency codes for the valid codes.
Type	String	The type of the rule.
Enabled	String	Set to true or false to enable or disable this rule from matching on the advertiser's website.
ImagePixelTag	String	The HTML representation of the image pixel.
PostClickAttributionWindowSize	Integer	The HTML representation of the image pixel.
ViewThroughAttributionWindowSize	Integer	The HTML representation of the image pixel.

Creatives

The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.

Table Specific Information

Select

The Creatives view returns a list of the creatives that belong to the authenticated user so they can be used as dimensions in analytic requests.

The driver uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id, Account, Campaign, and IntendedStatus columns. The driver processes other filters client-side within the driver. For example, the following queries are processed server side.

SELECT * FROM Creatives



SELECT * FROM Creatives WHERE Id='179345687'



SELECT * FROM Creatives WHERE Account='510013292'



SELECT * FROM Creatives WHERE Account IN ('510013292', '510013293')



SELECT * FROM Creatives WHERE Campaign='198952936'



SELECT * FROM Creatives WHERE IntendedStatus='ACTIVE'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Numerical identifier for the creative.
Account	String	URN identifying the advertising account associated with the creative.
Campaign	String	URN identifying the campaign associated with the creative.
Content	String	Content sponsored in the creative.
CreatedAt	Datetime	Datetime when the creative was first created
CreatedBy	String	Entity that developed the creative.
IntendedStatus	String	Creative user intended status.
IsServing	Boolean	This indicates whether the creative is currently being served or not.
ServingHoldReasons	String	Array that contains all the reasons why the creative is not serving.
LastModifiedAt	Datetime	Datetime when the creative was last modified.
LastModifiedBy	String	Entity that modified the creative.
ReviewStatus	String	The current review status of the creative.
IsTest	Boolean	Flag showing whether this creative is a test creative, i.e., belongs to a test campaign.

Degrees

Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Degrees view returns a list of the degrees found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM Degrees

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Degree id
URN	String	Standardized degree URN
Name	String	Degree name in various locales. Represented as MultiLocaleString type.

FieldsOfStudy

Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The FieldsOfStudy view returns a list of the fields of study found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM FieldsOfStudy

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Field of study id
URN	String	Standardized field of study URN
Name	String	Field of study name in various locales. Represented as MultiLocaleString type.

Forms

LinkedIn Lead Gen Forms make it easy for advertisers to collect leads through forms that LinkedIn members can submit.

Table Specific Information

Select

The Forms view returns a list of the forms that LinkedIn members can submit. With Lead Gen Forms, advertisers can collect leads at much higher conversion rates.

SELECT * FROM Forms



SELECT * FROM Forms WHERE Account='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Numerical identifier for the AdForm.
Account	String	URN identifying the owner of the form. This is the advertiser account.
Created	Timestamp	Timestamp for creation of the form.
LastModified	Timestamp	Timestamp for last modification of the form.
Description	String	Description of the form, visible to both the owner and the viewer.
Headline	String	Headline of the form, visible to both the owner and the viewer.
LandingPage	String	The landing page URL after the viewer clicks on submit.
LegalDisclaimer	String	Advertiser's legal disclaimer to accompany this form.
Name	String	Name of the form, visible to the owner of the form but not visible to the viewer.
PrivacyPolicy	String	The URL of the privacy policy that covers any data passed to the owner of the form.
Country	String	Locale of the form.
Language	String	Locale of the form.
ReviewStatus	String	The status of the review of the form.
ReviewedAt	Timestamp	The timestamp of the review of the form.
Status	String	DRAFT, SUBMITTED, PAUSED, ARCHIVED, or CANCELED.
VersionTag	String	The number of times the form has been modified.

Industries

Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Industries view returns a list of the industries found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM Industries

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Industry id
URN	String	Standardized industry URN
Name	String	Industry name in various locales. Represented as MultiLocaleString type.
ChildrenIndustries	String	The URNs of the children industries associated with this node.
ParentIndustries	String	The URNs of the parent industry associated with this node.

JobFunctions

Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The JobFunctions view returns a list of the Job Functions found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM JobFunctions

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Job function id
URN	String	Standardized Job function URN
Name	String	Job function name in various locales. Represented as MultiLocaleString type.

Locations

Location taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Locations view returns a list of the locations and regions found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM Locations

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	The country code.
CountryGroup	String	The country group URN that this country belongs to.
URN	String	Standardized country URN
Name	String	Country name in various locales. Represented as LocaleString type.

Posts

Retrieve all posts for an organization.

Select

The driver will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.

OrganizationId supports the '=' comparisons.

OrganizationID

You can obtain OrganizationId information from the LinkedIn dashboard. The syntax is:

"com.linkedin.common.CompanyAttributedEntity": { "company": "urn:li:organization:12345" }

Code Samples

The following queries are processed server side:

SELECT * FROM UGCPosts WHERE OrganizationId='123456789'

Columns


Name	Type	Description
Id [KEY]	String	Id of the post.
Author	String	Author of the post.
Commentary	String	The user generated commentary for the post.
Content	String	The posted content.
CreatedAt	Datetime	Datetime when the post was created.
IsReshareDisabledByAuthor	Boolean	Indicates whether resharing of the post has been disabled by the author.
LastModifiedAt	Datetime	Datetime when the post was lastly modified.
LifecycleState	String	Lifecycle state of the post.
PublishedAt	Datetime	Datetime at which the content was published.
Visibility	String	Visibility restrictions on content.
OrganizationId	String	Id of the organization who created the post.

Seniorities

Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Seniorities view returns a list of the seniority positions found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM Seniorities

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Seniority id
URN	String	Standardized Seniority URN
Name	String	Seniority name in various locales. Represented as MultiLocaleString type.

Skills

Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Skills view returns a list of the job skills found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM Skills

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	skill id
Name	String	skill name in various locales. Represented as MultiLocaleString type.

SocialActions

The socialActions API allows access to both personal and organization social actions.

Select

UGCPostId supports the '=, IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM SocialActions WHERE UGCPostId = 'urn:li:share:12345'

SELECT * FROM SocialActions WHERE UGCPostId IN ('urn:li:share:12345','urn:li:share:23456')

Columns


Name	Type	Description
TotalFirstLevelComments	Integer	Total number of first level comments.
AggregatedTotalComments	Integer	Total number of aggregated comments.
LikedByCurrentUser	Boolean	Indicator if the post is liked by current user.
TotalLikes	Integer	Total number of likes.
Target	String	Total number of likes.
UGCPostId	String	Id of UGC Post.

ThirdPartyTracking

Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.

Table Specific Information

Select

The Forms view returns a list of the Third-party tracking tags through the ad creative they're associated with. The following request takes in an ad creative URN in the creative parameter to search for third-party tracking tags linked to that ad creative.

SELECT * FROM ThirdPartyTracking



SELECT * FROM ThirdPartyTracking WHERE Creative='123456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	The campaign to which this recommendation belongs.
Creative	String	The campaign to which this recommendation belongs.
Account	String	The average spend of the entity.
Event	String	The currency code of the average spend.
Platform	String	A prediction of how much additional impressions could be generated from a different bid.
TrackingUrl	String	The currency code of additional impressions.
Created	Timestamp	A prediction of how much additional impressions could be generated from a different bid.
LastModified	Timestamp	Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.

Titles

Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Titles view returns a list of the job titles found accross LinkedIn so they can be used as dimensions in analytic requests.

SELECT * FROM Titles

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.

Columns


Name	Type	Description
Id	String	Titles id
URN	String	Standardized Titles URN
Name	String	Titles name in various locales. Represented as MultiLocaleString type.

Matillion ETL Data Model for LinkedIn AdsVersion - 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 ETL Data Model for LinkedIn Ads
Version - 22.0.8389.0