Web SDK の設定

最終更新日: 2023-12-06
  • トピック:
  • Web SDK
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

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

重要

configure 次に該当 常に 最初に呼び出されたコマンド。

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

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

一般オプション

edgeConfigId

メモ

Edge 設定は Datastreams に商標変更されました。 データストリーム ID は設定 ID と同じです。

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

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

context

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

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

重要

を除くすべてのコンテキストプロパティ highEntropyUserAgentHintsに設定され、デフォルトで有効になっています。 Web SDK 設定でコンテキストプロパティを手動で指定した場合、必要な情報を引き続き収集するには、すべてのコンテキストプロパティを有効にする必要があります。

有効にするには 高エントロピークライアントのヒント Web SDK のデプロイメントで、 highEntropyUserAgentHints コンテキストオプションを既存の設定と一緒に使用します。

例えば、Web プロパティから高エントロピーのクライアントヒントを取得する場合、設定は次のようになります。

context: ["highEntropyUserAgentHints", "web"]

debugEnabled

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

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

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

edgeDomain

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

ドメインは、 data.{customerdomain.com} www 上の web サイトの場合は{customerdomain.com}。

edgeBasePath

Adobe サービスとの通信およびやり取りに使用される edgeDomain の後のパス。 多くの場合、これはデフォルトの実稼動環境を使用しない場合にのみ変更されます。

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

orgId

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

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

データの収集

clickCollectionEnabled

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

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

onBeforeEventSend

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

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

onBeforeLinkClickSend

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

すべてのリンククリックトラッキングイベントに対して呼び出されるコールバックを、送信直前に設定します。 コールバックは、 xdm, clickedElement、および data フィールド。

DOM 要素構造を使用してリンクトラッキングをフィルタリングする場合、 clickElement コマンドを使用します。 clickedElement は、クリックされ、親ノードツリーをカプセル化した DOM 要素ノードです。

送信するデータを変更するには、 xdm および/または data オブジェクト。 コールバック内では、 xdm オブジェクトには、既にイベントコマンドに渡されたデータと、自動的に収集された情報が含まれています。

  • 次の値以外の値: false では、イベントの処理とコールバックの送信が許可されます。
  • このコールバックが false の値を指定した場合、エラーなしでイベントの処理が停止し、イベントは送信されません。 このメカニズムを使用すると、イベントデータを調べて false を返します。
  • コールバックで例外がスローされると、イベントの処理が停止され、イベントは送信されません。

プライバシーオプション

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

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

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

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

prehidingStyle

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

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

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

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

targetMigrationEnabled

このオプションは、 at.js を Web SDK に追加します。

Web SDK がレガシーの読み取りと書き込みを有効にするには、このオプションを使用します mbox および mboxEdgeCluster 次の条件で使用される Cookie at.js. これにより、Web SDK を使用するページから、 at.js ライブラリとその逆。

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

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

cookieDestinationsEnabled

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

有効 Audience Manager Cookie の宛先:セグメントの資格に基づいて Cookie を設定できます。

urlDestinationsEnabled

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

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

ID オプション

idMigrationEnabled

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

true の場合、SDK は古い AMCV Cookie を読み取って設定します。 このオプションは、サイトの一部で引き続き Visitor.js を使用している間に、Adobe Experience Platform Web SDK の使用に移行する際に役立ちます。

訪問者 API がページで定義されている場合、SDK は訪問者 API に対して ECID に対してクエリを実行します。 このオプションを使用すると、Adobe Experience Platform Web SDK を使用し、同じ ECID を持つページをデュアルタグ付けできます。

thirdPartyCookiesEnabled

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

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

このページ