イベントと訪問関数 V2 | イベントとビジター関数

Action V2ランタイムは廃止され、サポートされていません。V2ランタイムを使用する関数はまだ実行されていますが、コードの変更を保存することはできません。コードの変更を保存するには、ランタイムバージョンを更新する必要があり、これには関数コードの変更が必要になる場合があります。必要なコード変更については、V2関数をV3ランタイムに移行するを参照してください。

新しい関数はデフォルトでV3ランタイムを使用します。詳細については、イベントと訪問関数 V3を参照してください。

名前付きエクスポート

Tealiumモジュールは、イベントと訪問関数のために5つの名前付きエクスポートを提供します：auth、event、visitor、store、およびtealium。関数は次のようにこれらの名前付きエクスポートをインポートします：

import { auth, visitor, event, store, tealium } from "tealium";

Authオブジェクト: auth.get()

イベントと訪問関数は、FacebookやGoogleなどの一部のサービスプロバイダにアクセスするために認証を必要とします。詳細については、関数に認証を追加するを参照してください。認証を追加すると、アクセストークンが返されます。

アクセストークンはauth.get()メソッドに渡され、HTTPリクエストで使用できる認証のIDを返します。

パラメータ	データ型	説明
authName	string	認証の名前を指定します。これは、関数に認証が追加されたときに入力された名前です。

Eventオブジェクト

eventオブジェクトは、関数がイベントフィードによってトリガーされたときに利用可能で、イベントデータを含みます。

プロパティ	データ型	説明
`event.id`	string	TealiumイベントID。
`event.visitor_id`	string	Tealium訪問ID。
`event.account`	string	Tealiumアカウント。
`event.profile`	string	Tealiumプロファイル。
`event.data`	object	イベント属性データを含むオブジェクト。例：`event.data.udo.page_category`や`event.data.udo.order_id`。
`function getAttributeNameById(id)`	string	指定した属性の名前を含む文字列を返します。`id`は属性IDを指定する文字列です。
`function getAttributeValueById(id)`	any	指定した属性の値を返します。`id`は属性IDを指定する文字列です。

Eventオブジェクトの例

以下にイベントオブジェクトデータの例を示します：

{
  "account": "your-account",
  "profile": "main",
  "event_id": "run-test-event-id",
  "visitor_id": "run-test-visitor-id",
  "data": {
    "dom": {
      "viewport_height": 766,
      "referrer": "",
      "viewport_width": 1440,
      "domain": "www.example.com",
      "title": "Home Page",
      "query_string": "q=help",
      "hash": "",
      "url": "https://www.example.com/?q=help",
      "pathname": "/"
    },
    "udo": {
      "tealium_event": "page_view",
      "ut.account": "your-account",
      "ut.visitor_id": "0176cb4f3482110a5ba4702e147b0006d005a065104f2",
      "page_name": "Home Page",
      "ut.event": "view",
      "search_keyword": "help",
      "ut.domain": "example.com",
      "tealium_profile": "main",
      "ut.version": "ut4.46.202006020705",
      "tealium_session_id": "1609910608323",
      "tealium_account": "your-account",
      "ut.profile": "main",
    },
    "firstparty_tealium_cookies": {
      "utag_main__sn": "12",
      "utag_main_dc_visit": "12",
      "utag_main_ses_id": "1609910610822",
      "utag_main_dc_region": "us-east-1",
      "utag_main__st": "1609913306118",
      "utag_main_v_id": "0176cb4f3482110a5ba4702e147b0006d005a065104f2",
      "utag_main__se": "66",
      "utag_main__ss": "0",
      "utag_main_dc_event": "60",
      "utag_main__pn": "5"
    }
  },
  "env": "prod",
  "post_time": 1537305808000
}

イベントデータは、関数内で以下のようにアクセスできます：

const data = {};
    // DOM変数はevent.domに格納されています
    data.current_url = event?.dom?.url;
    // 標準のUDOイベント変数はevent.data.udoに格納されています
    data.session_id = event?.data?.udo?.tealium_session_id;
    // First Party cookiesはevent.firstparty_tealium_cookiesに格納されています
    data.trace_id = event?.firstparty_tealium_cookies?.trace_id;
    // メタ変数はevent.metaに格納されています
    data.meta_description = event?.meta?.description;
    data.tealium_event = event?.data?.udo?.tealium_event;
    data.tealium_account = event?.data?.udo?.tealium_account;
    data.tealium_profile = event?.data?.udo?.tealium_profile;

Storeオブジェクト: store.get()

storeオブジェクトは、キー/値のペア（グローバル変数と呼ばれます）を格納するために使用され、複数の関数でデータを共有するために使用できます。キーは変数の名前です。値は数値または文字列の定数であることができます。関数のコードエディタのCodeタブでグローバル変数を追加、編集、削除することができます。関数はグローバル変数の値を取得することができますが、変更することはできません。

V2関数は、store.get()メソッドを呼び出し、キーをパラメータとして渡すことで、キーの値を取得することができます。

パラメータ	データ型	説明
globalParameterKey	string	取得するグローバル変数のキーを指定します。

グローバル変数の追加、編集、使用についての詳細は、グローバル変数の管理を参照してください。

Tealiumオブジェクト: sendCollectEvent()

sendCollectEvent()メソッドは、イベントをTealium Collect HTTP APIに送信し、文字列を返します。

パラメータ	データ型	説明
event	EventsClientEventObject	Tealium Collect HTTP APIに送信するイベントオブジェクト。
account	string	任意。指定された場合、event.tealium_accountの値を置き換えます。
profile	string	任意。指定された場合、event.tealium_profileの値を置き換えます。
dataSourceId	string	任意。指定された場合、event.tealium_datasourceの値を置き換えます。

Tealium Collect HTTP APIのResponseインターフェースは、リクエストへのレスポンスを表します。Responseモデルはfetch APIと同じですが、結果からURLはcollectクライアントで利用できません。

Visitorオブジェクト

visitorオブジェクトは、関数がオーディエンスフィードによってトリガーされたときに利用可能で、訪問データを含みます。

プロパティ	データ型	説明
`visitor.metrics`	Record<string, number>	訪問のメトリクス。
`visitor.metrics_sets`	Tally<string, number>
`visitor.dates`	Record<string, number>	訪問の日付。
`visitor.audiences_joined_at`	Record<string, number>	訪問がオーディエンスに参加したタイムスタンプ。
`visitor.properties`	Record<string, any>	訪問のプロパティ。
`visitor.properties.account`	string	Tealiumアカウント。
`visitor.properties.profile`	string	Tealiumプロファイル。
`visitor.properties.visitor_id`	string	Tealium訪問ID。
`visitor.property_sets`	Set<string, any>
`visitor.audiences`	string[]	参加したオーディエンスのリスト。
`visitor.badges`	string[]	バッジのリスト。
`visitor.creation_ts`	number	訪問の作成タイムスタンプ。
`visitor.flags`	Map<string, Boolean>
`visitor.current_visit`	Record<string, any>	現在の訪問オブジェクト。
`visitor.current_visit.metrics`	Record<string, number>	現在の訪問のメトリクス。
`visitor.current_visit.metrics_sets`	Tally<string, number>
`visitor.current_visit.dates`	Record<string, number>	現在の訪問の日付。
`visitor.current_visit.properties`	Record<string, any>	現在の訪問のプロパティ。
`visitor.current_visit.flags`	Map<string, Boolean>	現在の訪問のフラグ。
`visitor.current_visit.property_sets`	Set<string, any>	現在の訪問のプロパティセット。
`visitor.current_visit.creation_ts`	number	現在の訪問の作成タイムスタンプ。
`visitor.current_visit.total_event_count`	number	現在の訪問の総イベント数。
`visitor.current_visit.events_compressed`	boolean	現在の訪問のイベントが圧縮されているかどうか。
`function getAttributeNameById(id)`	string	指定した属性の名前を含む文字列を返します。`id`は属性IDを指定する文字列です。
`function getAttributeValueById(id)`	any	指定した属性の値を返します。`id`は属性IDを指定する文字列です。

訪問オブジェクトの例

以下は訪問オブジェクトデータの例です：

{
  "metrics": {
    "Metric 1": 1,
    "Metric 2": 2
  },
  "dates": {
    "Date 1": 1603373790000,
    "Date 2": 1603373522000,
  },
  "properties": {
    "profile": "username",
    "visitor_id": "017560818b67001bc185a07f1cd703078003405000b7e",
    "account": "user-account",
  },
  "audiences": [
    "Audience 1",
    "Audience 2"
  ],
  "badges": [
    "Badge 1",
    "Badge 2"
  ],
  "creation_ts": 1603373522000,
  "current_visit": {
    "metrics": {
      "Metric 1": 1.3,
      "Metric 2": 6,
    },
    "dates": {
      "Date 1": 1603373868000,
      "Date 2": 1603373790000,
    },
    "properties": {
      "Property 1": "Chrome",
      "Property 2": "https://URL-for-website ",
    },
    "flags": {
      "Flag 1": true,
      "Flag 2": false
    },
    "property_sets": {
      "Property Set 1": [
        "Mac desktop"
      ],
      "Property Set 2": [
        "Chrome"
      ]
    },
    "creation_ts": 1603373790000,
    "total_event_count": 2,
    "events_compressed": false
  },
  "audiences_joined_at": {
    "Audience 1": 1603363523014,
    "Audience 2": 1603363523014
  }
}