OData SDK for PHP を使ってKlaviyo のデータを取得

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Connect AI を使えば、OData を使ってKlaviyo のデータにアクセスできます。CData Connect AI とOData PHP SDK を利用することで、Klaviyo のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

CData Connect AI はKlaviyo のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Klaviyo のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect AI はKlaviyo のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からKlaviyo のデータへのリアルタイム連携を実現します。

Connect AI を構成

ODataPHP SDK でKlaviyo のデータを操作するには、Connect AI からKlaviyo に接続し、コネクションにユーザーアクセスを提供してKlaviyo のデータのOData エンドポイントを作成する必要があります。

Klaviyo に接続したら、目的のテーブルのOData エンドポイントを作成します。

(オプション)新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でKlaviyo に接続するユーザーを作成します。

  1. 「Users」ページに移動し、 Invite Users をクリックします。
  2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。 新しいユーザーを招待
  3. 「Users」ページからユーザーを確認および編集できます。 Connect AI ユーザー

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン(PAT)を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

  1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
  2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
  3. PAT の名前を入力して Create をクリックします。 Creating a new PAT
  4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からKlaviyo に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、 Add Connection をクリックします。 コネクションの追加
  2. 「Add Connection」パネルから「Klaviyo」を選択します。 データソースの選択
  3. 必要な認証プロパティを入力し、Klaviyo に接続します。

    Klaviyo に認証するには、API キーを取得します。API キーは「My Account」から生成・確認できます。

    1. 「Settings」>「API Keys」に移動します。
    2. 「Create API Key」をクリックします。
    3. API キーに名前を付け、必要なスコープを選択します。

    CData 製品から接続するには、API Key に取得した Klaviyo API キーを設定してください。

    OAuth 認証を使用する場合は、ヘルプドキュメントをご参照ください。

    接続の設定(Salesforce の表示)
  4. Create & Test をクリックします。
  5. 「Add Klaviyo Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。 権限を更新

Connect AI にKlaviyo OData エンドポイントを追加する

Klaviyo に接続したら、目的のテーブルのOData エンドポイントを作成します。

  1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
  2. Klaviyo 接続(例:Klaviyo1)を選択し、Next をクリックします。
  3. 使用するテーブルを選択し、「Confirm」をクリックします。 テーブルを選択(Salesforce の例)

コネクションとOData エンドポイントを設定したら、ODataPHP SDK からKlaviyo のデータに接続できます。

  1. まずは、ODataPHP SDK を使用してCData Connect AI が公開したWeb サービスに接続するプロキシクラスを作成します。

    URI 部分を書き換えて、次のようなコマンドを実行してください。

    php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\KlaviyoEntities.php
    	    

    このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

    CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

    認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。

  2. これで、PHP のオブジェクト指向インターフェースを使ってKlaviyo のデータにアクセスできます。以下のコードはCampaigns テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

    require_once 'KlaviyoEntities.php';
    try{
      $svc = new CDataAPI();
      $campaigns = new Campaigns();
      $campaigns->Status = 'draft';
      $svc->AddToCampaigns($campaigns);
      $svc->SetSaveChangesOptions(SaveChangesOptions::None);
      $svc->SaveChanges();
      $response = $svc->campaigns()->Execute();
      foreach($response->Result as $campaigns)
        echo $campaigns->Id."";
    } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
      echo $e->getError(), "\n";
    }
    

はじめる準備はできましたか?

CData Connect AI の詳細、または無料トライアルにお申し込みください:

無料トライアル