イベント転送でのシークレットの設定

イベント転送では、秘密鍵は別のシステムの資格情報を表すリソースであり、データの安全な交換を可能にします。秘密鍵は、イベント転送プロパティ内でのみ作成できます。

現在、次の秘密鍵タイプがサポートされています。

このガイドでは、Experience Platform UI または Data Collection UI でイベント転送（Edge）プロパティのシークレットを設定する方法の概要を説明します。

前提条件

このガイドは、UI でタグやイベント転送のリソースを管理する方法（データ要素やイベント転送ルールの作成方法など）を既に熟知していることを前提としています。概要については、リソースの管理に関するガイドを参照してください。

また、タグとイベント転送の公開フロー（ライブラリにリソースを追加する方法や、テスト用に web サイトにビルドをインストールする方法など）についての実用的な理解が必要です。詳しくは、公開の概要を参照してください。

秘密鍵の作成 create

シークレットを作成するには、左側のナビゲーションで「Event Forwarding」を選択し、シークレットを追加するイベント転送プロパティを開きます。 次に、左側のナビゲーションで「Secrets」を選択し、次に「Create New Secret」を選択します。

次の画面では、シークレットの詳細を設定できます。シークレットをイベント転送で使用できるようにするには、シークレットを既存の環境に割り当てる必要があります。イベント転送プロパティ用に環境が作成されていない場合は、続行する前に環境に関するガイドを参照して、環境の設定方法を確認してください。

「Target Environment」の下で、ドロップダウンメニューを使用して、シークレットを割り当てる環境を選択します。 「Secret Name」の下で、環境のコンテキストで秘密鍵の名前を指定します。 この名前は、イベント転送プロパティの下にあるすべての秘密鍵に対して一意である必要があります。

シークレットは、一度に 1 つの環境にのみ割り当てることができますが、必要に応じて、異なる環境の複数のシークレットに同じ資格情報を割り当てることができます。Add Environment を選択して、別の行をリストに追加します。

追加する環境ごとに、関連付けられたシークレットに別の一意の名前を指定する必要があります。使用可能なすべての環境を使い切ってしまうと、「Add Environment」ボタンは使用できなくなります。

ここからシークレットを作成する手順は、作成するシークレットのタイプによって異なります。詳しくは、以下のサブセクションを参照してください。

Token token

トークンシークレットを作成するには、「Token」ドロップダウンから「Type」を選択します。 表示される Token フィールドに、認証先のシステムで認識される資格情報文字列を入力します。 「Create Secret」を選択して、シークレットを保存します。

HTTP http

HTTP シークレットを作成するには、Simple HTTP ドロップダウンから「Type」を選択します。 下に表示されるフィールドに、資格情報のユーザー名とパスワードを入力した後、「Create Secret」を選択してシークレットを保存します。

OAuth 2 oauth2

OAuth2 シークレットを作成するには、OAuth 2 ドロップダウンから「Type」を選択します。 以下に表示されるフィールドに、Client ID、Client Secret および OAuth 統合の Token URL を入力します。 UI の Token URL フィールドは、認証サーバーホストとトークンパスを連結したものです。

Credential Options では、scope や audience などの他の資格情報オプションをキーと値のペアの形式で提供できます。 キーと値のペアを追加するには、「Add another」を選択します。

最後に、秘密鍵の Refresh Offset 値を設定できます。 これは、トークンの有効期限が切れる前に、システムが自動更新を実行する秒数を表します。同等の時間（時間と分）がフィールドの右側に表示され、入力中に自動で更新されます。

例えば、更新オフセットがデフォルト値の 14400（4 時間）に設定されていて、アクセストークンの expires_in 値が 86400（24 時間）の場合、システムは 20 時間で自動的に秘密鍵を更新します。

終了したら、「Create Secret」を選択して秘密鍵を保存します。

OAuth 2 JWT oauth2jwt

OAuth 2 JWT 秘密鍵を作成するには、OAuth 2 JWT ドロップダウンから「Type」を選択します。

以下に表示されるフィールドに、Issuer、Subject、Audience、Custom Claims、TTL を入力し、ドロップダウンから Algorithm を選択します。 次に、Private Key Id と、OAuth 統合の Token URL を入力します。 Token URL フィールドは必須フィールドではありません。 値を指定すると、JWT がアクセストークンと交換されます。 秘密鍵は、応答の expires_in 属性と Refresh Offset 値に従って更新されます。 値を指定しない場合、エッジにプッシュされる秘密鍵は JWT です。 TTL と Refresh Offset の値に従って JWT が更新されます。

Credential Options の下に、キーと値のペアの形式で jwt_param すなど、他の資格情報オプションを提供できます。 キーと値のペアを追加するには、「Add another」を選択します。

最後に、秘密鍵の Refresh Offset 値を設定できます。 これは、トークンの有効期限が切れる前に、システムが自動更新を実行する秒数を表します。同等の時間（時間と分）がフィールドの右側に表示され、入力中に自動で更新されます。

例えば、更新オフセットがデフォルト値の 1800 （30 分）に設定されていて、アクセストークンの expires_in 値が 3600 （1 時間）の場合、システムは 1 時間で自動的に秘密鍵を更新します。

終了したら、「Create Secret」を選択して秘密鍵を保存します。

Google OAuth 2 google-oauth2

Google OAuth2 シークレットを作成するには、Google OAuth 2 ドロップダウンから「Type」を選択します。 「Scopes」で、この秘密鍵を使用してアクセスを許可するGoogle API を選択します。 現在、次の製品がサポートされています。

終了したら「Create Secret」を選択します。

秘密鍵を Google で手動で認証する必要があることを示すポップオーバーが表示されます。「Create & Authorize」を選択して続行します。

Google アカウントの資格情報を入力するためのダイアログが表示されます。画面の指示に従い、選択したスコープでイベント転送にデータへのアクセスを許可します。認証プロセスが完了すると、シークレットが作成されます。

LinkedIn OAuth 2 linkedin-oauth2

LinkedIn OAuth2 シークレットを作成するには、LinkedIn OAuth 2 ドロップダウンから「Type」を選択します。 次に、「Create Secret」を選択します。

秘密鍵を LinkedIn で手動で認証する必要があることを示すポップオーバーが表示されます。 「Create & Authorize secret with LinkedIn」を選択して続行します。

LinkedIn 資格情報を入力するように求めるダイアログが表示されます。 画面の指示に従い、イベント転送にデータへのアクセスを許可します。

認証プロセスが完了すると、「Secrets」タブに戻り、新しく作成した秘密鍵を確認できます。 ここでは、秘密鍵のステータスと有効期限の日付を確認できます。

LinkedIn OAuth 2 秘密鍵の再認証

重要

365 日ごとに、LinkedIn 資格情報を使用して再認証する必要があります。 時間内に再認証しない場合、秘密鍵は更新されず、LinkedIn のコンバージョンリクエストは失敗します。

再認証が必要な秘密鍵の 3 か月前に、プロパティの任意のページを移動すると、ポップアップが表示され始めます。 Click here to go to your secrets を選択します。

「Secrets」タブにリダイレクトされます。 このページにリストされている秘密鍵は、再認証する必要がある秘密鍵のみを表示するようにフィルタリングされます。 再認証する必要がある秘密鍵の Auth Needed を選択します。

LinkedIn 資格情報を入力するよう求めるダイアログが表示されます。 画面の指示に従って、秘密鍵を再認証します。

Amazon OAuth 2 amazon-oauth2

Amazon OAuth2 シークレットを作成するには、Amazon OAuth 2 ドロップダウンから「Type」を選択します。 次に、「Create Secret」を選択します。

秘密鍵を Amazon で手動で認証する必要があることを示すポップオーバーが表示されます。 「Create & Authorize secret with Amazon」を選択して続行します。

Amazon 資格情報を入力するように求めるダイアログが表示されます。 画面の指示に従い、イベント転送にデータへのアクセスを許可します。

認証プロセスが完了すると、「Secrets」タブに戻り、新しく作成した秘密鍵を確認できます。 ここでは、秘密鍵のステータスと有効期限の日付を確認できます。

秘密鍵の編集

プロパティの秘密鍵を作成したら、Secrets ワークスペースに一覧表示されます。 既存の秘密鍵の詳細を編集するには、リストから名前を選択します。

次の画面では、秘密鍵の名前と資格情報を変更できます。

秘密鍵の交換の再試行

編集画面から秘密鍵の交換を再試行または更新できます。このプロセスは、編集する秘密鍵のタイプによって異なります。

秘密鍵の削除

Secrets ワークスペースで既存の秘密鍵を削除するには、名前の横にあるチェックボックスを選択してから、Delete を選択します。

イベント転送での秘密鍵の使用

イベント転送で秘密鍵を使用するには、まず秘密鍵自体を参照するデータ要素を作成する必要があります。データ要素を保存した後、それをイベント転送ルールに含め、それらのルールをライブラリに追加できます。ライブラリは、ビルドとしてアドビのサーバーにデプロイできます。

データ要素を作成するときは、Core 拡張機能を選択してから、データ要素タイプとして Secret を選択します。 右側のパネルが更新され、データ要素に最大 3 つの秘密鍵を割り当てるためのドロップダウンコントロールが提供されます。それぞれ Development、Staging および Production 用です。

複数の秘密鍵を 1 つのデータ要素に割り当ててルールに含めることで、含まれるライブラリが公開フローのどこにあるかに応じて、データ要素の値を変更できます。

次の手順

このガイドでは、UI でのシークレットの管理方法について説明しました。Reactor API を使用してシークレットを操作する方法については、シークレットエンドポイントガイドを参照してください。