PHP のOData SDK を使用したAdobe Target のデータのクエリ

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でAdobe Target エンティティを手軽に使用。



CData API Server は、ADO.NET Provider for AdobeTarget（またはその他の240+ ADO.NET Providers のデータ）と組み合わせることで、Adobe Target のデータをWeb サービスとして公開します。下記の手順に従って、Adobe Target のデータをPHP オブジェクトとして使用しましょう。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなAdobe Target OData サービスを作成していきましょう。

Adobe Target への接続

PHP からAdobe Target のデータを操作するには、まずAdobe Target への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Adobe Target」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、Adobe Target への接続設定を行っていきましょう！ 接続設定

  5. Adobe Target に接続するには、以下に記載されているOAuth 接続プロパティとともにTenant プロパティを指定する必要があります。他の接続プロパティは処理動作に影響を与える可能性がありますが、接続には影響しません。

    以下のステップでTenant 名を確認できます。

    1. Adobe Experience にログインします。URL は「https://experience.adobe.com/#/@mycompanyname/preferences/general-section」です。
    2. 「/#/@」の後の値を抽出します。この例では「mycompanyname」です。
    3. Tenant 接続プロパティをその値に設定します。

    ユーザーアカウント（OAuth）

    すべてのユーザーアカウントフローでAuthScheme をOAuthClient に設定する必要があります。

    注意：OAuth を介したAdobe 認証では、2週間ごとにトークンを更新する必要があります。

    すべてのアプリケーション

    CData では、OAuth 認証を簡素化する組み込みOAuth アプリケーションを提供しています。または、カスタムOAuth アプリケーションを作成することもできます。詳細については、ヘルプドキュメントの「カスタムOAuthアプリの作成」をご確認ください。

    OAuth アクセストークンの取得

    接続するには以下のプロパティを設定します：

    • InitiateOAuth：GETANDREFRESH に設定して、OAuth 交換を自動的に実行し、必要に応じてOAuthAccessToken を更新します。
    • OAuthClientId：アプリを登録した際に割り当てられたクライアントID に設定します。
    • OAuthClientSecret：アプリを登録した際に割り当てられたクライアントシークレットに設定します。
    • CallbackURL：アプリを登録した際に定義されたリダイレクトURI に設定します。例：https://localhost:3333

    これらの設定により、プロバイダーはAdobe Target からアクセストークンを取得し、それを使用してデータを要求します。OAuth値はOAuthSettingsLocation で指定された場所に保存され、接続間で確実に保持されます。

  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Adobe Target に接続するには、以下に記載されているOAuth 接続プロパティとともにTenant プロパティを指定する必要があります。他の接続プロパティは処理動作に影響を与える可能性がありますが、接続には影響しません。

以下のステップでTenant 名を確認できます。

  1. Adobe Experience にログインします。URL は「https://experience.adobe.com/#/@mycompanyname/preferences/general-section」です。
  2. 「/#/@」の後の値を抽出します。この例では「mycompanyname」です。
  3. Tenant 接続プロパティをその値に設定します。

ユーザーアカウント（OAuth）

すべてのユーザーアカウントフローでAuthScheme をOAuthClient に設定する必要があります。

注意：OAuth を介したAdobe 認証では、2週間ごとにトークンを更新する必要があります。

すべてのアプリケーション

CData では、OAuth 認証を簡素化する組み込みOAuth アプリケーションを提供しています。または、カスタムOAuth アプリケーションを作成することもできます。詳細については、ヘルプドキュメントの「カスタムOAuthアプリの作成」をご確認ください。

OAuth アクセストークンの取得

接続するには以下のプロパティを設定します：

  • InitiateOAuth：GETANDREFRESH に設定して、OAuth 交換を自動的に実行し、必要に応じてOAuthAccessToken を更新します。
  • OAuthClientId：アプリを登録した際に割り当てられたクライアントID に設定します。
  • OAuthClientSecret：アプリを登録した際に割り当てられたクライアントシークレットに設定します。
  • CallbackURL：アプリを登録した際に定義されたリダイレクトURI に設定します。例：https://localhost:3333

これらの設定により、プロバイダーはAdobe Target からアクセストークンを取得し、それを使用してデータを要求します。OAuth値はOAuthSettingsLocation で指定された場所に保存され、接続間で確実に保持されます。

API Server のユーザー設定

次に、API Server 経由でAdobe Target にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Adobe Target 用のAPI エンドポイントの作成

ユーザーを作成したら、Adobe Target のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でAdobe Target への接続を設定してユーザーを作成し、API Server でAdobe Target データのAPI を追加しました。これで、OData 形式のAdobe Target データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Adobe Target に接続するには、以下に記載されているOAuth 接続プロパティとともにTenant プロパティを指定する必要があります。他の接続プロパティは処理動作に影響を与える可能性がありますが、接続には影響しません。

以下のステップでTenant 名を確認できます。

  1. Adobe Experience にログインします。URL は「https://experience.adobe.com/#/@mycompanyname/preferences/general-section」です。
  2. 「/#/@」の後の値を抽出します。この例では「mycompanyname」です。
  3. Tenant 接続プロパティをその値に設定します。

ユーザーアカウント（OAuth）

すべてのユーザーアカウントフローでAuthScheme をOAuthClient に設定する必要があります。

注意：OAuth を介したAdobe 認証では、2週間ごとにトークンを更新する必要があります。

すべてのアプリケーション

CData では、OAuth 認証を簡素化する組み込みOAuth アプリケーションを提供しています。または、カスタムOAuth アプリケーションを作成することもできます。詳細については、ヘルプドキュメントの「カスタムOAuthアプリの作成」をご確認ください。

OAuth アクセストークンの取得

接続するには以下のプロパティを設定します：

  • InitiateOAuth：GETANDREFRESH に設定して、OAuth 交換を自動的に実行し、必要に応じてOAuthAccessToken を更新します。
  • OAuthClientId：アプリを登録した際に割り当てられたクライアントID に設定します。
  • OAuthClientSecret：アプリを登録した際に割り当てられたクライアントシークレットに設定します。
  • CallbackURL：アプリを登録した際に定義されたリダイレクトURI に設定します。例：https://localhost:3333

これらの設定により、プロバイダーはAdobe Target からアクセストークンを取得し、それを使用してデータを要求します。OAuth値はOAuthSettingsLocation で指定された場所に保存され、接続間で確実に保持されます。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。 

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

  • Windows：C:\ProgramData\CData\AdobeTarget\
  • Unix or Mac OS X：~/cdata/AdobeTarget/

Adobe Target エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

  1. 以下のようなコマンドにURL を渡します。 

    php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\AdobeTargetEntities.php

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

    API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

    許可されたユーザーは、API Server の「Users」セクションで設定できます。

  2. PHP のオブジェクト指向インターフェースを使用して、Adobe Target のデータへのアクセスを開始できます。以下のコードは、Activities テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。 

    require_once 'AdobeTargetEntities.php';
try{
  $svc = new CData();
  $activities = new Activities();
  $activities->Type = 'AB';
  $svc->AddToActivities($activities);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->activities()->Execute();
  foreach($response->Result as $activities)
    echo $activities->Id."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

この記事の内容

関連記事