Cmdlets for Airtable

Build 24.0.9062

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でAirtable Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。 

Install-Module AirtableCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。 

Import-Module AirtableCmdlets;

Connect-Airtable cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。 

$conn = Connect-Airtable -InitiateOAuth "GETANDREFRESH"

Airtable への接続

本製品 は、Airtable にテーブルとビューを要求します。以下を設定して接続します。

  • BaseId（オプション）：オプションで、このプロパティまたはBaseName のいずれかを指定して、表示されるテーブルおよびビューを特定のベースに制限できます。これをベースID に設定します。
    • この値を見つけるにはthe Airtable API Reference に移動してベースを選択します。選択したベースについてのAirtable ドキュメントのIntroduction セクションで、The ID of this base is <Id> で指定された値を控えておきます。
  • BaseName（オプション）：オプションで、このプロパティまたはBaseId のいずれかを指定して、表示されるテーブルおよびビューを特定のベースに制限できます。これを、Airtable のBase の名前に対応する、使用するスキーマの名前に設定します。

Airtable への認証

個人用アクセストークンまたはOAuth PKCE のいずれかを使用して、Airtable に認証できます。

個人用アクセストークン

まだ個人用アクセストークンを生成していない場合は、はじめに生成します。

  1. ユーザーアカウントにログインします。
  2. token creation page に移動します。
  3. Create new token をクリックします。
  4. Scopes で、Add a scope をクリックして以下の各スコープを追加します。
    • data.records:read
    • data.records:write
    • schema.bases:read
  5. Access で、トークンにアクセス権を付与するすべてのワークスペースとベースを追加します。
  6. Create token をクリックしてトークンを生成します。生成されたトークンは一度しか表示されないので、コピーして保存します。
次に、以下を設定します。
  • AuthScheme：PersonalAccessToken に設定。
  • OAuthAccessToken：先ほど生成した個人用アクセストークンの値に設定。

OAuth PKCE

AuthScheme をOAuthPKCE に設定します。

デスクトップアプリケーション

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリの作成 を参照してください。

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • OAuthClientId（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
  • CallbackURL（カスタムアプリのみ）：アプリの登録時に定義されたリダイレクトURI に設定。例： http://localhost:3333
接続すると、本製品 はデフォルトブラウザでAirtable のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 本製品 はアクセストークンの期限が切れると自動的にリフレッシュします。

ヘッドレスマシン

ドライバーを設定するため、ヘッドレスマシンでユーザーアカウントにOAuth を使用します。インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier およびPKCEVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

Verifier code およびPKCE verifier を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
      • InitiateOAuth：OFF に設定。
      • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
      • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
      次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャがOAuth エンドポイントのURL とPKCEVerifier 値をを返します。あとで使用するためにPKCEVerifier の値を控えておきます。ストアドプロシージャによって返されたURL をブラウザで開きます。
  2. ログインして、本製品 にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。

リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定。
  • PKCEVerifier：ステップ1で説明したPKCEVerifier の値に設定。
  • OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
  • OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

データの取得

Select-Airtable cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。 

$results = Select-Airtable -Connection $conn -Table "SampleTable_1" -Columns @("Id, Column1") -Where "Column2='Bob'"
Invoke-Airtable cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。 

Select-Airtable -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySampleTable_1Data.csv -NoTypeInformation

Select-Airtable からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。 

 
PS C:\> $conn  = Connect-Airtable -InitiateOAuth "GETANDREFRESH"
PS C:\> $row = Select-Airtable -Connection $conn -Table "SampleTable_1" -Columns (Id, Column1) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "SampleTable_1",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Column1":  "MyColumn1"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。 

Select-Airtable -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Remove-Airtable

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをAirtable にロードします。 

Import-Csv -Path C:\MySampleTable_1Updates.csv | %{
  $record = Select-Airtable -Connection $conn -Table SampleTable_1 -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Airtable -Connection $conn -Table SampleTable_1 -Columns @("Id","Column1") -Values @($_.Id, $_.Column1) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Airtable -Connection $conn -Table SampleTable_1 -Columns @("Id","Column1") -Values @($_.Id, $_.Column1)
  }
}

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