イベントパラメータ
この記事では、データ変換関数の event パラメータについて説明します。
データ変換関数には event という名前のパラメータがあります。 event パラメータは、イベントを説明するいくつかのプロパティとネストされたオブジェクトを含むメタデータオブジェクトです。実際のイベントデータは event.data.udo オブジェクトで参照されます。
event パラメータオブジェクトは読み取り専用で、 event.data.udo および一部の tealium_ プロパティのカスタムイベントデータを除きます。
詳細については、イベントデータオブジェクトを参照してください。
イベントパラメータオブジェクト
event パラメータオブジェクトには以下のプロパティが含まれています:
| プロパティ | タイプ | 説明 | 書き込み可能 |
|---|---|---|---|
account |
String | アカウント情報。 | いいえ |
client_ip |
String | クライアントのIPアドレス。 | いいえ |
data |
Object | イベントデータオブジェクトを参照してください。 | いいえ |
dataSourcePlatform |
String | データソースプラットフォームの名前。 | いいえ |
enrichmentOnly |
Boolean | ライブイベントの場合は常に false。 false の場合、DataAccessが有効になり、イベントをDataAccessに送信できます。バルクインポートイベント( event.type="BULK_IMPORT" の場合)では true になる場合があります。 true の場合、イベントデータはエンリッチメントのみに使用できます。ファイルインポートイベントは現在、データ変換関数でサポートされていません。 |
いいえ |
env |
String | 実行環境(devまたはprod)を指定します。 | いいえ |
event_id |
String | イベントID。 | いいえ |
new_visitor |
Boolean | これがユーザーの最初の訪問であればTrue、そうでなければFalse。 | いいえ |
page_url |
Object | URLプロパティのオブジェクト。URLオブジェクトを参照してください。 モバイルイベントでは省略されます。 |
いいえ |
post_time |
Number | イベントのタイムスタンプ。 | いいえ |
profile |
String | アカウントのプロファイル。 | いいえ |
referrer_url |
Object | URLプロパティのオブジェクト。URLオブジェクトを参照してください。 モバイルイベントでは省略されます。 |
いいえ |
type |
String | イベントがライブ訪問からのものであるか、バルクインポートイベントからのものであるかを指定します。値は LIVE または BULK_IMPORT です。ファイルインポートイベントは現在、データ変換関数でサポートされていません。 |
いいえ |
useragent |
String | ユーザーが使用しているソフトウェアを指定します。例えば、ウェブブラウザ。 | いいえ |
visitor_id |
String | 訪問ID。 | いいえ |
_forwarding_visitor_ids |
String[] | このイベントを転送する訪問のIDを含みます。訪問のスティッチングプロセスで使用されます。 | いいえ |
データソースプラットフォームの値
dataSourcePlatform プロパティの値は次のいずれかになります: default、 adobe_launch、 affirm、 android、 braze、 cordova、 cSharp、 fileImport、 googleAMP、 google_tag_manager、 http_api_flattened、 hubspot_wf、 intercom、 iOS、 iterable、 java、 javascript、 mailchimp、 python、 RES、 roku、 salesforce、 sendgrid、 slack、 swift、 tiqJavascript、 tvOS、 watchOS、 zapier。
ファイルインポートイベントは現在、データ変換関数でサポートされていません。
イベントデータオブジェクト
event.data オブジェクトは、変換可能な event.data.udo オブジェクトを含む着信イベントを表します:
| プロパティ | タイプ | 説明 | 書き込み可能 |
|---|---|---|---|
dom |
Object | イベントが発生したページに関する情報(ドメイン、クエリストリングなど)を含みます。モバイルイベントでは省略されます。詳細については、データレイヤーを参照してください。 | いいえ |
firstparty_tealium_cookies |
Object | データレイヤーで指定されたクッキープロパティを含むオブジェクト。 モバイルイベントでは省略されます。 |
いいえ |
js |
Object | データレイヤーで指定されたJavaScript変数プロパティを含むオブジェクト。 モバイルイベントでは省略されます。 |
いいえ |
meta |
Object | データレイヤーで指定されたメタデータプロパティを含むオブジェクト。 モバイルイベントでは省略されます。 |
いいえ |
udo |
Object | 着信イベントのプロパティを含むオブジェクト。一部のプロパティは読み取り専用です。書き込み可能なプロパティを参照してください。 | はい |
書き込み可能なプロパティ
event.data.udo のすべてのカスタムイベント属性は書き込み可能ですが、 tealium_ プロパティの一部のみが変更可能です。
以下の tealium_ プロパティは変更可能ですが、削除はできません:
event.data.udo.tealium_datasourceevent.data.udo.tealium_environmentevent.data.udo.tealium_eventevent.data.udo.tealium_firstparty_visitor_idevent.data.udo.tealium_thirdparty_visitor_idevent.data.udo.tealium_library_nameevent.data.udo.tealium_library_versionevent.data.udo.tealium_randomevent.data.udo.tealium_timestamp_epochevent.data.udo.tealium_timestamp_localevent.data.udo.tealium_timestamp_utcevent.data.udo.tealium_session_number
読み取り専用のプロパティ
以下のオブジェクトプロパティは読み取り専用で、変更することはできません:
event.data.udo.tealium_cf_ttlevent.data.udo._dc_ttl_event.data.udo.platformevent.data.udo.tealium_visitor_idevent.data.udo.tealium_accountevent.data.udo.tealium_profileevent.data.udo.tealium_session_id
URLオブジェクト
URLオブジェクトには、以下の標準的なURLプロパティが含まれています:
| プロパティ | タイプ | 説明 | 書き込み可能 |
|---|---|---|---|
domain |
String | URLのドメイン。 | いいえ |
full_url |
String | 完全なURL。 | いいえ |
path |
String | URLからのパス。空の場合もあります。 | いいえ |
query_params |
Object | 1つ以上のkey.valueペアを含むオブジェクト。各キー値ペアはURLのクエリストリングを指定します。例えば:"query_params": { "utm_medium": "PPC", "utm_source": "LinkedIn" } |
いいえ |
querystring |
String | URLからのクエリストリング。 | いいえ |
scheme |
String | ウェブサイトで使用するプロトコルを指定します。例えば、HTTPまたはHTTPS。 | いいえ |
イベントパラメータオブジェクトの例
以下に event パラメータオブジェクトの例を示します:
{
"account": "XYZ_admin_acct",
"profile": "main",
"env": "prod",
"data": {
"dom": {
"url": "https://www.example.com",
"pathname": "/",
"domain": "example.com",
"hash": "",
"query_string": "",
"title": "Homepage"
},
"js": {},
"meta": {},
"udo": {
"page_view": "view",
"tealium_account": "XYZ_admin_acct",
"tealium_profile": "main",
"page_name": "Homepage",
"page_type": "main",
"tealium_event": "page_view",
"user": {
"browser_lang": "en-us",
"ipcinfo": "en-us",
"signedin": false,
"city": "san diego",
"country": "us",
"country_name": "united states",
"registry_city": "san diego",
"registry_country_code": "us",
"registry_state": "ca",
"state": "ca"
}
},
"firstparty_tealium_cookies": {
"trace_id": ""
}
},
"type": "LIVE",
"enrichmentOnly": false,
"event_id": "example-event-id",
"visitor_id": "example-visitor-id",
"post_time": 1655410928993,
"useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
"client_ip": "",
"new_visitor": false
}
最終更新日 :: 2025年January月10日