イベントコールバック event-callbacks

ビューアは、Web ページがビューアの初期化プロセスまたはランタイム動作をトラッキングするために使用するJavaScript イベントコールバックをサポートしています。

コールバックハンドラーは、handlers プロパティを持つイベント名と対応するハンドラー関数をビューアのコンストラクターのconfig JSON オブジェクトに渡すことによって割り当てられます。 または、setHandlers() API メソッドを使用することもできます。

サポートされるビューアイベントには、次のものがあります。

  • initComplete - ビューアの初期化が完了し、すべての内部コンポーネントが作成されたときにトリガーが発生します。これにより、getComponent() APIを使用できます。 コールバックハンドラーは引数を受け取りません。

  • trackEvent - Adobe Analyticsなどのイベントトラッキングシステムで処理できるビューア内でイベントが発生するたびにトリガーします。 コールバックハンドラーは次の引数を取ります。

    • objID {String}は現在使用されていません。
    • compClass {String}は現在使用されていません。
    • instName {String} イベントをトリガーしたViewer SDK コンポーネントのインスタンス名。
    • timeStamp {Number} イベントタイムスタンプ。
    • eventInfo {String} イベントペイロード。
  • quickViewActivate - ユーザーがインタラクティブスウォッチ コンポーネント内またはビデオ再生の最後に表示される「call to action」画面で、インタラクティブスウォッチをクリックまたはタップするとトリガーが発生します。 コールバックハンドラーは、次のフィールドを持つJSON オブジェクトである唯一の引数を取ります。

    • インタラクティブ スウォッチに関連付けられているsku { String} SKU値。
    • <additionalVariable> { String} 0個以上の追加変数がインタラクティブスウォッチに関連付けられています。

InteractiveVideoViewerおよびsetHandlersも参照してください。

recommendation-more-help
dynamic-media-developer-resources-help-aem-viewers-ref