このガイドでは、Adobe Customer Journey Analytics（CJA）API について、データ抽出、カスタムソリューション、サードパーティ統合について詳しく説明します。また、アクセス設定、API キー、Postman でのテスト、ステップバイステップの API 呼び出しの例、初めてのユーザー向けのヒントも紹介します。
API を初めて利用するにあたり、Adobe Customer Journey Analytics（CJA）の API がどのように役立つのだろうと思っていませんか？心配無用です。この初心者向けガイドでは、CJA API のエキサイティングな世界への第一歩を踏み出すために必要なことを、専門用語をわかりやすく解説しながら説明していきます。
手作業なしでプログラムによって CJA データにアクセスし、分析できる能力があることを想像してみてください。CJA API を使用すると、まさにそうすることができます。
- データを効率的に抽出：API 呼び出しによるデータ抽出を合理化します。
- カスタムソリューションの構築：特定のビジネスニーズに合わせてカスタマイズされた自動レポートパイプラインを設計、実装します。
- シームレスな接続：堅牢な統合により、CJA とサードパーティアプリケーション間でスムーズなデータフローを実現します。
API をメッセンジャーと考えてみてください。API はリクエストをアドビのサーバーに伝達し、結果をきちんとしたパッケージにして返します。
成功するための設定
最初の API 呼び出しを行う前に、適切なアクセスと権限を設定する必要があります。まず、ご自身が組織の開発者として追加されていることを確認します。次に、必要な権限を持つ製品プロファイルにアクセスできることを確認します。
手順 1：API キーを取得する
- Adobe Developer Console にログインします。
- 新規プロジェクトを作成 して、Customer Journey Analytics API をプロジェクトに追加し、必要な製品プロファイルを選択します。
- 「プロジェクトに追加」をクリックし、Adobe Experience Platform API もプロジェクトに追加します
- 設定が完了すると、左側の「資格情報」」タブで必要な情報をすべて取得できます。
すべての API リクエストに必要な 3 つの必須ヘッダーパラメーターを以下に示します
- アクセストークン - これにより、承認されたユーザーのみがデータにアクセスできます。スクリーンショットでハイライトされている「アクセストークンを生成」CTA をクリックして生成します。これは、AP リクエストでは Authorization パラメーターと呼ばれます。
- クライアント ID - API キーとも呼ばれ、API リクエストでは x-api-key と呼ばれます。
- 組織 ID - API リクエストでは、これは x-gw-ims-org-id と呼ばれます
資格情報は必ず保存してください。これらは API の機能をロック解除するための鍵になります。詳しい手順は、CJA API のはじめにの節に記載されています。
手順 2：設定のテスト
コードを記述せずに API をテストする優れた方法に、強力で使いやすいツール Postman を使用することがあります。アプリケーションを起動すると、API 資格情報を簡単に読み込み、単純な GET リクエストの実験を開始して、接続と認証が正しく機能していることを確認できます。GET リクエストは、変更を加えることなくサーバーからデータを取得するだけなので、より安全で非破壊的なことから、API テストジャーニーを GET リクエストで開始することをお勧めします。これは、サーバー上のデータを変更したり削除したりすることがあることから、慎重にテストする必要がある POST、PUT、DELETE などの他の HTTP リクエストとは対照的です。
最初の API 呼び出し
CJA アカウントで使用可能なデータビューのリストを取得するなど、簡単なことをしてみましょう。
例：データビューのリスト
エンドポイント：
GET https://cja.adobe.io/data/dataviews
ヘッダー：
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG_ID}
Authorization: Bearer {AUTHORIZATION_TOKEN}
CURL リクエスト：
curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\
-H "x-api-key: {API_KEY}" \
-H "x-gw-ims-org-id: {IMS_ORG_ID}" \
-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"
また、CJA API エンドポイントのドキュメント内で、Try It 機能を使用してこれらのリクエストを試すこともできます。す。上記のリクエストを試すためのリンクはこちらです。
「Try It」CTA をクリックし、必須パラメーターを入力します。この場合、先ほど説明したヘッダーパラメーターを入力し、「Send」をクリックします。
追加のパラメーターを含めてリクエストをカスタマイズすることもできます。使用可能なパラメーターのリストについては、CJA API ドキュメント の各 API リクエストのクエリパラメーターの節を参照してください。
API を使用する際に発生する主な HTTP 応答コードを次に示します。
- 200：成功 - サーバーはリクエストを正常に処理し、データを返しました。
- 404：見つかりません - サーバーはリクエストされたリソースを見つけることができませんでした。
- 500：内部サーバーエラー - サーバーサイドでエラーが発生しました。
ステータスコードは、API リクエスト中に何が起こったのかを開発者に正確に伝えるので、問題のトラブルシューティングが容易になります。
初めて API を使用するユーザーへのヒント
- アクセス権の確認： 適切なレベルの権限を持っていることと、正しい製品プロファイルに追加されていることを確認します。適切なアクセス権がないことが、API リクエストの失敗の最も一般的な根本原因です。
- テスト、テスト、テスト： コードを書く前にリクエストを試すには、API エンドポイントドキュメントの Try It 機能や Postman を使用します。
- 小さく始める： 単純な GET リクエストから始めて、POST クエリへと進みます。
- ドキュメントを活用： アドビの CJA API ドキュメントは最高の友です。大規模アップデート後は古い設定が期待どおりに動作しない場合があるので、更新を定期的に確認しましょう。
- 質問する： 気軽に Experience League Adobe Analytics コミュニティに助けを求めてください。
Adobe CJA API の使用を開始するのは、最初は困難に思えるかもしれませんが、少し練習すれば、すぐにワークフローを自動化し、インサイトを引き出すことができます。まずは最初の一歩を踏み出しましょう。ログインして認証情報を取得し、簡単な API 呼び出しを試してみてください。API アドベンチャーが待っています。