接続の確立
CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でTwilio Cmdlets を使用する例を示します。
Twilio への接続
Auth Token またはAPI キーのいずれかを使用して、Twilio に認証できます。Auth Token
Auth Token およびAccount SID を使用して、Twilio に認証できます。
Twilio Console Dashboard を開き、Account Info セクションに移動して、以下の接続プロパティを設定します。
- AccountSID:Account SID フィールドの値。
- AuthToken:Auth Token フィールドの値。Show をクリックして非表示を解除します。
API キー
API キーを使用してTwilio に認証するには:
- Twilio Console Dashboard を開き、Account Info > API Keys > Go to API Keys をクリックします。API keys & tokens ページが開きます。
- Create API key をクリックします。Create New API Key メニューが開きます。
- Friendly name を、トークンを参照するために使用する名前に設定します。
- Region を、API キーを適用する地域に設定します。
- Key type を目的のキータイプに設定します。以下のオプションがあります。
- Standard - API Keys、Account Configuration、およびSubaccounts の管理を除く、すべてのTwilio API 機能へのアクセスを許可します。
- Main - Standard キータイプと同じ機能へのアクセス権に加えて、API Keys、Account Configuration、およびSubaccounts を管理できる機能が追加されます。
- Restricted - 標準のAPIKey が付与するTwilio API 機能のサブセットへの詳細なアクセスを許可します。このオプションを選択した場合、トークンが許可する権限を手動で指定する必要があります。
- Create をクリックします。Copy secret key ページが開きます。
- SID およびSecret フィールドの値を控えておきます。後者は1回しか表示されないため、このページを離れる前に必ずコピーしてください。
- 次の接続プロパティを設定します。
- AuthScheme: APIKey
- AccountSID:Twilio Console Dashboard のAccount Info セクションにあるAccount SID フィールドの値。
- APIKeySID:ステップ 4 でメモした、先ほど生成したAPI キーのSID。
- APIKeySecret:ステップ 4 でメモした、先ほど生成したAPI キーのシークレット。
接続オブジェクトの作成
Connect-Twilio cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。
$conn = Connect-Twilio -AccountSid 'MyAccountSid' -AuthToken 'MyAuthToken'
データの取得
Select-Twilio cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。
$results = Select-Twilio -Connection $conn -Table "Applications" -Columns @("Sid, Name") -Where "Sid='AP5ddf534702934bd3a446d293e8cdeb1f'"
Invoke-Twilio cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。
cmdlet 出力のパイプ処理
cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。
Select-Twilio -Connection $conn -Table Applications -Where "Sid = 'AP5ddf534702934bd3a446d293e8cdeb1f'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myApplicationsData.csv -NoTypeInformation
Select-Twilio からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。
ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。
PS C:\> $conn = Connect-Twilio -AccountSid 'MyAccountSid' -AuthToken 'MyAuthToken'
PS C:\> $row = Select-Twilio -Connection $conn -Table "Applications" -Columns (Sid, Name) -Where "Sid = 'AP5ddf534702934bd3a446d293e8cdeb1f'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
"Connection": {
},
"Table": "Applications",
"Columns": [
],
"Sid": "MySid",
"Name": "MyName"
}
データの削除
以下は、抽出条件に合うあらゆるレコードを削除します。
Select-Twilio -Connection $conn -Table Applications -Where "Sid = 'AP5ddf534702934bd3a446d293e8cdeb1f'" | Remove-Twilio
データの変更
cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをTwilio にロードします。
Import-Csv -Path C:\MyApplicationsUpdates.csv | %{
$record = Select-Twilio -Connection $conn -Table Applications -Where ("Sid = `'"+$_.Sid+"`'")
if($record){
Update-Twilio -Connection $conn -Table Applications -Columns @("Sid","Name") -Values @($_.Sid, $_.Name) -Where "Sid = `'$_.Sid`'"
}else{
Add-Twilio -Connection $conn -Table Applications -Columns @("Sid","Name") -Values @($_.Sid, $_.Name)
}
}