Adobe Target API の認証の設定

最終更新日： 2024年7月22日

作成対象：

開発者

Recommendations Admin API を含む Adobe Target 管理 API は、許可されたユーザーのみが Adobe Target ーザーにアクセスするために使用できるように、認証で保護されています。 Adobe Developer Console を使用して、Adobe Target を含むすべての Adobe Experience Cloud solutions に対してこの認証を管理します。

IMPORTANT

この記事で説明するサービスアカウント（JWT）資格情報は、新しい OAuth サーバー間資格情報に置き換えて、非推奨になります。

サービスアカウント（JWT）資格情報は、2025 年 1 月 1 日（PT）まで引き続き機能します。新しい OAuth サーバー間資格情報を使用するには、2025 年 1 月 1 日（PT）までにアプリケーションまたは統合を移行する必要があります。

統合を移行するための詳細と手順については、Developer Console ドキュメントのサービスアカウント（JWT）資格情報から OAuth サーバー間資格情報への移行を参照してください。

新しい OAuth 資格情報の設定について詳しくは、Developer Console ドキュメントのOAuth サーバー間資格情報の実装 を参照してください。

Adobe Target API を正常に操作するために必要なレガシー JWT 認証トークンを生成するための準備手順を以下に示します。

プロジェクト（旧称：統合）を Adobe Developer Console で作成します。
プロジェクトの詳細をPostmanに書き出します。
ベアラアクセストークンを生成します。
ベアラアクセストークンのテスト

前提条件

リソース	詳細
Postman	これらの手順を正常に完了するには、お使いのオペレーティングシステムに対応する 🔗0}Postman アプリ } を取得します。 Postman basic は無料でアカウントを作成できます。 Postmanは、Adobe Target API を一般的に使用するために必要なものではありませんが、API ワークフローを容易にし、API の実行や Adobe Target の動作の学習に役立つ複数のPostman コレクションを提供しています。このガイドの残りの部分では、Postmanに関する実務知識を前提としています。サポートについては、Postmanのドキュメントを参照してください。
参照	このガイドの残りの部分では、次のリソースに慣れていることを前提としています。 Adobe I/O Github Target 管理者およびプロファイル API のドキュメント Recommendations API ドキュメント

リソース

詳細

Postman

これらの手順を正常に完了するには、お使いのオペレーティングシステムに対応する 🔗0}Postman アプリ } を取得します。 Postman basic は無料でアカウントを作成できます。 Postmanは、Adobe Target API を一般的に使用するために必要なものではありませんが、API ワークフローを容易にし、API の実行や Adobe Target の動作の学習に役立つ複数のPostman コレクションを提供しています。このガイドの残りの部分では、Postmanに関する実務知識を前提としています。サポートについては、Postmanのドキュメントを参照してください。

参照

このガイドの残りの部分では、次のリソースに慣れていることを前提としています。

Adobe I/Oプロジェクトの作成

この節では、Adobe Developer Console にアクセスして、Adobe Target 用のプロジェクトを作成します。詳しくは、プロジェクトに関するドキュメントを参照してください。

<! – （1. 認証に関するドキュメントに従って、秘密鍵と公開証明書を生成します。// [//]:#（Adobe IO の設定方法：認証 – 手順の 手順 1 で説明します。手順 1 を完了したら、このガイドに戻り、次の手順 2 に進みます。//このステップの結果は、private.key ファイルと certificate_pub.crt ファイルの作成になります。これら 2 つのファイルを生成したら、このガイドに戻ります。） – >

Adobe Admin Console で、お使いの Adobe ユーザーアカウントに Target に対する製品管理者レベルおよび開発者レベルのアクセス権の両方が付与されていることを確認します。
Adobe Developer Console で、この統合を作成する Experience Cloud Organization を選択します。（1 つの Experience Cloud Organization ージにのみアクセスできる可能性があります）。
Create new project をクリックします。
「Add API」をクリックして REST API をプロジェクトに追加し、Adobe サービスおよび製品にアクセスします。
統合する Adobe サービスとして Adobe Target を選択します。表示される「Next」ボタンをクリックします。
Target 用に作成するサービスアカウント統合に公開キーと秘密キーを関連付けるためのオプションを選択してください。この例では、「Option 1: Generate a key pair」を選択し、「Generate keypair」をクリックします。
指示に従って、自動的にダウンロードされた設定ファイル（config）をメモします。これには、秘密鍵が含まれています。 Next をクリックします。
ファイルシステムで、config の場所を確認します。これは、前の手順で作成した圧縮された設定ファイルです。ここでも、この config ファイルには秘密鍵が含まれています。これは後で必要になります。ファイルシステム内の正確な場所は、ここで示した場所とは異なる場合があります。
Adobe Developer Consoleに戻り、Adobe Recommendationsを使用しているプロパティに対応する製品プロファイルを選択します。（プロパティを使用しない場合は、「デフォルトのWorkspace」オプションを選択します）。 Save configured API をクリックします。
「Create Integration」をクリックします。 API が正常に設定されたことを示す一時的なメッセージが表示されます。
最後の手順として、プロジェクトの名前を元の Project 1 よりも意味のある名前に変更します。それには、ナビゲーションパスを表示として使用してプロジェクトに移動し、「Edit project」をクリックして Edit Project モーダルにアクセスし、プロジェクトの名前を変更します。

NOTE

この例では、プロジェクトに「Target Integration」という名前を付けます。プロジェクトを単なる Adobe Target 以上の用途で使用することが予想される場合は、それに応じて名前を付けた方がよいでしょう。例えば、Adobe Experience Cloudの他のソリューションと共に使用される可能性があるので、「AdobeAPI」または「Experience CloudAPI」という名前を付けることができます。

プロジェクト詳細の書き出し

これで、Target へのアクセスに使用できるAdobeプロジェクトが作成されました。次は、そのプロジェクトの詳細とAdobe API リクエストを送信する必要があります。これらの詳細は、複数の Target API を含む複数のAdobeAPI とやり取りするために必要です。例えば、統合の詳細には、Target 管理 API で必要な認証および認証情報が含まれます。したがって、Postmanで API を使用するには、これらの詳細をPostmanに取り込む必要があります。

Postmanでは多くの方法でプロジェクトの詳細を指定できますが、この節では、いくつかの事前定義済みの機能とコレクションを利用します。まず（この節では）、統合の詳細をPostman環境に書き出します。次に（次の節で）、必要なAdobeリソースへのアクセス権を付与するベアラアクセストークンを生成します。

NOTE

Target を含む任意のExperience Cloudソリューションに適用できるビデオ手順については、Experience Platform API でのPostmanの使用を参照してください。次の節は、Target API に関連しています。1. Experience PlatformAPI を作成してPostman 2 に書き出します。 Postmanでアクセストークンを生成します。これらの手順は、以下でも説明します。

引き続き Adobe Developer Console で、新しいプロジェクトの Service Account (JWT) 資格情報を表示するために移動します。図に示すように、左側のナビゲーションまたは Credentials のセクションを使用します。

ま Credential details、Public key(s)、Client ID、およびサービスアカウントに関連するその他の情報を表示することができます。
クリックして、Adobe Target API に関する情報に移動します。図に示すように、左側のナビゲーションまたは 接続された製品とサービス セクションを使用します。
Download for Postman/Service Account (JWT) をクリックして、Postman環境の認証情報を取得する JSON ファイルを作成します。

ファイルシステムに JSON ファイルが存在することを確認します。
Postmanで、歯車アイコンをクリックして環境を管理し、「Import」をクリックして JSON ファイル（environment）を読み込みます。
ファイルを選択し、「Open」をクリックします。
Postman 環境の管理 モーダルで、新しく読み込んだ環境の名前をクリックして検査します。（お使いの環境名は、ここに示すものとは異なる場合があります。必要に応じて名前を編集します。必ずしも Adobe プロジェクトの名前と一致する必要はありません）。
メモ CLIENT_SECRET および API_KEY （および他の変数）は、Adobe Developer Consoleで定義された統合から取得され、値が事前入力されています。（Postmanの CLIENT_SECRET 変数は、Developer Consoleに表示される CLIENT SECRET Adobeの資格情報と一致する必要があります。また、Postmanの API_KEY は、Developer Consoleの CLIENT ID と同様に一致する必要があります）。これに対して、メモ PRIVATE_KEY、JWT_TOKEN、ACCESS_TOKEN は空白です。まず、PRIVATE_KEY の値を指定します。
ファイルシステムから config ファイルを開き、private key ファイルを開きます。
private キーファイルのコンテンツ全体を選択してコピーします。
Postmanで、秘密鍵の値を「INITIAL VALUE」フィールドと「CURRENT VALUE」フィールドに貼り付けます。
「Update」をクリックして、環境モーダルを閉じます。

ベアラアクセストークンの生成

この節では、Adobe Target API とのインタラクションを認証するために必要なベアラアクセストークンを生成します。ベアラーアクセストークンを生成するには、（前の節で確立された）Adobeの詳細を統合Identity Management サービス（IMS）に送信する必要があります。これを行うには、いくつかの異なる方法がありますが、このガイドでは、プロセスを直接的かつ簡単にする事前定義済みの IMS 呼び出しを含むPostman コレクションを利用します。コレクションを読み込むと、必要に応じて再利用でき、Adobe Target ーザーだけでなく他のAdobeAPI にも新しいトークンを生成できます。

AdobeIdentity Management Service API サンプル呼び出しに移動します。
Adobe I/O Access Token Generation Postman collection をクリックします。
Raw をクリックし、結果の JSON をクリップボードにコピーすることで、このコレクションの生の JSON を取得します。（または、生の JSON を.json ファイルとして保存できます。）
Postmanで、クリップボードに生の JSON を貼り付けて送信することで、コレクションを読み込みます。（または、保存した.json ファイルをアップロードできます）。 Continue をクリックします。
Adobe I/Oアクセストークン生成Postman コレクションの IMS: JWT Generate + Auth via User Token リクエストを選択し、環境が選択されていることを確認し、「Send」をクリックしてトークンを生成します。

NOTE
このベアラアクセストークンは 24 時間有効です。新しいトークンを生成する必要がある場合は常に、リクエストを再度送信します。
環境の管理モーダルを再度開き、環境を選択します。
ACCESS_TOKEN と JWT_TOKEN の値が入力されていることに注意してください。

質問：JSON web トークン（JWT）とベアラーアクセストークンを生成するには、Adobe I/Oアクセストークン生成Postman コレクションを使用する必要がありますか？

答え：いいえ。 Adobe I/Oアクセストークン生成Postman コレクションは、Postmanで JWT およびベアラーアクセストークンをより簡単に生成できる便利な機能として使用できます。または、Adobe Developer Console内の機能を使用して、ベアラアクセストークンを手動で生成することもできます。

ベアラアクセストークンのテスト

この演習では、Target アカウントからアクティビティのリストを取得する API リクエストを送信して、新しいベアラーアクセストークンを使用します。応答が成功すると、API を使用するために、Adobe プロジェクトと認証が期待どおりに動作していることが示されます。

Adobe Target Admin APIs Postman Collection を読み込みます。コレクションがPostmanに読み込まれるまで、すべてのプロンプトに従います。
コレクションを展開し、List activities リクエストをメモします。
{{access_token}} などの変数は、最初は未解決です。この問題は、いくつかの方法で解決できます。例えば、{{access_token}} という新しいコレクション変数を定義できます。ただし、このガイドでは、代わりに、API リクエストを変更して、以前に使用していたPostman環境を活用します。これにより、Adobeは、環境 API 間で共通のすべての変数を一元的かつ一貫して統合したものとして引き続き機能できます。
{{access_token}} を {{ACCESS_TOKEN}} に置き換えるためにと入力します。
{{api_key}} を {{API_KEY}} に置き換えるためにと入力します。
{{tenant}} を {{TENANT_ID}} に置き換えるためにと入力します。メモ {{TENANT_ID}} はまだ認識されていません。
環境を管理モーダルを開き、環境を選択します。
を入力して、新しい {{TENANT_ID}} 環境変数を追加します。テナント ID 値をコピーして、新しい TENANT_ID 環境変数の INITIAL VALUE および CURRENT VALUE フィールドに貼り付けます。

NOTE
テナント ID が Target clientcode と異なります。 Target にログインすると、URL 内にテナント ID が存在します。テナント ID を取得するには、Adobe Experience Cloudにログインし、Target を開いて「Target」カードをクリックします。 URL サブドメインに示されているように、テナント ID の値を使用します。例えば、Adobe Target にログインしたときの URL が <https://mycompany.experiencecloud.adobe.com/...> の場合、テナント ID は「mycompany」です。
正しい環境を選択したことを確認したら、リクエストを送信します。アクティビティのリストを含んだ応答が届きます。