接続の確立

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

Klaviyo への接続

Klaviyo に接続するには、まず以下のプロパティを設定して認証方法を選択します。

AuthScheme：Klaviyo に接続する際に使用する認証の種類。

選択した方法に応じて、追加の接続プロパティが必要です。サポートされている各認証タイプの設定手順については、以下を参照してください。

カスタムフィールドへのアクセス

デフォルトでは、本製品はシステムフィールドのみ表示します。カスタムフィールドを検出して含めるには、IncludeCustomFields をtrue に設定します。 IncludeCustomFields がtrue に設定されている場合、本製品はRowScanDepth レコードをスキャンしてカスタムフィールドを検出し、そのデータ型を判定します。すべてのレコードをスキャンしてカスタムフィールドを検出するには、RowScanDepth を0 に設定します。カスタムフィールドを有効にし、RowScanDepth を0 または大きな値に設定すると、パフォーマンスに影響を与える可能性があることに注意してください。

List_{ListName} とSegment_{SegmentName} を個別のビューとしてアクセスする

デフォルトでは、本製品はシステムテーブルとビューのみを表示します。 Klaviyo インターフェースと同様に、各リストとセグメントを個別のビューとしてモデル化するには、ListDynamicViews をtrue に設定します。

Klaviyo への認証

Klaviyo への認証には、API キーまたはOAuth PKCE のいずれかを使用できます。

API キー

まだAPI キーを生成していない場合は、はじめに生成します。

ユーザーアカウントにログインします。
Private API Key creation page に移動します。
Create Private API Key をクリックします。
Private API Key Name で、キーに名前を割り当てます。
Select Access Level で、必要なアクセスレベルを選択します。接続テストを成功させるには、最低限Accounts: Read アクセスが必要です。
Create をクリックしてAPI キーを生成します。生成されたAPI キーは一度しか表示されないので、コピーして保存してください。

次に、以下のプロパティを設定します。

AuthScheme：APIKey に設定。
APIKey：生成したPrivate API Key の値に設定。

OAuth PKCE

AuthScheme をOAuthPKCE に設定します。

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

OAuth PKCE を使用して認証するには、カスタムOAuth アプリケーションを作成する必要があります。手順については、カスタムOAuth アプリの作成を参照してください。

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

次のプロパティを設定して、接続してください。

OAuthClientId アプリの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret アプリの登録時に割り当てられたクライアントシークレットに設定。アプリ登録時にシークレットが生成されなかった場合、これはオプションです。
CallbackURL アプリの登録時に定義されたリダイレクトURI に設定。例： http://localhost:3333

接続すると、本製品はデフォルトブラウザでKlaviyo のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

本製品はアクセストークンの期限が切れると自動的にリフレッシュします。

ヘッドレスマシン

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

接続オブジェクトの作成

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

$conn = Connect-Klaviyo -AuthScheme "OAuthPKCE" -InitiateOAuth "GETANDREFRESH" -OAuthClientId "myClientId" -OAuthClientSecret "myClientSecret" -CallbackURL "http://localhost:33333"

データの取得

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

$results = Select-Klaviyo -Connection $conn -Table "SampleTable_1" -Columns @("Id, Column1") -Where "Column2='Bob'"

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

cmdlet 出力のパイプ処理

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

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

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

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

 
PS C:\> $conn  = Connect-Klaviyo -AuthScheme "OAuthPKCE" -InitiateOAuth "GETANDREFRESH" -OAuthClientId "myClientId" -OAuthClientSecret "myClientSecret" -CallbackURL "http://localhost:33333" 
PS C:\> $row = Select-Klaviyo -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-Klaviyo -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Remove-Klaviyo

データの変更

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

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

Cmdlets for Klaviyo