オプトインのカテゴリー
訪問者のオプトインの環境設定は Adobe Experience Cloud ソリューションとは相対的で、各ソリューションがカテゴリーとして表されます。カテゴリーは adobe.OptInCategories オブジェクトで指定されます。例えば、ECID コンポーネントは adobe.OptInCategories となります。ECIDをインストールします。以下は、adobe.OptInCategories の定義です。
オプトインの設定は、カテゴリーごとに管理されます。ここでは、各 Experience Cloud ソリューションはカテゴリーで表されます。
adobe.OptInCategories = {
AAM: "aam",
TARGET: "target",
ANALYTICS: "aa",
ECID: "ecid",
};
オプトインサービスにより、サイトで使用されるアドビソリューションごとに訪問者の権限設定を設定できます。このオブジェクトでは、承認済みのカテゴリーごとに訪問者の設定を保存するライブラリが用意されており、承認プロセスで各カテゴリーの「確認」または「拒否」設定を 1 つずつ受け取るシーケンシャルフローがサポートされています。複数のソリューション（カテゴリー）をまとめてオプトインするか、個別のソリューションとしてオプトインするかを設定できます。
アドビソリューションのクライアント側ライブラリはすべて、オプトインサービスに依存しており、ソリューションに権限が付与されない限り Cookie を生成しません。オプトインでは、現在の訪問者の同意設定をさまざまな方法で指定および更新できます。このセクションでは、オプトインサービスの設定例を示します。機能とパラメーターのリストについては、オプトイン API リファレンスを参照してください。
オプトインサービスの設定は、グローバルな getInstance() オブジェクトをインスタンス化する Visitor JS adobe 関数で指定します。以下に、オプトインサービス用の Visitor JS 設定を示します。
グローバルな Visitor オブジェクトの初期化におけるオプトインの設定例
// FORMAT: Object<adobe.OptInCategories enum: boolean>
var preOptInApprovalsConfig = {};
preOptInApprovals[adobe.OptInCategories.ANALYTICS] = true;
// FORMAT: Object<adobe.OptInCategories enum: boolean>
// If you are storing the OptIn permissions on your side (in a cookie you manage or in a CMP),
// you have to provide those permissions through the previousPermissions config.
// previousPermissions will overwrite preOptInApprovals.
var previousPermissionsConfig = {};
previousPermissionsConfig[adobe.OptInCategories.AAM] = true;
previousPermissionsConfig[adobe.OptInCategories.ANALYTICS] = false;
Visitor.getInstance("YOUR_ORG_ID", {
"doesOptInApply": true, // NOTE: This can be a function that evaluates to true or false.
"preOptInApprovals": preOptInApprovalsConfig,
"previousPermissions": previousPermissionsConfig,
"isOptInStorageEnabled": true
});
同意に対する変更の処理
訪問者は、サイトに滞在している間はいつでも、初めて環境設定を行ったり、CMP を使用して環境設定を変更したりできます。 初期設定で訪問者 JS を初期化したら、訪問者の権限を変更できます。 同意を管理するための関数の一覧については、同意の変更を参照してください。
オプトインワークフロー
オプトインサービスでは、複数回のリクエストサイクルで権限を収集でき、環境設定が 1 つずつおこなわれるワークフローがサポートされています。以下の関数を使用して に trueshouldWaitForComplete を指定すると、ソリューションでは、1 つのソリューションまたは全カテゴリーのサブセットに対する同意を収集してから、次のソリューションまたは全カテゴリーの別のサブセットに対する同意を収集することができます。最初の呼び出しから、フローの最後に adobe.optIn.status が呼び出されるまで、プロパティは 保留adobe.optIn.complete()になります。この呼び出し後、ステータスは complete に設定されます。
adobe.optIn.approve(['AAM', 'ECID'], true);
adobe.optIn.deny(['ANALYTICS'], true);
adobe.optIn.complete();
ワークフローの設定を参照してください。
訪問者のオプトイン権限の確認
訪問者が自身の権限を変更した場合は、変更後の権限を調査して、オプトインサービスでおこなわれた変更を同意ストアと同期する必要があります。権限関数を使用して、訪問者の環境設定を調べます。次に例を示します。
fetchPermissions サンプル
optIn.fetchPermissions(function (permissions) {
// Here you can check if your category has been approved or not.
// We recommend using optIn.isApproved() to check for permissions because it abstracts out the details of knowing exactly how the permissions list looks like.
if (adobe.optIn.isApproved(MY_CATEGORY) {
sendBeacon(); // Or something
}
});
OR: You can pass in shouldAutoSubscribe as true, your callback will be used to subscribe to all OptIn events going forward:
function callback() {
if (adobe.optIn.isApproved(MY_CATEGORY) {
sendBeacon(); // Or something
}
}
optIn.fetchPermissions(callback, true);
これらおよびこのドキュメントに記載されているあらゆる関数、プロパティ、設定の詳細については、API ドキュメントを参照してください。
訪問者の設定の保存
オプトインサービスでは、開発環境や CRM を使用できない環境に適した同意設定を保存することができます。isOptInStorageEnabled 設定プロパティを true として指定すると、オプトインサービスにより、ドメイン内の訪問者のシステムに Cookie が作成されます。
adobe.optIn オブジェクトはステートレスであり、保存メカニズムは備えていません。カスタムデータの保存が許可されている場合は、代わりに、既存の同意管理プラットフォーム（CMP）でアドビの同意設定を管理することを目的しています。 または、訪問者の環境設定を訪問者のブラウザー上の Cookie に保存できます。 オプトインサービスにユーザーの環境設定を指定する方法は 2 つあります。
- CMP か訪問者のブラウザーの Cookie かに関わらず、同意保持ソリューションで訪問者の設定をタイムリーに取得できる場合は、Visitor の初期化中にこれらの設定をオプトインサービスに指定できます。
- ただし、取得プロセスに時間がかかる場合や、非同期プロセスとして最善の役割を果たしている場合には、サービスの
approve()関数を使用して、読み込みに成功したときにこれらの設定を指定できます。