Adobe Developer Console への Campaign テクニカルオペレーターの移行
作成対象:
- 管理者
セキュリティと認証プロセスを強化する取り組みの一環として、Campaign v8.5 以降、Campaign v8 への認証プロセスが改善されています。テクニカルオペレーターは、Adobe Identity Management System(IMS)を使用して Campaign に接続できるようになりました。新しいサーバー間の認証プロセスについて詳しくは、Adobe Developer Console ドキュメントを参照してください。
テクニカルオペレーターは、API 統合用に明示的に作成された Campaign ユーザープロファイルです。この記事では、Adobe Developer Console からテクニカルオペレーターをテクニカルアカウントに移行するために必要な手順について詳しく説明します。
影響の有無
Campaign の外部システムから Campaign マーケティングインスタンスまたはリアルタイム Message Center インスタンスのいずれかに API 呼び出しを行っている場合は、以下で説明するように、Adobe Developer Console を通じてテクニカルオペレーターをテクニカルアカウントに移行する必要があります。
この変更は、Campaign v8.5 以降に適用され、Campaign v8.6 以降は 必須 となります。
移行プロセス
以下の手順に従って、Adobe Developer Console 内でテクニカルアカウントを作成し、新しく作成したアカウントを使用して、Adobe Campaign で API 呼び出しを行うすべての外部システムの認証方法を変更できるようにします。
手順の概要を以下に示します。
- Adobe Developer Console 内でのプロジェクトの作成
- 新しく作成したプロジェクトへの適切な API の割り当て
- プロジェクトへの必要な Campaign 製品プロファイルの付与
- 新しく作成したテクニカルアカウント資格情報を使用する API の更新
- Campaign インスタンスからの従来のテクニカルオペレーターの削除
移行の前提条件
Message Center インスタンスへの API 呼び出しの場合、Campaign v8.5 へのアップグレード中や、インスタンスのプロビジョニング中に製品プロファイルを作成する必要があります。この製品プロファイルの名前を以下に示します。
campaign - <your campaign instance> - messagecenter
Campaign へのユーザーアクセスに IMS ベースの認証を既に使用している場合は、API 呼び出しに必要な製品プロファイルが Admin Console 内に既に存在している必要があります。マーケティングインスタンスへの API 呼び出しに Campaign 内のカスタムオペレーターグループを使用する場合は、Admin Console 内でその製品プロファイルを作成する必要があります。
それ以外の場合は、アドビのテクニカルチームが既存のオペレーターグループとネームド権限を Admin Console 内の製品プロファイルに移行できるように、アドビトランジションマネージャーに問い合わせる必要があります。
手順 1 - Adobe Developer Console 内で Campaign プロジェクトを作成
統合は、Adobe Developer Console 内の プロジェクト の一部として作成されます。プロジェクトについて詳しくは、Adobe Developer Console ドキュメントを参照してください。
以前に作成した任意のプロジェクトを使用するか、新しいプロジェクトを作成することができます。プロジェクトを作成する手順について詳しくは、Adobe Developer Console ドキュメントを参照してください。主な手順を以下に示します
新しいプロジェクトを作成するには、Adobe Developer Console のメイン画面で「新しいプロジェクトを作成」をクリックします。
「プロジェクトを編集」ボタンを使用すると、このプロジェクトの名前を変更できます。
手順 2 - プロジェクトに API を追加
新しく作成したプロジェクト画面から、Adobe Campaign への API 呼び出しのテクニカルアカウントとしてこのプロジェクトを使用可能にするために必要な API を追加します。
プロジェクトに API を追加するには、次の手順に従います。
- 「API を追加」をクリックして、プロジェクトに追加する API を選択します。
- Adobe Campaign カードにポインタを合わせると表示される Adobe Campaign カードの右上隅にあるチェックボックスをオンして、Adobe Campaign API を選択してプロジェクトに追加します
- 画面の下部にある「次へ」をクリックします。
手順 3 - 認証タイプを選択
API を設定 画面で、必要な認証タイプを選択します。このプロジェクトには OAuth サーバー間 認証が必要です。選択されていることを確認し、画面の下部にある「次へ」をクリックします。
手順 4 - 製品プロファイルを選択
前提条件の節で説明したように、プロジェクトで使用する適切な製品プロファイルを割り当てる必要があります。この手順では、作成するテクニカルアカウントで使用する製品プロファイルを選択する必要があります。
このテクニカルアカウントを使用して Message Center インスタンスへの API 呼び出しを行う場合は、messagecenter
で終わるアドビ製品プロファイルの作成を選択する必要があります。
マーケティングインスタンスへの API 呼び出しの場合は、インスタンスとオペレーターグループに対応する製品プロファイルを選択します。
必要な製品プロファイルを選択したら、画面の下部にある「設定済み API を保存」をクリックします。
手順 5 - I/O Management API をプロジェクトに追加
プロジェクト画面で「+ プロジェクトに追加」をクリックし、画面左上の「API」を選択して、I/O Management API をこのプロジェクトに追加できるようにします。
API を追加 画面で、下にスクロールして I/O Management API カードを見つけます。これを選択するには、カードにポインタを合わせると表示されるチェックボックスをクリックします。次に、画面の下部にある「次へ」をクリックします。
API を設定 画面では、OAuth サーバー間認証が既に存在しています。画面の下部にある「設定済み API を保存」をクリックします。
これにより、新しく作成したプロジェクトの I/O Management API 内のプロジェクト画面に戻ります。画面上部のパンくずリストのプロジェクト名をクリックすると、メインのプロジェクトの詳細ページに戻ります。
手順 6 - プロジェクト設定を確認
プロジェクトを確認して、「製品とサービス」セクションに I/O Management API と Adobe Campaign API が表示され、「資格情報」セクションに OAuth サーバー間 が表示され、以下のようになっていることを確認します。
手順 7 - 設定を検証
接続を試すには、Adobe Developer Console 資格情報ガイドで説明しているアクセストークンの生成手順に従って、提供されているサンプル cURL コマンドをコピーします。これらの資格情報を使用して SOAP 呼び出しを作成し、Adobe Campaign インスタンスを正しく認証して接続できるかどうかをテストできます。サードパーティ API 統合にすべての変更を行う前に、この検証を行うことをお勧めします。
手順 8 - サードパーティ API 統合を更新
新しく作成したテクニカルアカウントを使用するには、Adobe Campaign を呼び出すすべての API 統合を更新する必要があります。
スムーズな統合のためのサンプルコードなど、API 統合手順について詳しくは、Adobe Developer Console 認証ドキュメントを参照してください。
サードパーティシステムの移行前と移行後のサンプル SOAP 呼び出しを以下に示します。
Adobe Identity Management System(IMS)認証を使用する際、WSDL ファイルを生成するには、Postman 呼び出しに Authorization: Bearer <IMS_Technical_Token_Token>
を追加する必要があります。
curl --location --request POST 'https://<instance_url>/nl/jsp/schemawsdl.jsp?schema=nms:rtEvent' \--header 'Authorization: Bearer <Technical account access token>'
移行プロセスを完了して検証すると、SOAP 呼び出しは次のように更新されます。
-
移行前:テクニカルアカウントのアクセストークンはサポートされていませんでした。
POST /nl/jsp/soaprouter.jsp HTTP/1.1 Host: localhost:8080 Content-Type: application/soap+xml; SOAPAction: "nms:rtEvent#PushEvent" charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:nms:rtEvent"> <soapenv:Header/> <soapenv:Body> <urn:PushEvent> <urn:sessiontoken>SESSION_TOKEN</urn:sessiontoken> <urn:domEvent> <!--You may enter ANY elements at this point--> <rtEvent type="type" email="name@domain.com"/> </urn:domEvent> </urn:PushEvent> </soapenv:Body> </soapenv:Envelope>
-
移行後:テクニカルアカウントのアクセストークンはサポートされます。アクセストークンは、ベアラートークンとして
Authorization
ヘッダーで提供されることが予想されます。以下の SOAP 呼び出しのサンプルに示すように、ここではセッショントークンの使用を無視する必要があります。POST /nl/jsp/soaprouter.jsp HTTP/1.1 Host: localhost:8080 Content-Type: application/soap+xml; SOAPAction: "nms:rtEvent#PushEvent" charset=utf-8 Authorization: Bearer <IMS_Technical_Token_Token> <?xml version="1.0" encoding="utf-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:nms:rtEvent"> <soapenv:Header/> <soapenv:Body> <urn:PushEvent> <urn:sessiontoken></urn:sessiontoken> <urn:domEvent> <!--You may enter ANY elements at this point--> <rtEvent type="type" email="name@domain.com"/> </urn:domEvent> </urn:PushEvent> </soapenv:Body> </soapenv:Envelope>
手順 9 -(オプション)Campaign クライアントコンソール内でテクニカルアカウントオペレーターを更新
この手順はオプションで、Message Center インスタンス内ではなく、マーケティングインスタンス内でのみ使用できます。特定のフォルダー権限またはネームド権限が、割り当てられたオペレーターグループ経由ではなくテクニカルオペレーターに対して定義されている場合。ここで、Admin Console で新しく作成したテクニカルアカウントユーザーを更新して、必要なフォルダー権限またはネームド権限を付与する必要があります。
テクニカルアカウントユーザーは、Campaign インスタンスに対して少なくとも 1 回の API 呼び出しが行われるまで、Adobe Campaign には存在しません。その時点で、IMS は Campaign 内にユーザーを作成します。Campaign 内でテクニカルユーザーが見つからない場合は、手順 7 で説明したように API 呼び出しを正常に送信できることを確認します。
-
新しいテクニカルアカウントユーザーに必要な変更を適用するには、Campaign クライアントコンソール内でメールアドレスを使用してユーザーを見つけます。このメールアドレスは、上記のプロジェクトの作成と認証の手順で作成されたものです。
このメールアドレスを見つけるには、プロジェクトの「資格情報」セクションにある「OAuth サーバー間」見出しをクリックします。
資格情報画面で、下にスクロールして テクニカルアカウントのメール を見つけて、「コピー」ボタンをクリックします。
-
ここで、Adobe Campaign クライアントコンソールで新しく作成したテクニカルオペレーターを更新する必要があります。既存のテクニカルオペレーターフォルダーの権限を新しいテクニカルオペレーターに適用する必要があります。
このオペレーターを更新するには、次の手順に従います。
- Campaign クライアントコンソールのエクスプローラーから、管理/アクセス管理/オペレーター の順に移動します。
- API に使用される既存のテクニカルオペレーターにアクセスします。
- フォルダー権限を参照し、権限を確認します。
- 新しく作成したテクニカルオペレーターに同じ権限を適用します。このオペレーターのメールアドレスは、以前にコピーした テクニカルアカウントメールアドレス の値です。
- 変更内容を保存します。
手順 10 - Adobe Campaign から古いテクニカルオペレーターを削除
IMS 認証で新しいテクニカルアカウントを使用するようにすべてのサードパーティシステムを移行したら、Campaign クライアントコンソールから古いテクニカルオペレーターを削除できます。
これを行うには、Campaign クライアントコンソールにログインし、管理/アクセス管理/オペレーター に移動し、古いテクニカルユーザーを見つけて削除します。