Platform Web SDKの設定

SDK の設定は、configure コマンドを使用しておこないます。

重要

configure は常に、 ** と呼ばれる最初のコマンドです。

alloy("configure", {
  "edgeConfigId": "ebebf826-a01f-4458-8cec-ef61de241c93",
  "orgId":"ADB3LETTERSANDNUMBERS@AdobeOrg"
});

設定時には、さまざまなオプションを設定できます。すべてのオプションは、以下で確認できます(カテゴリ別にグループ化されています)。

一般オプション

edgeConfigId

メモ

エッジ設定は、データストリームにリブランドされました。データストリームIDは構成IDと同じです。

タイプ 必須 デフォルト値
文字列 なし

割り当てられた設定 ID。SDK を適切なアカウントと設定にリンクします。1 つのページ内で複数のインスタンスを設定する場合は、インスタンスごとに異なる edgeConfigId を設定する必要があります。

context

タイプ 必須 デフォルト値
文字列の配列 × ["web", "device", "environment", "placeContext"]

自動情報」の説明に従って、自動的に収集するコンテキストカテゴリを示します。この設定を指定しない場合、すべてのカテゴリがデフォルトで使用されます。

debugEnabled

タイプ 必須 デフォルト値
Boolean × false

デバッグが有効かどうかを示します。 この設定を true に設定すると、次の機能が有効になります。

機能 関数
コンソールログ ブラウザーの JavaScript コンソールにデバッグメッセージを表示できるようにします

edgeDomain

このフィールドにファーストパーティドメインを入力します。 詳しくは、ドキュメントを参照してください。

ドメインは、www上のWebサイトの場合はdata.{customerdomain.com}に似ています。{customerdomain.com}。

orgId

タイプ 必須 デフォルト値
文字列 なし

割り当てられたExperience Cloud組織ID。 1 つのページ内で複数のインスタンスを設定する場合は、インスタンスごとに異なる orgId を設定する必要があります。

データの収集

clickCollectionEnabled

タイプ 必須 デフォルト値
Boolean × true

リンククリック数に関連付けられたデータを自動的に収集するかどうかを示します。 詳しくは、自動リンクトラッキングを参照してください。 ダウンロード属性を含むリンクやファイル拡張子で終わるリンクは、ダウンロードリンクとしてもラベル付けされます。 ダウンロードリンク修飾子は、正規表現で設定できます。 デフォルト値は です。"\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$"

onBeforeEventSend

タイプ 必須 デフォルト値
関数 × () => 未定義

すべてのイベントに対して呼び出されるコールバックを、送信直前に設定します。 フィールド xdm を持つオブジェクトがコールバックに送信されます。送信内容を変更するには、xdmオブジェクトを変更します。 コールバック内では、 xdmオブジェクトには、イベントコマンドに渡されたデータと、自動的に収集された情報が既に含まれています。 このコールバックのタイミングと例について詳しくは、イベントのグローバルな変更を参照してください。

プライバシーオプション

タイプ 必須 デフォルト値
オブジェクト × "in"

ユーザーのデフォルトの同意を設定します。この設定は、ユーザーに対して同意設定が既に保存されていない場合に使用します。 他の有効な値は"pending""out"です。 このデフォルト値は、ユーザーのプロファイルに保持されません。 ユーザーのプロファイルは、setConsentが呼び出された場合にのみ更新されます。

  • "in":この設定を指定した場合、または値を指定しなかった場合、作業はユーザーの同意を得ずに続行されます。
  • "pending":この設定を指定した場合、作業はユーザーが同意設定を指定するまでキューに入れられます。
  • "out":この設定を指定すると、ユーザーが同意設定を指定するまで作業は破棄されます。ユーザーの環境設定を指定した後、作業を続行するか、ユーザーの環境設定に基づいて中止します。詳しくは、同意のサポートを参照してください。

パーソナライゼーションオプション

prehidingStyle

タイプ 必須 デフォルト値
文字列 × なし

パーソナライズされたコンテンツをサーバーから読み込む際に、Web ページのコンテンツ領域を非表示にする CSS スタイル定義を作成するために使用します。このオプションを指定しない場合、SDKは、パーソナライズされたコンテンツを読み込む際に、コンテンツ領域を非表示にしようとしません。その結果、「ちらつき」が発生する可能性があります。

例えば、Webページ上の要素のIDがcontainerで、パーソナライズされたコンテンツがサーバーから読み込まれる際にデフォルトコンテンツを非表示にする場合は、次の事前非表示スタイルを使用します。

  prehidingStyle: "#container { opacity: 0 !important }"

オーディエンスのオプション

cookieDestinationsEnabled

タイプ 必須 デフォルト値
Boolean × true

Audience Manager Cookieの宛先を有効にします。これにより、セグメント認定に基づいてCookieを設定できます。

urlDestinationsEnabled

タイプ 必須 デフォルト値
Boolean × true

Audience Manager URLの宛先を有効にします。これにより、セグメント認定に基づいてURLを呼び出すことができます。

ID オプション

idMigrationEnabled

タイプ 必須 デフォルト値
Boolean × true

trueの場合、SDKは古いAMCV Cookieを読み取って設定します。 このオプションは、サイトの一部で引き続きVisitor.jsを使用している間に、Adobe Experience Platform Web SDKの使用に移行する際に役立ちます。 訪問者APIがページで定義されている場合、SDKは訪問者APIに対してECIDに対してクエリを実行します。 このオプションを使用すると、Adobe Experience Platform Web SDKを使用し、同じECIDを持つページをデュアルタグ付けできます。

thirdPartyCookiesEnabled

タイプ 必須 デフォルト値
Boolean × true

アドビのサードパーティ Cookie の設定を有効にします。SDKは、訪問者IDをサードパーティのコンテキストで保持し、同じ訪問者IDをサイト全体で使用できるようにします。 複数のサイトがある場合や、パートナーとデータを共有する場合は、このオプションを使用します。ただし、プライバシー上の理由から、このオプションが望ましくない場合があります。

このページ