Twitter Ads Connector for CData Sync

Build 25.0.9539
  • Twitter Ads
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • AdAudiencePermissions
        • AdAudiences
      • Views
        • AdAccounts
        • AdActiveEntities
        • AdCampaignAudienceReach
        • AdCampaigns
        • AdCards
        • AdFundingInstruments
        • AdFundingInstrumentsAudienceReach
        • AdLineItems
        • AdPromotedTweets
        • AdStats
        • AdTweets
      • Stored Procedures
        • GetOAuthAccessToken
        • GetOAuthAuthorizationURL
        • ManageAudienceUsers
    • Connection String Options
      • Authentication
        • AccountId
        • AdsAPIVersion
        • UseAppOnlyAuthentication
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • AuthToken
        • AuthKey
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • IsPremiumTwitter
        • MaxRateLimitDelay
        • MaxRows
        • Other
        • PseudoColumns
        • SearchTerms
        • StreamPageSize
        • StreamReadDuration
        • StreamTimeout
        • Timeout
        • UseAsyncAPI
        • UserDefinedViews
    • Third Party Copyrights

Twitter Ads Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Twitter Ads data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Twitter Ads connector can be used from the CData Sync application to pull data from Twitter Ads and move it to any of the supported destinations.

Twitter Ads Version Support

The Sync App models the behavior of version 7 of the Twitter Ads API as views. A developer account is required to connect to Twitter Ads APIs.

Twitter Ads Connector for CData Sync

Establishing a Connection

Adding a Connection to Twitter Ads

To add 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

Twitter Ads supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application. See Creating a Custom OAuth Application for more information about creating custom applications.

Synch Connections

Before you connect, you need to obtain a Client Id and Client Secret by creating a custom OAuth application.

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.

Twitter Ads Connector for CData Sync

Advanced Features

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

The Sync App offloads as much of the SELECT statement processing as possible to Twitter Ads and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Twitter Ads Connector for CData Sync

SSL Configuration

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.

Twitter Ads Connector for CData Sync

Firewall and Proxy

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.

Twitter Ads Connector for CData Sync

Data Model

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

The Sync App uses the Twitter Ads API to process supported filters. The Sync App processes other filters client-side within the Sync App.

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.

Twitter Ads Connector for CData Sync

Tables

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

Name Description
AdAudiencePermissions Retrieve details for some or all permissions associated with the specified tailored audience.
AdAudiences Retrieve details for some or all Tailored Audiences associated with the current account.

Twitter Ads Connector for CData Sync

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.

Twitter Ads Connector for CData Sync

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'

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

This table supports simple and batch Update operations.

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

This table supports simple and batch Delete operations.

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

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.

Twitter Ads Connector for CData Sync

Views

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

Name Description
AdAccounts Retrieve all of the advertising-enabled accounts the authenticating user has access to.
AdActiveEntities Retrieve details about which entities' analytics metrics have changed in a given time period.
AdCampaignAudienceReach Retrieve reach and average frequency analytics for specified campaigns.
AdCampaigns Retrieve details for some or all campaigns associated with the current account.
AdCards Retrieve details for some or all cards associated with the current account.
AdFundingInstruments Retrieve some or all funding instruments associated with the account specified in the path.
AdFundingInstrumentsAudienceReach Retrieve reach and average frequency analytics for specified funding instruments.
AdLineItems Retrieve some or all funding instruments associated with the account specified.
AdPromotedTweets Retrieve all of the advertising-enabled Tweets the authenticating user has access to.
AdStats Query information about all available metrics for a certain entity.
AdTweets Retrieve all of the advertising-enabled Tweets the authenticating user has access to.

Twitter Ads Connector for CData Sync

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.

Twitter Ads Connector for CData Sync

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.

Twitter Ads Connector for CData Sync

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.

Twitter Ads Connector for CData Sync

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

Twitter Ads Connector for CData Sync

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.

Twitter Ads Connector for CData Sync

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

Twitter Ads Connector for CData Sync

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.

Twitter Ads Connector for CData Sync

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

Twitter Ads Connector for CData Sync

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

Twitter Ads Connector for CData Sync

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 Sync App 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 Sync App 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 Datetime Start time of the current interval. This applies only to Granularity DAY and HOUR.
IntervalEndTime Datetime 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.

Twitter Ads Connector for CData Sync

AdTweets

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

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.
AccountId String The Id of the advertising account this AdTweet is associated with.
Card_Uri String The identifier for a Twitter Card attached to this Tweet.

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

Twitter Ads Connector for CData Sync

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Twitter Ads.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Twitter Ads, along with an indication of whether the procedure succeeded or failed.

Twitter Ads Connector for CData Sync Stored Procedures

Name Description
ManageAudienceUsers Add, update and remove users from a given custom audience id.

Twitter Ads Connector for CData Sync

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with Twitter. If using a Windows application, set AuthMode to APP. If using a Web App, set AuthMode to WEB and specify the AuthToken, AuthKey, and Verifier returned by GetOAuthAuthorizationUrl.

Input

Name Type Description
AuthMode String Enter either APP or WEB. The type of authentication mode to use. Set to APP to get authentication tokens via a Windows app (.exe). Set to WEB to get authentication tokens via a Web app.

The default value is APP.

AuthToken String The authentication token returned by GetOAuthAuthorizationUrl. Required for only the Web AuthMode.
AuthKey String The AuthKey returned by GetOAuthAuthorizationUrl. Required for only the Web AuthMode.
Verifier String The verifier token returned by Twitter after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode.
State String Any value that you wish to be sent with the callback.

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth access token.
OAuthAccessTokenSecret String The OAuth access token secret.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.

Twitter Ads Connector for CData Sync

GetOAuthAuthorizationURL

Gets the authorization URL, AuthToken, and AuthKey from Twitter. Navigate to the authorization URL in an Internet browser. This will return a verifier token that you will need to use as input along with the AuthToken for the GetOAuthAccessToken stored procedure.

Input

Name Type Description
CallbackURL String The URL that Twitter will return to after the user has authorized your app.
State String Any value that you wish to be sent with the callback.

Result Set Columns

Name Type Description
URL String The URL to be entered into a Web browser to obtain the verifier token and authorize your Twitter app with.
AuthToken String A token used as input for the GetOAuthAccessToken stored procedure to verify the request and obtain the OAuth access token.
AuthKey String A key used as input for the GetOAuthAccessToken stored procedure to verify the request and obtain the OAuth access token.

Twitter Ads Connector for CData Sync

ManageAudienceUsers

Add, update and remove users from a given custom audience id.

Input

Name Type Description
AudienceId String The unique identifier of the ad custom audience.
OperationType String The per users group operation type being performed.

The allowed values are Update, Delete.

UserEmail String Email address(es) for the user.
UserDeviceID String The deviceId of the user: IDFA/AdID/Android ID.
UserHandle String The @handle(s) belonging to the user
UserTwitterID String The twitter id of the user.
PartnerId String The User ID of the partner.
EffectiveAt String The UTC time at which the custom audience association(s) should take effect.
ExpiresAt String The UTC time at which the custom audience association(s) should expire.
CSVFilePath String The location of the CSV file with batch data.

Result Set Columns

Name Type Description
AccountId String The place Id.
AudienceId String Name of the place.
Success String Returns true if the procedure is executed successfully.
UsersAffected String The number of users modified/deleted.
ErrorMessage String The error thrown from the API if the request is not successful. Otherwise this will return null.

Twitter Ads Connector for CData Sync

Connection String Options

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.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
AccountIdIdentifier 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.
AdsAPIVersionThe current version of Twitter API.
UseAppOnlyAuthenticationA boolean that indicates whether or not you would like to use app-only authentication.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication key used to request and obtain the OAuth Access Token.

SSL


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

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


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

Schema


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
IsPremiumTwitterSpecifies if is Twitter Premium account. This is false by default.
MaxRateLimitDelayThe maximum amount of time to delay (in seconds) before submitting a request if it would be rate limited.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SearchTermsDefault SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified.
StreamPageSizeThe number of results to return per page of data retrieved from the Twitter stream.
StreamReadDurationThis property represents the maximum time to read streaming data, in seconds.
StreamTimeoutThe 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.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseAsyncAPIThis field sets whether the Twitter Ads Asynchronous API is enabled.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Twitter Ads Connector for CData Sync

Authentication

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


PropertyDescription
AccountIdIdentifier 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.
AdsAPIVersionThe current version of Twitter API.
UseAppOnlyAuthenticationA boolean that indicates whether or not you would like to use app-only authentication.
Twitter Ads Connector for CData Sync

AccountId

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.

Twitter Ads Connector for CData Sync

AdsAPIVersion

The current version of Twitter API.

Remarks

The current version of Twitter API.

Twitter Ads Connector for CData Sync

UseAppOnlyAuthentication

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.

Twitter Ads Connector for CData Sync

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication key used to request and obtain the OAuth Access Token.
Twitter Ads Connector for CData Sync

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Twitter Ads Connector for CData Sync

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Twitter Ads Connector for CData Sync

AuthToken

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.

Twitter Ads Connector for CData Sync

AuthKey

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.

Twitter Ads Connector for CData Sync

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Twitter Ads Connector for CData Sync

SSLServerCert

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

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Twitter Ads Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Twitter Ads Connector for CData Sync

FirewallType

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.

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Twitter Ads. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Twitter Ads. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the Sync App sends data to Twitter Ads. If the SOCKS 5 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.

Twitter Ads Connector for CData Sync

FirewallServer

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.

Twitter Ads Connector for CData Sync

FirewallPort

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.

Twitter Ads Connector for CData Sync

FirewallUser

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.

Twitter Ads Connector for CData Sync

FirewallPassword

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.

Twitter Ads Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Twitter Ads Connector for CData Sync

ProxyAutoDetect

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. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

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

Twitter Ads Connector for CData Sync

ProxyServer

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

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 (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Twitter Ads Connector for CData Sync

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (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.

Twitter Ads Connector for CData Sync

ProxyAuthScheme

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

Remarks

Supported authentication types :

  • 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: Signifies that 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.

Twitter Ads Connector for CData Sync

ProxyUser

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

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The username of a user registered with the proxy server.
DIGEST The username of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

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

Twitter Ads Connector for CData Sync

ProxyPassword

Specifies the password of 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:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

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

Twitter Ads Connector for CData Sync

ProxySSLType

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

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Twitter Ads Connector for CData Sync

ProxyExceptions

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

Twitter Ads Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Twitter Ads Connector for CData Sync

LogModules

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

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name Module Description Submodules
INFO General Information. Includes the connection string, product version (build number), and initial connection messages.
  • Connec – Information related to creating or destroying connections.
  • Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.
  • Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance.
  • Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user).
  • Page – Messages related to query paging.
  • Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.
  • KERB – HTTP requests related to Kerberos.
  • Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product.
  • Res – Messages containing HTTP responses.
  • Req – Messages containing HTTP requests.
WSDL Messages pertaining to the generation of WSDL/XSD files. —
SSL SSL certificate messages.
  • Certif – Messages pertaining to SSL certificates.
AUTH Authentication related failure/success messages.
  • Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • OAuth – Messages related to OAuth authentication.
  • Krbros – Kerberos-related authentication messages.
SQL Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.
  • Bulk – Messages pertaining to bulk query execution.
  • Cache – Messages related to reading row data from and writing row data to the product's cache for better performance.
  • Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • ResSet – Query resultsets.
  • Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META Metadata cache and schema messages.
  • Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance.
  • Schema – Messages related to retrieving metadata from or modifying the service schema.
  • MemSto – Messages related to writing to or reading from in-memory metadata cache.
  • Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC Information related to executing SQL functions.
  • Errmsg – Error messages related to executing SQL functions.
TCP Incoming and outgoing raw bytes on TCP transport layer messages.
  • Send – Raw data sent via the TCP protocol.
  • Receiv – Raw data received via the TCP protocol.
FTP Messages pertaining to the File Transfer Protocol.
  • Info – Status messages related to communication in the FTP protocol.
  • Client – Messages related to actions taken by the FTP client (the product) during FTP communication.
  • Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP Messages pertaining to the Secure File Transfer Protocol.
  • Info – Status messages related to communication in the SFTP protocol.
  • To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication.
  • From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP Messages pertaining to data transferred via the Post Office Protocol.
  • Client – Messages related to actions taken by the POP client (the product) during POP communication.
  • Server – Messages related to actions taken by the POP server during POP communication.
  • Status – Status messages related to communication in the POP protocol.
SMTP Messages pertaining to data transferred via the Simple Mail Transfer Protocol.
  • Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication.
  • Server – Messages related to actions taken by the SMTP server during SMTP communication.
  • Status – Status messages related to communication in the SMTP protocol.
CORE Messages relating to various internal product operations not covered by other modules. —
DEMN Messages related to SQL remoting. —
CLJB Messages about bulk data uploads (cloud job).
  • Commit – Submissions for bulk data uploads.
SRCE Miscellaneous messages produced by the product that don't belong in any other module. —
TRANCE Advanced messages concerning low-level product operations. —

Twitter Ads Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Twitter Ads Connector for CData Sync

Location

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:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Twitter Ads Connector for CData Sync

BrowsableSchemas

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.

Twitter Ads Connector for CData Sync

Tables

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.

Twitter Ads Connector for CData Sync

Views

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.

Twitter Ads Connector for CData Sync

Miscellaneous

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


PropertyDescription
IsPremiumTwitterSpecifies if is Twitter Premium account. This is false by default.
MaxRateLimitDelayThe maximum amount of time to delay (in seconds) before submitting a request if it would be rate limited.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SearchTermsDefault SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified.
StreamPageSizeThe number of results to return per page of data retrieved from the Twitter stream.
StreamReadDurationThis property represents the maximum time to read streaming data, in seconds.
StreamTimeoutThe 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.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseAsyncAPIThis field sets whether the Twitter Ads Asynchronous API is enabled.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Twitter Ads Connector for CData Sync

IsPremiumTwitter

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

Remarks

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

Twitter Ads Connector for CData Sync

MaxRateLimitDelay

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.

Twitter Ads Connector for CData Sync

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

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

Twitter Ads Connector for CData Sync

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use 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.

Integration and Formatting

PropertyDescription
DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=TrueConverts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Twitter Ads Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

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:

*=*

Twitter Ads Connector for CData Sync

SearchTerms

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.

Twitter Ads Connector for CData Sync

StreamPageSize

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.

Twitter Ads Connector for CData Sync

StreamReadDuration

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.

Twitter Ads Connector for CData Sync

StreamTimeout

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

Twitter Ads Connector for CData Sync

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

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.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows 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.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Twitter Ads Connector for CData Sync

UseAsyncAPI

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.

Twitter Ads Connector for CData Sync

UserDefinedViews

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

Remarks

UserDefinedViews 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 use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json
When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Twitter Ads Connector for CData Sync

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539