イベント転送での秘密鍵の設定

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

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

秘密鍵タイプ 説明
トークン 両方のシステムで認識および理解されている認証トークン値を表す単一の文字列。
HTTP ユーザー名とパスワードの 2 つの文字列属性がそれぞれ含まれます。
OAuth2 OAuth2 認証仕様をサポートする複数の属性を含んでいます。必要な情報を入力すると、指定した間隔でトークンの更新を行います。現在、OAuth2 のクライアント認証情報バージョンのみがサポートされています。

このガイドでは、データ収集 UI でイベント転送(Edge)プロパティのシークレットを設定する方法の概要を説明します。

メモ

秘密鍵の構造の JSON の例など、Reactor API で秘密鍵を管理する方法に関するガイダンスについて詳しくは、秘密鍵 API ガイドを参照してください。

前提条件

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

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

秘密鍵の作成

シークレットを作成するには、データ収集 UI にログインし、シークレットを追加するイベント転送プロパティを開きます。次に、左側のナビゲーションで「シークレット」 を選択し、「新しいシークレットの作成」を選択します。

新しいシークレットの作成

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

メモ

秘密鍵を環境に追加する前に作成して保存する場合は、残りの情報を入力する前に、「秘密鍵を環境に添付」トグルを無効にします。シークレットを使用する場合は、後で環境に割り当てる必要があります。

環境の無効化

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

環境と名前

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

環境の追加

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

環境を追加できません

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

トークン

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

トークンシークレット

HTTP

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

メモ

認証情報は、保存時に、基本「HTTP 認証スキーム」を使用してエンコードされます。

HTTP シークレット

OAuth2

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

OAuth2 シークレット

認証情報オプション」で、scopeaudience などの他の認証情報オプションをキーと値のペアの形式で提供できます。キーと値のペアを追加するには、「さらに追加」を選択します。

認証情報オプション

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

オフセットの更新

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

重要

OAuth 秘密鍵は、4 時間以上の更新間隔、8 時間以上の有効期限が必要です。この制限により、生成されたトークンで問題が発生した場合に介入するための時間が 4 時間以上確保されます。

例えば、オフセットが 28800(8 時間)に設定されていて、アクセストークンの expires_in36000(10 時間)の場合、差分が 4 時間未満となるため、交換は失敗します。

終了したら、「秘密鍵の作秘」を選択し、秘密鍵を保存します。

OAuth2 オフセットの保存

秘密鍵の編集

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

編集する秘密鍵を選択

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

秘密鍵の編集

メモ

秘密鍵が既存の環境に関連付けられている場合、その秘密鍵を別の環境に再割り当てすることはできません。異なる環境で同じ認証格情報を使用する場合は、代わりに新しい秘密鍵を作成する必要があります。この画面から環境を再割り当てできるのは、以前に秘密鍵を環境に割り当てたことがない場合、または秘密鍵が添付されていた環境を削除した場合のみです。

秘密鍵の交換の再試行

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

秘密鍵タイプ 再試行プロトコル
トークン 秘密鍵の交換」を選択し、秘密鍵の交換を再試行します。このコントロールは、秘密鍵に接続された環境がある場合にのみ使用できます。
HTTP 秘密鍵に接続された環境がない場合は、「秘密鍵の交換」を選択し、認証情報を base64 に交換します。環境が添付されている場合は、「次を選択」を選択します。 Exchange と Deploy の秘密鍵 を使用して base64 と交換し、秘密鍵をデプロイします。
OAuth2 トークンの生成」を選択して認証情報を交換し、認証プロバイダーからアクセストークンを返します。

秘密鍵の削除

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

秘密鍵の削除

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

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

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

データ要素

メモ

開発環境、ステージング環境、実稼動環境に関連付けられた秘密鍵のみが、それぞれのドロップダウンに表示されます。

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

複数の秘密鍵を持つ秘密鍵データ要素

メモ

データ要素を作成する場合は、開発環境を割り当てる必要があります。ステージング環境と実稼動環境の秘密鍵は必須ではありませんが、これらの環境に移行しようとするビルドは、その秘密鍵タイプのデータ要素秘密鍵する環境用に選択された秘密鍵がない場合、失敗します。

次の手順

このガイドでは、データ収集 UI での秘密鍵の管理方法について説明しました。Reactor API を使用して秘密鍵を操作する方法については、秘密鍵エンドポイントガイドを参照してください。

このページ