Adobe Target APIの認証の設定

Recommendations Admin APIを含むAdobe Target Admin APIは、認証によって保護され、許可されたユーザーのみがAdobe Targetにアクセスするようにします。 Adobe開発者コンソールを使用して、Targetを含むすべてのAdobe Experience Cloudソリューションでこの認証を管理します。

このレッスンでは、Adobe Target APIとのやり取りに必要な認証トークンを生成するために必要な事前の手順について説明します。 以降の節では、以下をおこないます。

  1. プロジェクト開発者コンソールでプロジェクト(旧称「Adobe」)を作成します。
  2. プロジェクトの詳細をPostmanに書き出します。
  3. bearerアクセストークンを生成します。
  4. bearerアクセストークンをテストします。

前提条件

リソース 詳細
郵便配達人 これらの手順を正しく完了するには、お使いのオペレーティングシステム用のPostmanアプリを入手します。 Postman basicは、アカウントの作成を無料で行います。 Adobe Target APIを一般的に使用するために必須ではありませんが、PostmanはAPIワークフローを容易にします。Adobe Targetは、APIの実行とその動作の学習に役立つ、複数のPostmanコレクションを提供します。 このチュートリアルの残りの部分は、Postmanに関する実務知識を前提としています。 サポートが必要な場合は、Postmanのドキュメントを参照してください。
参照 このチュートリアルの残りの部分では、次のリソースに関する知識が前提となります。

Adobe I/Oプロジェクト

この節では、Adobe開発者コンソールにアクセスし、Adobe Targetのプロジェクトを作成します。 詳しくは、プロジェクトのドキュメントを参照してください。

  1. Adobe Admin Consoleで、Adobeユーザーアカウントに製品管理者開発者の両方のレベルでTargetへのアクセス権が付与されていることを確認します。

  2. Adobe開発者コンソールで、この統合を作成するExperience Cloud組織を選択します。 (1つのExperience Cloud組織にのみアクセスできる可能性があります)。

    configure-io-target-createproject2.png

  3. 新しいプロジェクトを作成」をクリックします。

    configure-io-target-createproject3.png

  4. APIを追加」をクリックして、Adobe サービスと製品にアクセスするためのREST APIをプロジェクトに追加します。

    APIを追加

  5. 統合先のAdobe サービスとして​Adobe Target​を選択します。 表示される「次へ」ボタンをクリックします。

    configure-io-target-createproject5

  6. 公開鍵と秘密鍵を、Target用に作成するサービスアカウント統合に関連付けるオプションを選択します。 このチュートリアルでは、オプション1を選択します。キーペア​を生成し、キーペアを生成​をクリックします。
    configure-io-target-createproject6

  7. 結果をメモしておきます。 指示に従って、自動的にダウンロードされた設定ファイル(config)をメモします。このファイルには、秘密鍵が含まれています。 「次へ」をクリックします。
    configure-io-target-createproject7

  8. ファイルシステムで、前の手順で作成した圧縮設定ファイルのconfigの場所を確認します。 このconfigファイルには秘密鍵が含まれていますが、後で必要になります。 ファイルシステム内の正確な場所は、次に示す場所とは異なる場合があります。
    configure-io-target-createproject8

  9. Adobe開発者コンソールに戻り、Recommendationsを使用しているプロパティに対応する製品プロファイルを選択します。 (プロパティを使用しない場合は、「デフォルトのワークスペース」オプションを選択します)。 「設定済みAPIを保存」をクリックします。
    configure-io-target-createproject9

  10. 統合を作成」をクリックします。 APIが正常に設定されたことを示す一時的なメッセージが表示されます。

  11. 最後の手順として、プロジェクトの名前を元のProject 1よりも意味のある名前に変更します。 それには、図のようにナビゲーションパスを使用してプロジェクトに移動し、「プロジェクトを編集」をクリックして「**プロジェクトを編集」モーダルにアクセスし、プロジェクトの名前を変更します。

configure-io-target-createproject11

メモ

このチュートリアルでは、プロジェクトに「Target統合」という名前を付けます。 Adobe Target以外の用途でプロジェクトを使用することを想定している場合は、それに応じて名前を付けることができます。 例えば、Adobe Experience Cloudの他のソリューションで使用できるので、「AdobeAPI」または「Experience CloudAPI」という名前を選択できます。

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

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

Postmanでプロジェクトの詳細を指定する方法は多数ありますが、この節では、事前に作成された機能とコレクションを利用します。 まず、(この節の)統合の詳細をPostman環境に書き出します。 次に(次の節で)、必要なAdobeリソースへのアクセスを許可するbearerアクセストークンを生成します。

メモ

Targetを含む、あらゆるExperience Cloudソリューションに適用できるビデオ手順については、 PostmanとExperience PlatformAPIの使用を参照してください。 以下の節は、Target APIに関連しています。

  1. PostmanへのAdobe I/O統合の詳細の書き出し
  2. Postmanでのアクセストークンの生成

これらの手順も以下に示します。

  1. 引き続きAdobeデベロッパーコンソールで、新しいプロジェクトの​サービスアカウント(JWT)​資格情報に移動して表示します。 図のように、左側のナビゲーションまたは​Credentials​セクションを使用します。
    JWT1
    秘密鍵証明 書の詳細​で、公開鍵 、クライアントID 、およびサービスアカウントに関連するその他の情報を確認できます。
    JWT1a

  2. Adobe Target APIに関する情報に移動するには、をクリックします。 図のように、左側のナビゲーションまたは​Connected products and services​セクションを使用します。
    JWT2

  3. Postmanのダウンロード / サービスアカウント(JWT)​をクリックして、Postman環境の認証情報をキャプチャするJSONファイルを作成します。
    JWT3
    :ファイルシステムにJSONファイルが記録されます。
    JWT3a

  4. Postmanで、歯車アイコンをクリックして環境を管理し、「読み込み」をクリックしてJSONファイル(環境)を読み込みます。
    JWT4

  5. ファイルを選択し、「開く」をクリックします。
    JWT5

  6. ポストマン​環境の管理​モーダルで、新しく読み込んだ環境の名前をクリックして検査します。 (環境名は、ここに示す名前とは異なる場合があります。 必要に応じて名前を編集します。 必ずしもAdobeプロジェクトの名前と一致する必要はありません)。
    JWT6

  7. (他の変数と共に) CLIENT_SECRETAPI_KEYには、Adobe開発者コンソールで定義したとおり、統合から取得した値が事前に設定されていることに注意してください。 (Postman CLIENT_SECRET変数は、開発者コンソールに表示されるCLIENT SECRETAdobeの秘密鍵証明書と一致する必要があります。PostmanのAPI_KEYも、開発者コンソールのCLIENT IDと同じく一致する必要があります。) これに対して、PRIVATE_KEYJWT_TOKENACCESS_TOKENは空白です。 まず、PRIVATE_KEY値を指定します。
    JWT7

    メモ

    驚き!

    ポップクイズ! 秘密鍵がどこにあるか覚えてる?
    そうです、Adobe開発者コンソールからダウンロードしたconfigファイル内にあります。

  8. ファイルシステムからconfigファイルを開き、privateキーファイルを開きます。
    JWT8

  9. privateキーファイルの内容全体を選択してコピーします。
    JWT9

  10. Postmanで、秘密鍵の値を​INITIAL VALUE​フィールドと​CURRENT VALUE​フィールドに貼り付けます。
    JWT10

  11. 更新」をクリックし、環境モーダルを閉じます。

bearerアクセストークンの生成

この節では、Adobe Target APIとのインタラクションを認証するために必要なbearerアクセストークンを生成します。 bearerアクセストークンを生成するには、(前の節で確立した)統合の詳細をAdobeIdentity Managementサービス(IMS)に送信する必要があります。 これをおこなう方法はいくつかありますが、このチュートリアルでは、IMS APIに対するカスタムPOSTリクエストを作成します。 冗談だ。 このチュートリアルでは、プロセスを直接簡単にする、事前にビルドされたIMS呼び出しを含むPostmanコレクションを活用します。 コレクションを読み込むと、必要に応じて再利用し、Adobe Targetだけでなく他のAdobeAPI用にも新しいトークンを生成できます。

  1. AdobeIdentity ManagementサービスAPIのサンプル呼び出しに移動します。
    token1

  2. Adobe I/Oアクセストークン生成ポストマン」コレクション​をクリックします。
    token2

  3. Raw​をクリックし、結果のJSONをクリップボードにコピーして、このコレクションの生のJSONを取得します。 (または、生のJSONを.jsonファイルとして保存することもできます)。
    token3

  4. Postmanで、生のJSONを貼り付けてクリップボードから送信し、コレクションを読み込みます。 (または、保存した.jsonファイルをアップロードすることもできます)。 「続行」をクリックします。
    token4

  5. IMSを選択します。JWTAdobe I/Oアクセストークン生成ポストマンコレクションの「ユーザートークン​を介して+認証を生成」リクエストで、環境が選択されていることを確認し、「送信」をクリックしてトークンを生成します。

    token5

    メモ

    このbearerアクセストークンは24時間有効です。 新しいトークンを生成する必要が生じたらいつでも、リクエストを再度送信します。

  6. 環境の管理モーダルをもう一度開き、環境を選択します。
    token6

  7. ACCESS_TOKENJWT_TOKENの値が設定されていることに注意してください。
    token7

メモ

Q:JSON Webトークン(JWT)とbearerアクセストークンを生成するには、Adobe I/Oアクセストークン生成ポストマンコレクションを使用する必要がありますか?

回答:いや! Adobe I/Oアクセストークン生成Postmanコレクションは、PostmanでJWTおよびbearerアクセストークンをより簡単に生成できる便利な方法として利用できます。 または、Adobe開発者コンソール内の機能を使用してbearerアクセストークンを手動で生成できます。

bearerアクセストークンのテスト

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

  1. Adobe Target Admin APIのPostman Collectionを読み込みます。 Postmanにコレクションが読み込まれるまで、すべてのプロンプトに従います。
    testtoken1

  2. コレクションを展開し、リストアクティビティ​リクエストをメモします。
    testtoken1

  3. {{access_token}}などの変数は、最初は未解決です。 この問題を解決する方法はいくつかあります。例えば、{{access_token}}という新しいコレクション変数を定義できますが、このチュートリアルでは、代わりにAPIリクエストを変更して、以前使用していたPostman環境を活用します。 これにより、環境は、AdobeAPI間で共通するすべての変数を1つの一貫した統合として引き続き機能します。
    testtoken2

  4. {{access_token}}{{ACCESS_TOKEN}}に置き換えるには、と入力します。
    testtoken3

  5. {{api_key}}{{API_KEY}}に置き換えるには、と入力します。
    testtoken4

  6. {{tenant}}{{TENANT_ID}}に置き換えるには、と入力します。 {{TENANT_ID}}はまだ認識されていません。
    testtoken4

  7. 環境の管理モーダルを開き、環境を選択します。
    JWT11

  8. 新しい{{TENANT_ID}}環境変数を追加するには、と入力します。 新しいTENANT_ID環境変数の​INITIAL VALUE​フィールドと​CURRENT VALUE​フィールドにテナントID値をコピーして貼り付けます。

    testtoken5

    メモ

    テナントIDがTarget clientcodeと異なります。 Targetにログインすると、URLにテナントIDが存在します。 テナントIDを取得するには、Adobe Experience Cloudにログインし、Targetを開いてTargetカードをクリックします。 URLサブドメインで指定されているテナントID値を使用します。

    例えば、Adobe Targetにログインした際のURLが

    <https://mycompany.experiencecloud.adobe.com/...>

    テナントIDが「mycompany」になります。

  9. 正しい環境を選択したことを確認した後、リクエストを送信します。 アクティビティのリストを含む応答を受け取ります。
    testtoken6

おめでとう! これで、Adobe認証を確認したので、Adobe Target API(および他のAdobeAPI)とやり取りするために使用できます。 例えば、Recommendations APIを使用して、レコメンデーションを作成または管理できます。

このページ