Power BI Connector for Twitter Ads

Build 24.0.9060

Connection Properties

The connection 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 settings for this provider. Click the links for further details.

For more information on establishing a connection, see Getting Started.

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
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessTokenThe access token for connecting using OAuth.
OAuthAccessTokenSecretThe OAuth access token secret for connecting using OAuth.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication key used to request and obtain the OAuth Access Token.
OAuthExpiresInThe lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL


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

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectWhen this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port that the proxy server (specified in the ProxyServer connection property) is running on.
ProxyAuthSchemeThe authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connnection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheProviderThe name of the provider to be used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
DirectQueryLimitLimits the number of rows when using the DirectQuery mode. This helps avoid performance issues at design time.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
IsPremiumTwitterSpecifies if is Twitter Premium account. This is false by default.
MaximumColumnSizeThe maximum column size.
MaxRateLimitDelayThe maximum amount of time to delay (in seconds) before submitting a request if it would be rate limited.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PseudoColumnsSpecify a set of pseudocolumns to expose as columns.
RTKThe runtime key used for licensing.
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.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseAsyncAPIThis field sets whether the Twitter Ads Asynchronous API is enabled.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060