接続の確立

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

インストールおよび接続

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

Install-Module SendGridCmdlets

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

Import-Module SendGridCmdlets;

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

$conn = Connect-SendGrid -APIKey 'MyAPIKey'

SendGrid 本製品経由で認証するには、API キーを使用する必要があります。

API キーの取得

API キーを取得するには以下の手順に従ってください。

SendGrid にログインします。
［Settings］をクリックします。
［API keys］をクリックします。
［Create API Key］をクリックします。
API キーの権限を選択します。Full Access またはRestricted Access のいずれかです。その後、API キーが表示されます。

NOTE： E メールイベントにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。

データの取得

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

$results = Select-SendGrid -Connection $conn -Table "MarketingCampaigns" -Columns @("Title, Subject") -Where "Id='17693'"

Invoke-SendGrid cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

Select-SendGrid -Connection $conn -Table MarketingCampaigns -Where "Id = '17693'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMarketingCampaignsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-SendGrid -APIKey 'MyAPIKey'
PS C:\> $row = Select-SendGrid -Connection $conn -Table "MarketingCampaigns" -Columns (Title, Subject) -Where "Id = '17693'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "MarketingCampaigns",
  "Columns":  [

  ],
  "Title":  "MyTitle",
  "Subject":  "MySubject"
}

データの削除

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

Select-SendGrid -Connection $conn -Table MarketingCampaigns -Where "Id = '17693'" | Remove-SendGrid

データの変更

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

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