Adding a Connection to Twitter Ads

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Twitter Ads icon is not available, click the Add More icon to download and install the Twitter Ads connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Twitter Ads

Synch Connections

To connect, set the following variables:

• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Click Connect to Twitter Ads to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

• Extracts the access token from the callback URL.
• Obtains a new access token when the old one expires.
• Saves OAuth values so that they persist across connections.

This section details a selection of advanced features of the Twitter Ads Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

For further information, see Query Processing.

Logging

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models Twitter Ads entities in relational Tables, Views, and Stored Procedures.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

The Sync App models the data in Twitter Ads as a list of tables in a relational database that can be queried using standard SQL statements.

Twitter Ads Connector for CData Sync Tables

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

Columns

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.

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'

Insert

This table supports simple Insert and batch Insert operations.

Simple Insert:

INSERT INTO [AdAudiences] (name) VALUES ('test')

Batch Insert:

Batch inserts are used to generate a new audience based on existing audiences and by setting a couple of conditions on them.

For example: To create a new audience based on the most active users of X1 AND (X2 or X3) audience the structure would be like this:

INSERT INTO a#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYIF', 1, 'NUM_GT', 30, true)

INSERT INTO b#TEMP (CustomAudienceId, lookbackWindow) VALUES ('TXR1', 30)

INSERT INTO c#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYFO', 1, 'NUM_GT', 30, true)

INSERT INTO AdAudiences#TEMP (audienceType, name, segments) VALUES ('FLEXIBLE', 'Test1', 'a#TEMP AND (b#TEMP OR c#TEMP)')

INSERT INTO [AdAudiences] (audienceType, name, segments) SELECT audienceType, name, segments FROM [AdAudiences#TEMP]

Make sure to set the required columns on initial temp tables, for example a#TEMP, which are: CustomAudienceId and LookbackWindow.

Values that are set in these temp table will be used by AdAudiences#TEMP in the Segments column, which will be used as a criteria, combined with AND/OR logical operators.

Update

Simple Update:

UPDATE [AdAudiences] SET Name = 'testModified' WHERE Name = 'test'

Batch Update:

Batch updates are used to modify an existing audience by setting a couple of new conditions on it.

For example: To modify an audience based on the most active users of X1 AND (X2 or X3) audience the structure would be like this:

INSERT INTO a#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYIF', 1, 'NUM_GT', 30, true)

INSERT INTO b#TEMP (CustomAudienceId, lookbackWindow) VALUES ('TXR1', 30)

INSERT INTO c#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYFO', 1, 'NUM_GT', 30, true)

INSERT INTO AdAudiences#TEMP (audienceType, name, segments) VALUES ('FLEXIBLE', 'Test1', 'a#TEMP AND (b#TEMP OR c#TEMP)')

UPDATE [AdAudiences] (audienceType, name, segments) SELECT audienceType, name, segments FROM [AdAudiences#TEMP]

Delete

Simple Delete:

DELETE FROM [AdAudiences] WHERE Name = 'test'

Batch Delete:

INSERT INTO a#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYIF', 1, 'NUM_GT', 30, true)

INSERT INTO b#TEMP (CustomAudienceId, lookbackWindow) VALUES ('TXR1', 30)

INSERT INTO c#TEMP (CustomAudienceId, frequency, frequencyComparator, lookbackWindow, negate) VALUES ('TYFO', 1, 'NUM_GT', 30, true)

INSERT INTO AdAudiences#TEMP (audienceType, name, segments) VALUES ('FLEXIBLE', 'Test1', 'a#TEMP AND (b#TEMP OR c#TEMP)')

DELETE FROM [AdAudiences] WHERE EXISTS SELECT audienceType, name, segments FROM [AdAudiences#TEMP]

Columns

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.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Twitter Ads Connector for CData Sync Views

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

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.

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

Columns

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.

Retrieve reach and average frequency analytics for specified campaigns.

Columns

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 Sync App will try to get the first account from the list returned by the AdAccount view.

Columns

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.

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

Columns

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.

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 Sync App will try to get the first account from the list returned by the AdAccount view.

Columns

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.

Retrieve reach and average frequency analytics for specified funding instruments.

Columns

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 Sync App will try to get the first account from the list returned by the AdAccount view.

Columns

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.

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 Sync App will try to get the first account from the list returned by the AdAccount view.

Columns

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.

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

Select

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

SELECT * FROM AdStats WHERE StartTime = '12/02/2016' AND EndTime = '12/09/2016'

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

SELECT * FROM AdStats WHERE Granularity = 'HOUR'

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

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

View Specific Information

Select

The AccountId field is filterable server-side.

SELECT * FROM AdTweets WHERE AccountId = '1234'

SELECT * FROM AdTweets WHERE AccountId IN (SELECT Id FROM AdAccounts)

Columns

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.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

Authentication

OAuth

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

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

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.

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.

The current version of Twitter API.

Remarks

The current version of Twitter API.

A boolean that indicates whether or not you would like to use app-only authentication.

Remarks

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

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

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

The authentication token used to request and obtain the OAuth Access Token.

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.

The authentication key used to request and obtain the OAuth Access Token.

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.

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

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

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:

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

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

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

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

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

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

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

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:

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

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

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

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

Remarks

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

The maximum amount of time to delay (in seconds) before submitting a request if it would be rate limited.

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 Sync App keeps track of if a given request would result in a rate limit exception. If a rate limit would occur, the CData Sync App 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 Sync App will wait once it detects a rate limit would occur. Since the amount of time the CData Sync App 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.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

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

Remarks

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

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

Remarks

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

This property represents the maximum time to read streaming data, in seconds.

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.

The maximum number of seconds to continue waiting for results while streaming. When this value is reached and no tweets are returned, then the connection will be closed.

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

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

This field sets whether the Twitter Ads Asynchronous API is enabled.

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.

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
	"MyView": {
		"query": "SELECT * FROM AdAudiences WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.