at.js カスタムイベント

最終更新日： 2025年5月5日
  • トピック：

作成対象：

  • 開発者

mbox リクエストまたはオファーの失敗や成功を把握するための at.js custom events について説明します。

これまで、mbox.js （現在は非推奨）は、ページ上で実行される他のJavaScript コードに、バックグラウンドで何が起こるかを知らせませんでした。 at.js の改良により、この問題を独自の方法で解決することができました。

当社のお客様によれば、次のような場合に通知が必要になります。

  • タイムアウト、ステータスコードの誤り、JSON 解析エラーなどの理由で mbox リクエストが失敗した。
  • mbox リクエストが成功した。
  • ラッピング mbox 要素が欠落している、セレクターがないなどの理由でオファーのレンダリングが失敗した。
  • オファーのレンダリングが成功した。DOM の変更が適用されました。

事前定義されたイベントの構造は、イベントのタイプに基づいて必要なデータを抽出できるようになっています。

イベントを様々なシナリオで使用できるようにするため、カスタムイベントにはペイロードオブジェクトがあります。このオブジェクトは（ハンドラーに渡される）イベントオブジェクトの詳細プロパティに割り当てられます。また、文字列をイベント名として渡さないようにするため、イベントは adobe.target.event 名前空間を使用して定数として公開されます。

構造

キータイプ説明
type文字列

at.js とのインタラクションの追跡、デバッグ、カスタマイズに役立つ通知を受け取るシナリオには、様々なものが考えられます。

以下の各カスタムイベントには、「定数」と「文字列値」の 2 つの形式があります。

  • 定数： 先頭に adobe.target.event. が追加されます。すべて大文字で記述され、アンダースコア文字が含まれます。at.js の読み込みの​ 後 ​から、mbox の応答の​ 前 ​までの間にカスタムイベントをサブスクライブする場合は、定数を使用します。
  • 文字列値： 小文字で記述され、ダッシュが含まれます。at.js の読み込みの​ 前 ​にカスタムイベントをサブスクライブする場合は、文字列値を使用します。

Request Failed

定数：adobe.target.event.REQUEST_FAILED

文字列値：at-request-failed

説明：タイムアウト、ステータスコードの誤り、JSON 解析エラーなどの理由で mbox リクエストが失敗しました。

Request Succeeded

定数：adobe.target.event.REQUEST_SUCCEEDED

文字列値：at-request-succeeded

説明：mbox リクエストが成功しました。

Content Rendering Failed

定数：adobe.target.event.CONTENT_RENDERING_FAILED

文字列値：at-content-rendering-failed

説明：ラッピング mbox 要素が欠落している、セレクターがないなどの理由でオファーのレンダリングが失敗しました。

Content Rendering Succeeded

定数：adobe.target.event.CONTENT_RENDERING_SUCCEEDED

文字列値：at-content-rendering-succeeded

説明：オファーのレンダリングが成功した。DOM の変更が適用されました。

Library Loaded

定数：adobe.target.event.LIBRARY_LOADED

文字列値：at-library-loaded

説明：このイベントは、at.js が完全に読み込まれたタイミングを追跡する場合に最適です。このイベントを使用してグローバル mbox の実行をカスタマイズできます。グローバル mbox を無効にしてから、このイベントをリッスンして後でグローバル mbox を呼び出すこともできます。

Request Start

定数：adobe.target.event.REQUEST_START

文字列値：at-request-start

説明：このイベントは、HTTP リクエストの実行前に発生します。このイベントは、Resource Timing API によるパフォーマンス計測に使用できます。

Content Rendering Start

定数：adobe.target.event.CONTENT_RENDERING_START

文字列値：at-content-rendering-start

説明：このイベントは、セレクターポーリングが開始され、コンテンツがページにレンダリングされる前に発生します。このイベントを使用して、コンテンツのレンダリングの進捗状況を追跡できます。

Content Rendering No Offers

定数：adobe.target.event.CONTENT_RENDERING_NO_OFFERS

文字列値：at-content-rendering-no-offers

説明：このイベントは、オファーが返されなかったときに発生します。

Content Rendering Redirect

定数：adobe.target.event.CONTENT_RENDERING_REDIRECT

文字列値：at-content-rendering-redirect

説明：このイベントは、オファーがリダイレクトであり、別の URLTarget リダイレクトされる場合に発生します。

mbox文字列mbox 名
message文字列人間が解読可能な説明（何が起こったか、エラーメッセージの内容など）。
トラッキングオブジェクトsessionId と deviceId が格納されます。場合によっては、deviceId が Target を取得できないため、この値が欠落することがあります。
type文字列

オンデバイス判定アーティファクトが成功しました

定数：

adobe.target.event.ARTIFACT_DOWNLOAD_SUCCEEDED

文字列値：artifactDownloadSucceeded

説明：オンデバイス判定アーティファクトが正常にダウンロードされたときに呼び出されます。

オンデバイス判定アーティファクトが失敗しました

定数：adobe.target.event.ARTIFACT_DOWNLOAD_FAILED

文字列値：artifactDownloadFailed

説明：オンデバイス判定アーティファクトのダウンロードに失敗した場合に呼び出されます。

使用方法

document.addEventListener(adobe.target.event.REQUEST_SUCCEEDED, function(event) {
  console.log('Event', event);
});

トレーニングビデオ：応答トークンと at.js カスタムイベント チュートリアルバッジ

次のビデオでは、応答トークンと at.js カスタムイベントを使用して、Target ーザーからサードパーティシステムにプロファイル情報を共有する方法を説明します。

前のページsendNotifications() - at.js 2.1
次のページAdobe Experience Cloud デバッガーを使用した at.js のデバッグ

Target