Matillion Data Model for Twitter Ads
Version - 22.0.8322.0

Note: If you're using Matillion ETL, we advise you update to the latest version to ensure that your instance is reflective of the information displayed in the data model. This note does not apply to the Data Productivity Cloud.



Connection String OptionsBack To Top

  1. AccountId
  2. AdsAPIVersion
  3. UseAppOnlyAuthentication
  4. InitiateOAuth
  5. OAuthClientId
  6. OAuthClientSecret
  7. OAuthAccessToken
  8. OAuthAccessTokenSecret
  9. OAuthSettingsLocation
  10. CallbackURL
  11. OAuthVerifier
  12. AuthToken
  13. AuthKey
  14. OAuthExpiresIn
  15. OAuthTokenTimestamp
  16. SSLServerCert
  17. FirewallType
  18. FirewallServer
  19. FirewallPort
  20. FirewallUser
  21. FirewallPassword
  22. ProxyAutoDetect
  23. ProxyServer
  24. ProxyPort
  25. ProxyAuthScheme
  26. ProxyUser
  27. ProxyPassword
  28. ProxySSLType
  29. ProxyExceptions
  30. Logfile
  31. Verbosity
  32. LogModules
  33. MaxLogFileSize
  34. MaxLogFileCount
  35. Location
  36. BrowsableSchemas
  37. Tables
  38. Views
  39. AutoCache
  40. CacheDriver
  41. CacheConnection
  42. CacheLocation
  43. CacheTolerance
  44. Offline
  45. CacheMetadata
  46. BatchSize
  47. ConnectionLifeTime
  48. ConnectOnOpen
  49. IsPremiumTwitter
  50. MaxRateLimitDelay
  51. MaxRows
  52. Other
  53. PoolIdleTimeout
  54. PoolMaxSize
  55. PoolMinSize
  56. PoolWaitTime
  57. PseudoColumns
  58. RTK
  59. SearchTerms
  60. StreamPageSize
  61. StreamReadDuration
  62. StreamTimeout
  63. Timeout
  64. UseAsyncAPI
  65. UseConnectionPooling
  66. UserDefinedViews

AccountId

Data Type

string

Default Value

""

Remarks

Identifier of the advertising account. This Id is used to get analytic stats for the account that is identified by this Id. The AddAccounts view can be used to list available accounts with their specific Ids.



AdsAPIVersion

Data Type

string

Default Value

"11"

Remarks

The current version of Twitter API.



UseAppOnlyAuthentication

Data Type

bool

Default Value

false

Remarks

Set this to true to have your Twitter app log in to Twitter instead of a user.



InitiateOAuth

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.



OAuthClientId

Data Type

string

Default Value

""

Remarks

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



OAuthClientSecret

Data Type

string

Default Value

""

Remarks

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



OAuthAccessToken

Data Type

string

Default Value

""

Remarks

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

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



OAuthAccessTokenSecret

Data Type

string

Default Value

""

Remarks

The OAuthAccessTokenSecret property is used to connect and authenticate using OAuth. The OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.



OAuthSettingsLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\TwitterAds 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\\TwitterAds 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.



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.



AuthToken

Data Type

string

Default Value

""

Remarks

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.



AuthKey

Data Type

string

Default Value

""

Remarks

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.



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 Twitter Ads 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

0

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:

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

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.



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:

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:

AUTODefault 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.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe 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\\TwitterAds 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\\TwitterAds 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`.

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.



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. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data.

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:

See Also



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:twitterads: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:twitterads:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;
SQLite

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

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

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

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

  
SQL Server

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

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

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

jdbc:twitterads:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

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



CacheConnection

Data Type

string

Default Value

""

Remarks

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

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

Derby and Java DB

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

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

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

SQLite

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

jdbc:sqlite:dataSource

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:

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



CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\TwitterAds 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\\TwitterAds 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

See Also



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 Twitter Ads 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



BatchSize

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.



ConnectionLifeTime

Data Type

int

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.



ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to Twitter Ads 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 Twitter Ads 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).



IsPremiumTwitter

Data Type

bool

Default Value

false

Remarks

Specifies if is Twitter Premium account. This is false by default.



MaxRateLimitDelay

Data Type

string

Default Value

"60"

Remarks

Twitter uses different rate limits for total number of requests for different endpoints. These can range from as few as 15 per 15 minute window, up to 900 for a 15 minute window. Internally the CData JDBC Driver for Twitter Ads keeps track of if a given request would result in a rate limit exception. If a rate limit would occur, the CData JDBC Driver for Twitter Ads can internally delay submitting a request until the limit is up. However, this could also result in waiting for several minutes before requesting data, which is also not a good behavior.

The MaxRateLimitDelay gives control over the maximum amount of time the CData JDBC Driver for Twitter Ads will wait once it detects a rate limit would occur. Since the amount of time the CData JDBC Driver for Twitter Ads needs to wait can be calculated, if it would have to wait longer than the MaxRateLimitDelay, it will simply error immediately when it sees the time would take too long.



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=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting

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



PoolIdleTimeout

Data Type

int

Default Value

60

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

1

Remarks

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



PoolWaitTime

Data Type

int

Default Value

60

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.



SearchTerms

Data Type

string

Default Value

""

Remarks

Default SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified.



StreamPageSize

Data Type

string

Default Value

"50"

Remarks

The number of results to return per page of data retrieved from the Twitter stream.



StreamReadDuration

Data Type

int

Default Value

0

Remarks

Set StreamReadDuration property to consume streaming data for a specific time period. When StreamReadDuration is reached and StreamTimeout is 0, then the connection will be closed.



StreamTimeout

Data Type

string

Default Value

"0"

Remarks

Set the value of StreamTimeout to 0 in order to keep the connection open indefinitely. Note that, if the value of this property is greater than zero, the value of the StreamPageSize property, will be overwriten and will be set to one(1).



Timeout

Data Type

int

Default Value

60

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.



UseAsyncAPI

Data Type

bool

Default Value

false

Remarks

AdStats is the only table impacted.

Note that when you use the Async API, the Twitter Ads driver polls for a response. How long it waits before timing out is governed by the Timeout connection property. The default is timeout value is 60 seconds, so if you receive a timeout error, increase the value.



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:

For example:

{

	"MyView": {

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

	},

	"MyView2": {

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

	}

}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"





TablesBack To Top

  1. AdAudiencePermissions
  2. AdAudiences

AdAudiencePermissions

Retrieve details for some or all permissions associated with the specified tailored audience.

Columns

Name Type ReadOnly Description
Id [KEY] String True

The unique identifier of the ad audience permission.

AudienceId [KEY] String False

The unique identifier of the ad custom audience.

AccountId String False

Id of the advertising account to work with.

GrantedAccountId String False

The unique identifier of the ad account who has been granted this permission.

CreatedAt Datetime True

The time of the creation of this audience permission.

Deleted Boolean True

Whether the audience permission is deleted.

PermissionLevel String False

The level of the audience permission.

UpdatedAt Datetime True

The time of the last change of the properties of this audience permission.

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
IncludeDeleted String

Boolean used for including or not the deleted accounts.

The default value is false.



AdAudiences

Retrieve details for some or all Tailored Audiences associated with the current account.

View Specific Information
Select

Only the Id filter is supported.

SELECT * FROM AdAudiences WHERE Id = 'TXR1'



Columns

Name Type ReadOnly Description
Id [KEY] String True

The unique identifier of the ad tailored audience.

AccountId String False

Id of the advertising account to work with.

OwnerAccountId String True

The unique identifier of the owner account.

Name String False

The name of the tailored audience.

AudienceSize Integer True

The size of the tailored audience.

AudienceType String True

The type of the tailored audience.

CreatedAt Datetime True

The time of the creation of this audience.

UpdatedAt Datetime True

The time of the last change of the properties of this audience.

PartnerSource String True

The partner source of this tailored audience.

PermissionLevel String True

The permission level of this tailored audience.

ReasonsNotTargetable String True

The reasons why this audience is not targetable, if it is not targetable.

TargetableTypes String True

Targetable types of the audience.

Targetable Boolean True

Shows if the audience is targetable or not.

Deleted Boolean True

Whether the audience is deleted.

Segments String True

Useful only in Batch Insert, Update and Delete operations.

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
IncludeDeleted String

Boolean used for including or not the deleted accounts.

The default value is false.





ViewsBack To Top

  1. AdAccounts
  2. AdActiveEntities
  3. AdCampaignAudienceReach
  4. AdCampaigns
  5. AdCards
  6. AdFundingInstruments
  7. AdFundingInstrumentsAudienceReach
  8. AdLineItems
  9. AdPromotedTweets
  10. AdStats
  11. AdTweets

AdAccounts

Retrieve all of the advertising-enabled accounts the authenticating user has access to.

View Specific Information
Select

There are no available filters for this view.

Columns

Name Type Description
Id [KEY] String The unique identifier of the ad account.
Name String The name of the account.
ApprovalStatus String Indicates if this account is eligible for promoting. One of the following values: ACCEPTED, UNDER_REVIEW, or REJECTED.
CreatedAt Datetime The time when the account was created.
UpdatedAt Datetime The time of the last change of the properties of this account.
Timezone String Time zone selected on account setup. Each campaign will run in this timezone.
TimezoneSwitchAt Datetime The time of the last timezone switch.
Deleted Boolean Whether the account is deleted.
Salt String Random string used to uniquely identify an account.

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.



AdActiveEntities

Retrieve details about which entities' analytics metrics have changed in a given time period.

Columns

Name Type Description
EntityID String The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.
AccountId String Id of the advertising account to work with.
ActivityStartTime Datetime Start time of the activity
ActivityEndTime Datetime The end time of the activity
Placements String

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
Entity String The entity type to retrieve data for.
StartTime Datetime Scopes the retrieved data to the specified start time, expressed in ISO 8601.
EndTime Datetime Scopes the retrieved data to the specified end time, expressed in ISO 8601.
CampaignIds String Scope the response to just entities associated with desired campaigns by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.
FundingInstrumentIds String Scope the response to just entities associated with desired funding instruments by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.



AdCampaignAudienceReach

Retrieve reach and average frequency analytics for specified campaigns.

Columns

Name Type Description
AccountId String The unique identifier of the ad account.
CampaignIds [KEY] String
TotalAudienceReach String
AverageFrequency String
StartTime Datetime Scopes the retrieved data to the specified start time, expressed in ISO 8601.
EndTime Datetime Scopes the retrieved data to the specified end time, expressed in ISO 8601.



AdCampaigns

Retrieve details for some or all campaigns associated with the current account.

View Specific Information
Select

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

Name Type Description
Id [KEY] String The unique identifier of the campaign. Used to identify a specific campaign.
AccountId String Id of the advertising account to work with.
Name String The name of the campaign.
CreatedAt Datetime The time when campaign was created.
UpdatedAt Datetime The time of the last change of the properties of this campaign.
EntityStatus String The status for this entity: ACTIVE, DRAFT, and PAUSED.
TotalBudget Long The total budget the user has set for this campaign.
DailyBudget Long Daily budget limit to spend on this campaign.
Currency String Default currency.
FundingInstrumentId String The Id which identifies the funding instrument used to get the budget for this campaign.
StandardDelivery String If true, this field specifies an even spend rate throughout the day. Otherwise impressions will be served and engagements will be generated as quickly as possible until your daily budget is exhausted, which may be quite early on in the day, depending on targeting and competition. This is called accelerated delivery.
Deleted Boolean Indicates if this campaign is deleted and not serving anymore.
BudgetOptimization String Indicates the type of budget optimization being applied

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.



AdCards

Retrieve details for some or all cards associated with the current account.

Columns

Name Type Description
id [KEY] String The id identifier for a card.
AccountId String Id of the advertising account to work with.
Name String The name for the card. Maximum length: 80 characters.
CreatedAt Datetime The date the card was created.
UpdatedAt Datetime The date the card was last updated.
Deleted Boolean Whether the card is deleted or not
CardType String The type of the card.
ComponentType String The type of the component.
MediaKeys String Media Keys
LabelType String Labels define the text shown on buttons
LabelValue String The value of the label
DestinationType String The destination type, which determines its schema.
DestinationURL String The URL of the website to redirect a user to.
DestinationCountryCode String The ISO 3166-1 alpha-2 two-letter code for the country where the app is sold.
DestinationGooglePlayAppId String The Google Play application package name.
DestinationIOSAppStoreId String The iOS app store identifier.
DestinationGooglePlayDeepLink String A deep link into the Android app you're promoting.
DestinationIOSDeepLink String A deep link into the iOS app you're promoting.

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.



AdFundingInstruments

Retrieve some or all funding instruments associated with the account specified in the path.

View Specific Information
Select

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

Name Type Description
Id [KEY] String Identifier for a funding instrument.
AccountId String Id of the advertising account to work with.
Type String A funding instrument can be one of the following types: Credit Cards, Credit Lines, Multi-Handle Credit Lines.
Description String Exdended info for the funding instrument.
CreatedAt Datetime The time when this record was created.
UpdatedAt Datetime The time of the last charge related to the properties of this item.
CreditLimit Long The credit limit in local micro.
FundedAmount Long The funded amount in local micro.
CreditRemaining Long The credit remaining in local micro.
Currency String Default currency.
StartTime Datetime The time when this instrument became available to use.
EndTime Datetime The time when this instrument stoped being available to use.
Cancelled Boolean Indicates if an instrument is canceled.
Deleted Boolean Indicates if this item is deleted and cannot be used anymore.

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.



AdFundingInstrumentsAudienceReach

Retrieve reach and average frequency analytics for specified funding instruments.

Columns

Name Type Description
AccountId String Id of the advertising account to work with.
FundingInstrumentIds [KEY] String The unique identifier of the ad account.
TotalAudienceReach String
AverageFrequency String
StartTime Datetime Scopes the retrieved data to the specified start time, expressed in ISO 8601.
EndTime Datetime Scopes the retrieved data to the specified end time, expressed in ISO 8601.



AdLineItems

Retrieve some or all funding instruments associated with the account specified.

View Specific Information
Select

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

Name Type Description
Id [KEY] String The unique line item Id. Used to identify a specific line item.
AccountId String The identifier for the leveraged account.
CampaignId String The Id of the campaign to work with.
Name String A name assigned to the line item. If left blank, the name will default to Untitled.
TotalBudget Long An number representing the bid amount associated with this line item. The currency associated with the specified funding instrument will be used. For USD, $1.50 is encoded as 1.50*1e6, or 1,500,000.
BidType String The bidding mechanism.
AutomaticallySelectBid Boolean [DEPRECATED] This boolean parameter, when set to true, will automatically optimize bidding based on daily budget and campaign flight dates.
ProductType String The type of promoted product that this line item will contain.
Placements String The comma-separated list of placement locations for this line item to display in.
Objective String The campaign objective for this line item.
EntityStatus String The status for this entity: ACTIVE, DRAFT, and PAUSED.
IncludeSentiment String Whether this line item is targeted to tweets with both positive or negative sentiment. A tweet is said to have positive or negative sentiment if the tone of the tweet is positive. This is only valid for the ProductType of PROMOTED_TWEETS and with either placements of ALL_ON_TWITTER or TWITTER_TIMELINES. Possible values: POSITIVE_ONLY (default) targets only tweets with positive sentiment; ALL targets all tweets, including those with negative sentiment.
TotalBudgetAmountLocalMicro Long An number representing the total budget amount to be allocated to the line item. The currency associated with the specified funding instrument and campaign will be used. For USD, $37.50 is encoded as 37.50*1e6, or 37,500,000.
StartTime Datetime The UTC time that the line item will begin serving. Must be more recent than the current time.
EndTime Datetime The UTC time that the line item will stop serving. If specified, must be more recent than the StartTime of the line item.
PrimaryWebEventTag String The identifier of the primary Web event tag. Allows more accurate tracking of engagements for the campaign pertaining to this line item.
ChargeBy String This field is returned for line items using the APP_INSTALLS objective. Defaults to charging by bid unit except for line items with bid unit APP_INSTALLS, where it defaults to charging by app clicks.
AdvertiserDomain String The website domain for this advertiser, without protocol specification. This field is available for line items using the Twitter Audience Platform (TAP).
Categories String The relevant IAB categories for this advertiser. This setting is available for line items using the Twitter Audience Platform (TAP).
TargetCPALocalMicro Integer An integer representing the target CPA amount to be allocated to the line item. The currency associated with the specified funding instrument and campaign will be used. For USD, $5.50 is encoded as 5.50*1e6, or 5,500,000.
CreatedAt Datetime The time when the campaign was created.
UpdatedAt Datetime The time of the last change of the properties of this campaign.
Goal String The optimization setting used with this line item.

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.



AdPromotedTweets

Retrieve all of the advertising-enabled Tweets the authenticating user has access to.

View Specific Information
Select

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

Name Type Description
Id [KEY] String The identifier corresponding to the specific promotion.
TweetId String The Id of the status update or tweet that is promoted.
LineItemId String The Id of the line item this tweet is part of.
AccountId String The Id of the advertising account to work with.
CreatedAt Datetime The time when the tweet was promoted.
UpdatedAt Datetime The time when the tweet was updated.
Deleted Boolean A boolean indicating if this item is deleted.
EntityStatus String The status for this entity: ACTIVE, DRAFT, and PAUSED.
ApprovalStatus String Indicates if this promotion is approved.

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.



AdStats

Query information about all available metrics for a certain entity.

View Specific Information

AdStats contain all available analytic metrics for all types of entities. When querying this view only the metrics supported by the specified entity will be populated with values.

Support for Twitter Ads Asynchronous API
This view supports the Twitter Ad Async API. Setting the UseAsyncAPI property to TRUE enables the API. The default is FALSE.
Select

Below are the fields that can be specified to filter the results.

AccountId This is a common required filter for all views related to Twitter analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.
StartTime and EndTime Used to specify the time window. It should not exceed the interval of 7 days. If a window is not specified, the stats for the last seven days will be returned.
SELECT * FROM AdStats WHERE StartTime = '12/02/2016' AND EndTime = '12/09/2016'
Entity and EntityId There are 5 entity types:
  • ACCOUNT
  • FUNDING_INSTRUMENT
  • CAMPAIGN
  • LINE_ITEM
  • PROMOTED_TWEET
  • ORGANIC_TWEET

Each entity has its own view that can be used to list available items and get their respective Id. By default, if none of those filters are specified, the driver tries to get stats for the account whose Id is specified in the AccountId connection property.

Note: When the Entity field is set to "ORGANIC_TWEET", the EntityId must be set in the WHERE clause.

SELECT * FROM AdStats WHERE EntityId = '807000624822882304' AND Entity = 'ORGANIC_TWEET'

GranularityThis value determines how granular the data points will be returned. Available values for granularity are TOTAL, DAY, and HOUR. If set to a value other than TOTAL, the stats will be returned broken down for each unit of the interval specified by StartTime and EndTime. For instance if set to DAY, there will be returned stats for each day of the specified interval. By default this is set to DAY.
SELECT * FROM AdStats WHERE Granularity = 'HOUR'
Placement Used to return preaggregated metrics for all placements across Twitter or on the Twitter Audience Platform. Available values are ALL_ON_TWITTER and PUBLISHER_NETWORK. Do note that placement takes in a single value, so separate queries are required to fetch analytics data for placement on Twitter and placement on the Twitter Audience Platform. By default this is set to ALL_ON_TWITTER.
SELECT * FROM AdStats WHERE Placement = 'PUBLISHER_NETWORK'

The listed filters are optional, but it is recommended to specify at least the Entity, EntityId, and the time window.

SELECT * FROM AdStats WHERE EntityId = '807000624822882304' AND Entity = 'ORGANIC_TWEET' AND StartTime = '12/02/2016' AND EndTime = '12/09/2016' 
Columns

Name Type Description
AccountId String The Id of the advertising account to work with.
Entity String The entity to query.
EntityId String The Id of the entity to query.
StartTime Date Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
EndTime Date Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
IntervalStartTime String Start time of the current interval. This applies only to Granularity DAY and HOUR.
IntervalEndTime String End time of the current interval. This applies only to Granularity DAY and HOUR.
Placement String The placement. Possible values: ALL_ON_TWITTER, PUBLISHER_NETWORK.

The allowed values are ALL_ON_TWITTER, PUBLISHER_NETWORK.

Granularity String Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.

The allowed values are TOTAL, DAY, HOUR.

Engagements Integer Total number of engagements.
Impressions Integer Total number of impressions.
Retweets Integer Total number of retweets.
Replies Integer Total number of replies.
Likes Integer Total number of likes.
Follows Integer Total number of follows.
CardEngagements Integer Total number of card engagements.
Clicks Integer Total number of clicks.
AppClicks Integer Number of app install or app open attempts.
UrlClicks Integer Number of clicks on linked URLs.
QualifiedImpressions Integer Total number of qualified impressions.
BilledEngagements Integer Total number of billed engagements.
BilledCharge Long Total spent in micros.
VideoTotalViews Integer Total number of video views.
VideoViews25 Integer Total number of views where at least 25% of the video was viewed.
VideoViews50 Integer Total number of views where at least 50% of the video was viewed.
VideoViews75 Integer Total number of views where at least 75% of the video was viewed.
VideoViews100 Integer Total number of views where 100% of the video was viewed.
VideoCTAClicks Integer Total clicks on the call to action.
VideoContentStarts Integer Total number of video playback starts.
VideoMrcViews Integer Total number of views according to Media Rating Council guidelines.
Video3s100pctViews Integer Total number of views where at least 3 seconds were played while 100% in view.
MediaViews Integer Total number of views (autoplay and click) of media across videos, vines, GIFs, and images.
MediaEngagements Integer Total number of clicks of media across videos, vines, GIFs, and images.
Purchases Integer Number of conversions of type PURCHASE.
SignUps Integer Number of conversions of type SIGN_UP.
SiteVisits Integer Number of conversions of type SITE_VISIT.
Downloads Integer Number of conversions of type DOWNLOAD.
ConversionCustom Integer Number of conversions of type CUSTOM.
MobileConversionSpentCredits Integer Breakdown of mobile conversions of type SPENT_CREDIT by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionInstalls Integer Breakdown of mobile conversions of type INSTALL by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionContentViews Integer Breakdown of mobile conversions of type CONTENT_VIEW by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionAddToWishlists Integer Breakdown of mobile conversions of type ADD_TO_WISHLIST by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionCheckoutsInitiated Integer Breakdown of mobile conversions of type CHECKOUT_INITIATED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionReservations Integer Breakdown of mobile conversions of type RESERVATION by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionTutorialsCompleted Integer Breakdown of mobile conversions of type TUTORIAL_COMPLETED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionAchievementsUnlocked Integer Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionSearches Integer Breakdown of mobile conversions of type SEARCH by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionAddToCarts Integer Breakdown of mobile conversions of type ADD_TO_CART by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionPaymentInfoAdditions Integer Breakdown of mobile conversions of type PAYMENT_INFO_ADDITION by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionReEngages Integer Breakdown of mobile conversions of type RE_ENGAGE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionShares Integer Breakdown of mobile conversions of type SHARE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionRates Integer Breakdown of mobile conversions of type RATE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionLogins Integer Breakdown of mobile conversions of type LOGIN by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionUpdates Integer Breakdown of mobile conversions of type UPDATE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionLevelsAchieved Integer Breakdown of mobile conversions of type LEVEL_ACHIEVED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionInvites Integer Breakdown of mobile conversions of type INVITE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionKeyPageViews Integer Breakdown of mobile conversions of type KEY_PAGE_VIEW by post view and post engagement.
LifetimeValuePurchases Integer Breakdown of mobile conversions of type PURCHASE.
LifetimeValueSignUps Integer Breakdown of mobile conversions of type SIGN_UP.
LifetimeValueUpdates Integer Breakdown of mobile conversions of type UPDATE.
LifetimeValueTutorialsCompleted Integer Breakdown of mobile conversions of type TUTORIAL_COMPLETED.
LifetimeValueReservations Integer Breakdown of mobile conversions of type RESERVATION.
LifetimeValueAddToCarts Integer Breakdown of mobile conversions of type ADD_TO_CART.
LifetimeValueAddToWishlists Integer Breakdown of mobile conversions of type ADD_TO_WISHLIST.
LifetimeValueCheckoutsInitiated Integer Breakdown of mobile conversions of type CHECKOUT_INITIATED.
LifetimeValueLevelsAchieved Integer Breakdown of mobile conversions of type LEVEL_ACHIEVED.
LifetimeValueAchievementsUnlocked Integer Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED.
LifetimeValueShares Integer Breakdown of mobile conversions of type SHARE.
LifetimeValueInvites Integer Breakdown of mobile conversions of type INVITE.
LifetimeValuePaymentInfoAdditions Integer Breakdown of mobile conversions of type PAYMENT_INFO_ADDITION.
LifetimeValueSpentCredits Integer Breakdown of mobile conversions of type SPENT_CREDIT.
LifetimeValueRates Integer Breakdown of mobile conversions of type RATE.



AdTweets

Retrieve all of the advertising-enabled Tweets the authenticating user has access to.

Columns

Name Type Description
ID [KEY] String The Id of the status update or tweet. Set this value when inserting to retweet an existing tweet.
IDLong String The long type Id of the status update or tweet.
SearchTerms String The SearchTerms to search against. This cannot be used with the Screen_Name or User_Id inputs. For more information on using the advanced query operators, see the Twitter API documentation here: https://dev.twitter.com/docs/using-search. Roughly 1500 results can be returned using the SearchTerms.
Created_At Datetime When the tweet was made.
Text String The text of the tweet.
Lang String Language code the tweet was made in.
Source String Source of the tweet.
Favorited Boolean Boolean indicating if this tweet has been favorited.
Favorite_Count Integer The approximate number of times this tweet has been favorited.
Retweeted Boolean Boolean indicating if this tweet has been retweeted.
Retweet_Count Integer The number of times the tweet has been retweeted.
Retweeted_Status_Id String Id of the tweet which was retweeted by this one. Empty if the current tweet is not a retweet.
Truncated Boolean Boolean indicating if this tweet has been truncated.
Filter_Level String Indicates the maximum value of the Filter_Level parameter that can be used and still stream this tweet.
Possibly_Sensitive String This field is available only when a tweet contains a link. The meaning of the field does not pertain to the tweet content itself, but instead it is an indicator that the URL contained in the tweet may contain content or media identified as sensitive content.
Withheld_Copyright Boolean When present and set to true, indicates that this piece of content has been withheld due to a DMCA complaint.
Withheld_Scope String When present, indicates whether the content being withheld is the status or a user.
Withheld_In_Countries String A list of uppercase, two-letter country codes this content is withheld from.
Contributors String An XML collection of user objects (usually only one) indicating users who contributed to the authorship of the tweet, on behalf of the official tweet author.
Coordinates_Coordinates String The geographic coordinates of this tweet (longitude first, then latitude).
Coordinates_Type String The type of coordinate, if applicable.
Place_Full_Name String The full name of the location of this tweet (city and state).
Place_Country String The country of origin of this tweet.
Current_User_Retweet_Id String Details the tweet Id of the authenticated user's own retweet (if it exists) of this tweet.
Scopes String A set of key-value pairs indicating the intended contextual delivery of the containing tweet. Currently used by Twitter's promoted products.
In_Reply_To_Status_Id String Represents the Id of the original status if this tweet is in reply to another.
From_User_Id String Id of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
From_User_Screen_Name String Screen name of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
From_User_Name String Name of the user who made the tweet.
From_User_Location String Location of the user who made the tweet.
From_User_Profile_URL String URL to the user who made the tweet. This is not returned when a SearchTerms is specified.
From_User_Profile_Image_Url String URL to the profile image for the from user.
To_User_Id String Id of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
To_User_Screen_Name String Screen name of the user who made the tweet.
User_Mentions String Mentions of other users in the tweet, returned as an XML aggregate.
URLs String URLs in the tweet, returned as an XML aggregate.
Hashtags String Hashtags in the tweet, returned as an XML aggregate.
Media String Media in the tweet, returned as an XML aggregate.
Name String The name of the Tweet, also known as the Ad name in the Twitter Ads UI. This field might be returned as null if no input name is provided when creating tweets using the Tweet composer. The name that is displayed in the UI for these cases is the Card name.

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
TimelineType String Whether to return nullcasted (a.k.a. 'Promoted-only') Tweets, organic Tweets, or both. Possible values: ALL, NULLCAST, ORGANIC
TweetType String The Tweet type of the tweets. Possible values: DRAFT, PUBLISHED, SCHEDULED