CData Cloud offers access to Twitter Ads across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Twitter Ads through CData Cloud.
CData Cloud allows you to standardize and configure connections to Twitter Ads as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Twitter Ads in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Twitter Ads and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Twitter Ads through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Twitter Ads by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
By default, the Cloud 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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud models Twitter Ads entities in relational Tables, Views, and Stored Procedures.
The Cloud uses the Twitter Ads API to process supported filters. The Cloud processes other filters client-side within the Cloud.
Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
The Cloud models the data in Twitter Ads as a list of tables in a relational database that can be queried using standard SQL statements.
| 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. |
Retrieve details for some or all permissions associated with the specified tailored audience.
| 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 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. |
Retrieve details for some or all Tailored Audiences associated with the current account.
Only the Id filter is supported.
SELECT * FROM AdAudiences WHERE Id = 'TXR1'
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.
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]
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]
| 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 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. |
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.
| 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. |
Retrieve all of the advertising-enabled accounts the authenticating user has access to.
There are no available filters for this view.
| 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 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. |
Retrieve details about which entities' analytics metrics have changed in a given time period.
| 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 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. |
Retrieve reach and average frequency analytics for specified campaigns.
| 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. |
Retrieve details for some or all campaigns associated with the current account.
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 Cloud will try to get the first account from the list returned by the AdAccount view.
| 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 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. |
Retrieve details for some or all cards associated with the current account.
| 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 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. |
Retrieve some or all funding instruments associated with the account specified in the path.
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 Cloud will try to get the first account from the list returned by the AdAccount view.
| 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 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. |
Retrieve reach and average frequency analytics for specified funding instruments.
| 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. |
Retrieve some or all funding instruments associated with the account specified.
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 Cloud will try to get the first account from the list returned by the AdAccount view.
| 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 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. |
Retrieve all of the advertising-enabled Tweets the authenticating user has access to.
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 Cloud will try to get the first account from the list returned by the AdAccount view.
| 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 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. |
Query information about all available metrics for a certain entity.
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.
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 Cloud 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:
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 Cloud 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' |
| Granularity | This 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'
| 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. |
Retrieve all of the advertising-enabled Tweets the authenticating user has access to.
The AccountId field is filterable server-side.
SELECT * FROM AdTweets WHERE AccountId = '1234'
SELECT * FROM AdTweets WHERE AccountId IN (SELECT Id FROM AdAccounts)
| 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 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 |
Stored procedures are function-like interfaces that extend the functionality of the Cloud 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.
| Name | Description |
| ManageAudienceUsers | Add, update and remove users from a given custom audience id. |
Add, update and remove users from a given custom audience id.
| 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. |
| 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. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Twitter Ads:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the AdAudiences table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='AdAudiences'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the GetOAuthAuthorizationUrl stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAuthorizationUrl' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAuthorizationUrl' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Twitter Ads procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the AdAudiences table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AdAudiences'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
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.
| Property | Description |
| 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. |
| AdsAPIVersion | The current version of Twitter API. |
| UseAppOnlyAuthentication | A boolean that indicates whether or not you would like to use app-only authentication. |
| Property | Description |
| 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. |
| 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.). |
| AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
| AuthKey | The authentication key used to request and obtain the OAuth Access Token. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| IsPremiumTwitter | Specifies if is Twitter Premium account. This is false by default. |
| MaxRateLimitDelay | The maximum amount of time to delay (in seconds) before submitting a request if it would be rate limited. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SearchTerms | Default SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified. |
| StreamPageSize | The number of results to return per page of data retrieved from the Twitter stream. |
| StreamReadDuration | This property represents the maximum time to read streaming data, in seconds. |
| 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. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseAsyncAPI | This field sets whether the Twitter Ads Asynchronous API is enabled. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
| AdsAPIVersion | The current version of Twitter API. |
| UseAppOnlyAuthentication | A boolean that indicates whether or not you would like to use app-only authentication. |
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.
string
""
Identifier of the advertising account. This Id is used to get analytic stats for the account that is identified by this Id. The AddAccounts view can be used to list available accounts with their specific Ids.
The current version of Twitter API.
string
"11"
The current version of Twitter API.
A boolean that indicates whether or not you would like to use app-only authentication.
bool
false
Set this to true to have your Twitter app log in to Twitter instead of a user.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
| 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.). |
| AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
| AuthKey | The authentication key used to request and obtain the OAuth Access Token. |
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.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud 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.
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.).
string
""
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:
For more information on how this property is used when configuring a connection, see Establishing a Connection
The authentication token used to request and obtain the OAuth Access Token.
string
""
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
The authentication key used to request and obtain the OAuth Access Token.
string
""
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
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.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| IsPremiumTwitter | Specifies if is Twitter Premium account. This is false by default. |
| MaxRateLimitDelay | The maximum amount of time to delay (in seconds) before submitting a request if it would be rate limited. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SearchTerms | Default SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified. |
| StreamPageSize | The number of results to return per page of data retrieved from the Twitter stream. |
| StreamReadDuration | This property represents the maximum time to read streaming data, in seconds. |
| 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. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseAsyncAPI | This field sets whether the Twitter Ads Asynchronous API is enabled. |
Specifies if is Twitter Premium account. This is false by default.
bool
false
Specifies if is Twitter Premium account. This is false by default.
The maximum amount of time to delay (in seconds) before submitting a request if it would be rate limited.
string
"60"
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 Cloud keeps track of if a given request would result in a rate limit exception. If a rate limit would occur, the CData Cloud 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 Cloud will wait once it detects a rate limit would occur. Since the amount of time the CData Cloud needs to wait can be calculated, if it would have to wait longer than the MaxRateLimitDelay, it will simply error immediately when it sees the time would take too long.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
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.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Default SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified.
string
""
Default SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified.
The number of results to return per page of data retrieved from the Twitter stream.
string
"50"
The number of results to return per page of data retrieved from the Twitter stream.
This property represents the maximum time to read streaming data, in seconds.
int
0
Set StreamReadDuration property to consume streaming data for a specific time period. When StreamReadDuration is reached and StreamTimeout is 0, then the connection will be closed.
The maximum number of seconds to continue waiting for results while streaming. When this value is reached and no tweets are returned, then the connection will be closed.
string
"0"
Set the value of StreamTimeout to 0 in order to keep the connection open indefinitely. Note that, if the value of this property is greater than zero, the value of the StreamPageSize property, will be overwriten and will be set to one(1).
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
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.
This field sets whether the Twitter Ads Asynchronous API is enabled.
bool
false
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.
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.