Declared IDs declared-ids
declared IDs の機能、セットアップ手順、コード例、変数について説明します。
Declared ID ターゲット設定 declared-id-targeting
サードパーティ cookies などの永続的ストレージメカニズムを使用しない、または使用できないデバイスやブラウザーで、Audience Manager とのユーザー ID の交換および同期をおこないます。
Declared ID ターゲティングの目的 declared-id-targeting-purpose
一部のブラウザーやほとんどのモバイルデバイスでは、サードパーティの cookies を許可していません。そのため、サイト訪問者に関する情報の保持や永続的 ID の割り当てが難しくなります。この問題を解決するため、Audience Manager では、declared IDs をイベント呼び出しで渡せるよう、DIL を使用しています。また、declared IDは、Experience Cloud のすべてのソリューションで同じユーザーに適用される汎用 ID としても機能できます。ID のターゲティング/マッチング処理を次の表で説明します。
setVisitorID
関数で宣言された ID を Adobe Experience Platform ID サービスから取得して Audience Manager に渡します。Audience Manager は、クライアントおよび訪問者 ID を、システム内の対応する ID と照合します。一致する ID が存在しなければ、Audience Manager は、新規 ID を作成してクライアントおよび訪問者 ID に関連付けます。
注意:ID が複数の Audience Manager ID にマッピングされている場合は、最新のマッピングが使用されます。
まず最初に、データ収集に使用するサイトのすべてのページに Experience Cloud ID サービスと DIL を設定する必要があります。DIL create および宣言された ID 変数を参照してください。
オプトアウト呼び出し opt-out-calls
declared ID の処理では、サイト訪問者の環境設定に従って、 によるターゲティングを Web サイトでオプトアウトすることができます。Audience ManagerAudience Manager がオプトアウトリクエストを受信すると、DCS から返される JSON には、Audience Manager ユーザー ID ではなく、エラーコード 171 と「Encountered opt out tag
」というメッセージが含まれています。
- Audience Manager では、URL で Audience Manager UUID と一緒に declared ID のオプトアウトを渡すことができます。
- declared ID オプトアウトは、パートナーごとに Profile Cache Server(PCS)に保存されます。declared IDs を使用したプラットフォームレベルのオプトアウトはありません。さらに、Audience Manager では、特定の地域からのみユーザーをオプトアウトします(オプトアウトは複数の DCS 地域をまたぐことはありません)。
データ収集のオプトアウトについて詳しくは、データのプライバシーを参照してください。
Declared ID オプトアウトの例 opt-out-examples
d_cid
および d_cid_ic
のキー値ペアを使用して、declared ID のオプトアウトリクエストをおこなうことができます。d_dpid
や d_dpuuid
などの従来のパラメーターはまだ機能しますが、既に非推奨(廃止予定)となっています。詳しくは、DPID と DPUUID に代わる CID を参照してください。以下の例で、斜体 の部分には実際の情報が入ります。
CID および CID_IC でのオプトアウト
説明と構文については、宣言された ID の URL 変数および構文を参照してください。
https://domain name/demoptout.jpg?d_cid=123%01987...
https://domain name/demoptout?d_cid_ic=456%01321...
d_cid
および d_cid_ic
のキー値ペア。https://domain name/demoptout?d_cid=123%01987&d_cid_ic=456%01321...
DPID、DPUUID、および UUIDでのオプトアウト(廃止予定)
これらの方法はまだ機能しますが、既に非推奨(廃止予定)となっています。この情報は、従来手法の参考などのために提供するものです。従来のオプトアウト方法は次のとおりです。
d_uuid
のみhttps://domain/demoptout.jpg?d_uuid=AAM ID
https://demoptout.jpg?d_dpuuid= user ID&d_dpid= data provider ID
パートナーレベルのオプトアウトは、この dpid
+ dpuuid
ペアの AAM UUID への最新マッピングに対して保存されます。既存のマッピングがなければ、Audience Manager は、リクエストの Cookie に AAM UUID が含まれているかどうかを確認し、含まれていれば、それを使用してオプトアウトを保存します。含まれていなければ、Audience Manager は新規の AAM UUID を生成し、それについてオプトアウトを保存します。
d_dpuuid
+ d_dpid
および明示的な d_uuid
https://domain/demoptout.jpg?d_uuid= user ID&d_dpuuid= data provider's user ID&d_dpid=data provider ID
d_uuid
が常に優先します。 dpid
+ dpuuid
の組み合わせが別の AAM UUID にマッピングされていても、オプトアウトは、リクエスト( d_uuid
)で渡された AAM UUID に保存されます。
Declared IDs の変数と構文 variables-and-syntax
以下の表に、Audience Manager でデータプロバイダー ID およびユーザー ID または統合コード(使用する場合)を渡すキー値ペアを示します。なお、斜体 の部分には実際の情報が入ります。読みやすくするために、スペースが追加されています。
それぞれのキー値ペアでは、以下がおこなわれます。
- キーとそれに関連する値が
=
記号で区切られます。 - 非表示ASCII文字
%01
で値が区切られます。
d_cid =data provider ID %01user ID
d_cid
は、(非推奨と見なされるが、まだサポートされている) d_dpid
および d_dpuuid
に代わるものです。詳しくは、DPID と DPUUID に代わる CID を参照してください。d_cid_ic =integration code %01user ID
d_cid_ic
は、(廃止予定だが、まだサポートされている) d_dpid
および d_dpuuid
に代わるものです。詳しくは、DPID と DPUUID に代わる CID を参照してください。サンプルイベント呼び出し sample-event-calls
これらのキー値ペアとその必須構文を仮定すると、イベント呼び出しは以下のようにおこないます。
https://domain name/event?d_cid=123%01987...
https://domain name/event?d_cid_ic=456%01321...
d_cid
および d_cid_ic
のキー値ペア。https://domain name/event?d_cid=123%01987&d_cid_ic=456%01321...
Declared ID 変数 declared-id-variables
declared IDs を DIL を通じて Audience Manager. に渡すための設定変数について説明します。
DIL は Adobe Experience Platform Identity Service を使用して Declared IDs を渡す dil-id-service-pass-declared-ids
Adobe Experience Platform ID サービスを使用する場合、非推奨(廃止予定)の dpid
変数と dpuuid
変数を使用して declared IDs を渡す必要はありません。代わりに、visitorService
関数に依存する現在のバージョンの DIL を使用して、Adobe Experience Platform Identity Service の setCustomerIDs
関数から declared IDs を取得します。詳しくは、顧客 ID と認証状態を参照してください。次のように、DIL.create
で visitorService
を呼び出します。
var vDil = DIL.create({
partner:"partner name",
visitorService:{
namespace:"INSERT-MCORG-ID-HERE"
}
});
キー値ペア namespace
で、MCORG
は Experience Cloud の組織 ID です。この ID がわからない場合、Experience Cloud ダッシュボードの「Administration」セクションで確認できます。このダッシュボードを表示するには、管理者権限が必要です。管理:コアサービスも参照してください。
非推奨(廃止予定)の関数 deprecated-functions
DIL の最新バージョン(6.2 以降)では、これらのキー値ペアを使用して declared IDs を渡す必要はありません。これは、DIL が上記のコードサンプルのように visitorService
関数を使用しているためです。この関数は Adobe Experience Platform Identity Service から declared IDs を取得します。ここでは、これらの変数を、履歴やレガシーを示す目的で参照しています。以下のコードは、DIL.create
を設定して Visitor ID Service から declared ID を取得する方法の例を示しています。次の表は、declaredId
オブジェクトで使用されるレガシー変数の一覧です。
dpid
dpuuid
DPID および DPUUID
Audience Manager は結合された DPID
と DPUUID
を、システム内の対応するユーザー ID と比較して照合します。存在しない ID がある場合、Audience Manager は新しいユーザー ID を作成し、DPID/DPUUID
の組み合わせと同期します。Audience Manager がユーザー ID(UUID
)を照合または作成すると、その ID が JSON レスポンスでクライアントのドメイン (ファーストパーティの cookie)またはその他のローカルストレージの cookie に返されます。
DIL v6.1 以前を使用している場合には、この関数を呼び出します。新しいバージョンでは Adobe Experience Platform Identity Service から declared IDs を取得するので、この関数は非推奨(廃止予定)となっています。
DIL.create({
partner : "partner name",
declaredId : {
dpuuid : dpuuid,
DPID : dpid
}
});
d_dpuuid
および d_dpid
キーの ID 値を設定するコードをプログラムによって作成する必要があります。DIL のインスタンス化の後に ID を渡す
declaredID
の組み合わせで API 呼び出しをおこなう場合、この新しい組み合わせはその呼び出しでしか使用されません。その後の通常のイベント呼び出しでは、元の DIL.create
declaredID
の組み合わせが使用されます。DIL.getDil('partner name').api.signals({...}).declaredId({
dpuuid : dpuuid
dpid : dpid
}).submit();
リクエストとレスポンスの例 request-response-examples
次のリクエストはデータプロバイダー ID とユーザー ID を Audience Manager に送信します。:
https://my_domain.net/event?d_rtbd=json&d_cb=myCallback&key=val&d_dpuuid=1234&d_dpid=5678
次のレスポンスでは、Audience Manager ID(UUID
など)が返され、ページドメインのファーストパーティ Cookie に書き込まれます。
myCallback({
...
"uuid":"abc123"
})
ターゲティングからの除外 do-not-target
declared ID の処理では、サイト訪問者の環境設定に従って、 によるターゲティングを Web サイトでオプトアウトすることができます。Audience ManagerAudience Manager がオプトアウトリクエストを受け取ると、DCS は Audience Manager ユーザー ID ではなく空の JSON オブジェクトを返します。