Airtable 接続マネージャーで接続

新しいAirtable 接続は、SSIS パッケージに簡単に追加できます。［接続マネージャー］ウィンドウ内を右クリックし、メニューから［新しい接続］を選択します。次に、［SSIS 接続マネージャーの追加］ウィンドウから［Airtable 接続マネージャー］を選択します。

または、Airtable 変換元またはAirtable 変換先を使用して、新しい接続を直接作成できます。［Airtable 接続マネージャー］ウィンドウでは、プロパティを設定できます。

Connecting to Airtable

The 本製品 requests tables and views from Airtable. Specify the following to connect.

• EnableMetadataAPI: Set this to true unless you do not want your token to have access to the Airtable Metadata API.
• BaseId: Set this to your base ID. To find this value, navigate to the Airtable API Reference and select a base. In the introduction section of the Airtable documentation for the selected base, note the value specified in The ID of this base is <Id>.
  • If you have set EnableMetadataAPI to true, you can optionally specify either this property or BaseName to limit the shown tables and views to a particular base.
  • If you have set EnableMetadataAPI to false, this is required.
• BaseName: If you have set EnableMetadataAPI to true, set this to the name of the schema, which corresponds to the name of the Base in Airtable, that you want to use.
  • If you have set EnableMetadataAPI to true, you can optionally specify either this property or BaseId to limit the shown tables and views to a particular base.
• TableNames: If you have set EnableMetadataAPI to false, set this to a comma-separated list of table names for the selected base in the format TableA,TableB..etc. Supply the table names exactly as they are displayed in the Airtable UI.
• ViewNames (optional): If you have set the EnableMetadataAPI connection property to false, set this to a comma-separated list of views in the format TableA.ViewA,TableA.ViewB,..etc. These are the same view names as those found in the UI.

Note: Do not use the '.' character in column names. It is used for building column names based on paths and may risk breaking INSERT/UPDATE statements. If you already have column names that contain the '.' character, set the PathDelimiter connection property to a character that is not used in column names.

Authenticating to Airtable

You can authenticate to Airtable using either an API Key, a Personal Access Token, or OAuth PKCE.

API Key

You can use traditional Airtable API keys to authenticate.

Note: Airtable plans to deprecate the use of API keys on the 1st of February 2024. If you are still using API key authentication as of this date, you will need to switch to another authentication method to continue using the 本製品.

Set the following:

• AuthScheme: Set this to ApiKey.
• ApiKey: Log into Airtable and navigate to the Airtable API page Then, click Use API key instead. Set the ApiKey to the generated key.

Personal Access Token

First, generate a personal access token, if you have not done so already:

1. Log in to your user account.
2. Navigate to the token creation page.
3. Click Create token.
4. Under Scopes, select the following:
   • data.records:read
   • data.records:write
   • schema.bases:read
5. Under Access, add all the workspaces and bases that you want the token to have access to.
6. Click Create token to generate the token. Copy and save the generated token, as it will only be shown once.

Next, set the following:

• AuthScheme: Set this to PersonalAccessToken.
• OAuthAccessToken: Set this to the value of personal access token that you generated earlier.

OAuth PKCE

Set AuthScheme to OAuthPKCE.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See カスタムOAuth アプリの作成 for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your app.
• OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app. Specifying this value is optional if a value was not generated during the OAuth custom application creation process.
• CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: http://localhost:3333

When you connect, the 本製品 opens Airtable's OAuth endpoint in your default browser. Log in and grant permissions to the application. The 本製品 then completes the OAuth process:

1. The 本製品 obtains an access token from Airtable and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation, to be persisted across connections.

The 本製品 refreshes the access token automatically when it expires.

Headless Machines

To configure the driver, use OAuth with a user account on a headless machine. You need to authenticate on another device that has an internet browser.

1. Choose one of two options:
   • Option 1: Obtain the OAuthVerifier and PKCEVerifier values as described in "Obtain and Exchange a Verifier Code" below.
   • Option 2: Install the 本製品 on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.
2. Then configure the 本製品 to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange Verifier Codes

To obtain a verifier code and PKCE verifier, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

1. Choose one of these options:
   • If you are using the Embedded OAuth Application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.
   • If you are using a custom OAuth application, set the following properties:
     • InitiateOAuth: Set to OFF.
     • OAuthClientId: Set to the client Id assigned when you registered your application.
     • OAuthClientSecret: Set to the client secret assigned when you registered your application. Specifying this value is optional if a value was not generated during the OAuth custom application creation process.
     Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. The stored procedure returns the URL to the OAuth endpoint as well as a PKCEVerifier value. Note the value of the PKCEVerifier for later use. Open the URL returned by the stored procedure in a browser.
2. Log in and grant permissions to the 本製品. You are then redirected to the redirect URI.

There will be a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.

Next, you need to 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: Set this to REFRESH.
• OAuthVerifier: Set this to the noted verifier code (the value of the code parameter in the redirect URI).
• PKCEVerifier: Set this to the PKCEVerifier value you noted earlier in Step 1.
• OAuthClientId: (custom applications only) Set this to the client Id in your custom OAuth application settings.
• OAuthClientSecret: (custom applications only) Set this to the client secret in the custom OAuth application settings. Specifying this value is optional if a value was not generated during the OAuth custom application creation process.
• OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application. Specifying this value is optional if a value was not generated during the OAuth custom application creation process.
• OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the 本製品 to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

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.

On the headless machine, set the following connection properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application. Specifying this value is optional if a value was not generated during the OAuth custom application creation process.
• OAuthSettingsLocation: Set this to the path to the OAuth settings file you copied from the machine with the browser. Make sure this file gives read and write permissions to the 本製品 to enable the automatic refreshing of the access token.