Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in Twitter Ads.
Setting Up a Data Source
Complete the following steps to connect to the data:
- Under Connect | To a Server, click More....
- Select the data source called Twitter Ads by CData.
- Enter the information required for the connection.
- Click Sign In.
- If necessary, select a Database and Schema to discover what tables and views are available.
Using the Connection Builder
The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.
There are two ways to access the connection builder:
- On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for Twitter Ads folder.
- You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.
In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.
Connecting to Twitter Ads
Twitter Ads supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application. See Creating a Custom OAuth Application for more information about creating custom applications.Desktop Applications
To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.Get and refresh the OAuth access token:
- InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
- OAuthClientId = the client Id assigned when you registered your application.
- OAuthClientSecret = the client secret that was assigned when you registered your application.
- CallbackURL = the redirect URI that was defined when you registered your application.
When you connect, the connector opens Twitter Ads's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector then completes the OAuth process:
- The connector obtains an access token from Twitter Ads and uses it to request data.
- The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
When the access token expires, the connector refreshes it automatically.
Headless Machines
If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:
- Option 1: Obtain the OAuthVerifier value.
- Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.
After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.
Option 1: Obtaining and Exchanging a Verifier Code
To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:
-
Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.
Set the following properties:
- InitiateOAuth = OFF.
- OAuthClientId = the client Id assigned when you registered your application.
- OAuthClientSecret = the client secret assigned when you registered your application.
-
Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)
Copy this URL and paste it into a new browser tab.
-
Log in and grant permissions to the connector. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.
-
Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, set the following connection properties to obtain the OAuth authentication values:
- InitiateOAuth = REFRESH.
- OAuthVerifier = the noted verifier code (the value of the code parameter in the redirect URI).
- OAuthSettingsLocation = persist the encrypted OAuth authentication values to the specified file.
- OAuthClientId = the client Id in your custom OAuth application settings.
- OAuthClientSecret = the client secret in the custom OAuth application settings.
-
Test the connection to generate the OAuth settings file.
-
After you re-set the following properties, you are ready to connect:
- InitiateOAuth = REFRESH.
- OAuthSettingsLocation = the file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the connector.
- OAuthClientId = the client Id assigned when you registered your application.
- OAuthClientSecret = the client secret assigned when you registered your application.
Option 2: Transferring OAuth Settings
Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".
After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.
Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.
To connect to data via the headless machine, set the following connection properties:
- InitiateOAuth = REFRESH
- OAuthSettingsLocation = the path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the connector.
- OAuthClientId = the client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret = the client secret assigned when you registered your custom OAuth application.
Next Step
See Using the Connector to create data visualizations.