接続の確立

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

インストールおよび接続

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

Install-Module ActiveCampaignCmdlets

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

Import-Module ActiveCampaignCmdlets;

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

$conn = Connect-ActiveCampaign -URL "yourURL" -APIKEY "yourApiKey"

ActiveCampaign への接続

ActiveCampaign はAPI キーによる認証をサポートしています。ActiveCampaign に接続するには、自身のアカウントでDeveloper ページに移動して以下を設定します。

URL：このプロパティを設定するには、My Settings ページに移動します。例： https://<yourAccountName>.api-us1.com
APIKey：このプロパティを設定するには、Settings ページに移動します。ActiveCampaign アカウントの各ユーザーには、それぞれ固有のAPI キーがあります。

これらのプロパティを設定する際、My Settings とSettings をを間違えないようにしてください。

データの取得

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

$results = Select-ActiveCampaign -Connection $conn -Table "Contacts" -Columns @("LastName, Email") -Where "FirstName='Bob'"

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

cmdlet 出力のパイプ処理

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

Select-ActiveCampaign -Connection $conn -Table Contacts -Where "FirstName = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myContactsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-ActiveCampaign -URL "yourURL" -APIKEY "yourApiKey"
PS C:\> $row = Select-ActiveCampaign -Connection $conn -Table "Contacts" -Columns (LastName, Email) -Where "FirstName = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Contacts",
  "Columns":  [

  ],
  "LastName":  "MyLastName",
  "Email":  "MyEmail"
}

データの削除

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

Select-ActiveCampaign -Connection $conn -Table Contacts -Where "FirstName = 'Bob'" | Remove-ActiveCampaign

データの変更

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

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