iQプロファイルAPIオブジェクト
このドキュメントでは、Tealium iQプロファイルのJSON構造について説明し、プロファイル内の変数、タグ、ロードルール、拡張機能、イベント間のフィールド、構成、および関係について詳しく説明します。
利用可能なフィールド
オブジェクト | タイプ | 説明 |
---|---|---|
account |
文字列 | Tealiumアカウント名。 |
profile |
文字列 | Tealiumプロファイル名。 |
versionTitle |
文字列 | このiQプロファイルのバージョンタイトル。指定されていない場合、versionTitle はAPI | {TIMESTAMP} としてフォーマットされます。 |
version |
文字列 | このiQプロファイルのバージョンID。 |
minorVersion |
文字列 | プロファイルを保存するたびに更新されるバージョンID。保存してから公開する場合、minorVersion とversion は一致しません。Save Asを実行した場合のみ一致します。 |
parentVersion |
文字列 | save またはsaveAs 操作の元のプロファイルバージョン。 |
creation |
日付 | プロファイル作成日。 |
customTargets |
文字列 | ユーザー定義のカスタムターゲット環境のリスト。 |
versionDetails |
オブジェクト | 現在のバージョンに関する詳細情報:現在のプロファイルバージョンが公開されている場所、プロファイルを公開したユーザーのメールアドレス、プロファイルに関するメモ。 |
environmentVersions |
オブジェクト | 各環境での現在の公開プロファイルバージョンのリスト。 |
dataCloudLinkedProfiles |
文字列 | リンクされたサーバーサイドプロファイル名。 |
libraryType |
文字列 | 継承されるライブラリのタイプ。ライブラリが継承されていない場合、値はNONE です。Required - すべてのプロファイルにこのライブラリが自動的に含まれます。Optional - どのプロファイルにこのライブラリを含めるかを指定します。NONE - 指定されたプロファイルがライブラリではないことを示します。 |
linkedProfiles |
オブジェクトの配列 | ライブラリの場合、このフィールドはこのライブラリから継承される値のリストを示します。プロファイルの場合、この値はnull です。 |
linkedLibraries |
オブジェクトの配列 | プロファイルの場合、このフィールドはプロファイルにリンクされたライブラリを表します。ライブラリの場合、この値はnull です。 |
variables |
変数の配列 | プロファイル内の変数オブジェクトの配列。 |
tags |
タグの配列 | プロファイル内のタグオブジェクトの配列。 |
loadRules |
ロードルールの配列 | プロファイル内のロードルールオブジェクトの配列。 |
extensions |
拡張機能の配列 | プロファイル内の拡張機能オブジェクトの配列。 |
events |
イベントの配列 | プロファイル内のイベントオブジェクトの配列。 |
versionIds |
配列 | 以前のバージョンのリスト。 |
例
{
"account": "my_account",
"profile": "main",
"versionTitle": "Version 2022.03.22.2108",
"version": "202203222108",
"minorVersion": "202203222108",
"parentVersion": "202309191127",
"creation": "202201131654",
"customTargets": null,
"versionDetails": {},
"environmentVersions": {},
"dataCloudLinkedProfiles": "{}",
"libraryType": "NONE",
"linkedProfiles": null,
"linkedLibraries": [],
"variables": null,
"extensions": null,
"loadRules": null,
"tags": null,
"events": null,
"versionIds": null
}
変数
オブジェクト | タイプ | 説明 |
---|---|---|
id |
数値 | 変数ID。 |
uniqueIdentifier |
文字列 | 拡張機能のconditions 、タグのdataMappings 、ロードルールのconditions から変数を参照するために使用される変数識別子。 |
name |
文字列 | 変数のタイトル。 |
alias |
文字列 | 変数名。 |
type |
文字列 | 変数タイプを表すプレフィックス。ls - ローカル保存 ss - セッション保存 udo - ユニバーサルデータオブジェクトqp - クエリ文字列パラメータcp - クッキーjs - JavaScript変数meta - メタデータ要素va - AudienceStream属性 |
notes |
文字列 | 変数に関するメモ。 |
context |
配列 | AudienceStreamからインポートされた属性の範囲。 値: current_visit またはvisitor |
library |
文字列 | 変数が継承されるライブラリの名前。 |
imported |
文字列 | インポートされた変数のソース。これはすべてのAudienceStream属性に対してAudienceStream に構成されます。 |
usedIn |
オブジェクト | この変数が使用されているIDのリスト。 |
タグ
オブジェクト | タイプ | 説明 |
---|---|---|
id |
数値 | タグの一意のID。 |
tagID |
数値 | このタグタイプのシステムID。たとえば、Facebook Pixelタグの場合は6037 です。 |
name |
文字列 | タグ構成から生成されたユーザーのタグ名。 |
library |
文字列 | タグが継承されるライブラリの名前。 |
status |
文字列 | オン/オフの状態: active またはinactive 。 |
notes |
文字列 | タグに関するメモ。 |
dataMappings |
マップ<文字列, 文字列> | Tealium IQ変数とそれに対応するマップ先を返します。 |
selectedTargets |
マップ<文字列, ブール値> | タグが公開される環境のオブジェクト。 |
environmentVersions |
マップ<文字列, ブール値> | このタグが最後に公開された環境の配列。 |
advancedConfiguration |
オブジェクト | タグ構成構成に対応する高度な構成のセット。advConfigBundle — TrueまたはFalseadvConfigLoadType — TrueまたはFalseadvConfigOptOut — TrueadvConfigSend — TrueまたはFalse advConfigSrc — テキストフィールドtagTiming — DOM ReadyまたはPrioritized |
configuration |
マップ <文字列, オブジェクト> | ベンダーによって提供されるタグ構成の文字列とオブジェクトのマップ。 |
rules |
オブジェクト | 適用または除外するロードルール。 |
ロードルール
オブジェクト | タイプ | 説明 |
---|---|---|
id |
数値 | ロードルールの一意のID。 |
name |
文字列 | ロードルールの名前。 |
status |
文字列 | オン/オフの状態: active またはinactive 。 |
library |
文字列 | 関連するライブラリの名前。 |
notes |
文字列 | ロードルールに関するメモ。 |
startDate |
日付 | スケジュールされたロードルールの開始日。 |
endDate |
日付 | スケジュールされたロードルールの終了日。 |
environmentVersions |
マップ<文字列, ブール値> | 各環境での現在の公開ロードルールバージョンのリスト。 |
usedIn |
オブジェクト | このロードルールが使用されているIDのリスト。 |
conditions |
オブジェクトの配列 | 変数名、演算子、値を含むオブジェクトの配列。配列内の各オブジェクトはand 演算子で関連付けられ、配列内の各配列はor 演算子で関連付けられます。 |
拡張機能
オブジェクト | タイプ | 説明 |
---|---|---|
id |
数値 | 拡張機能の一意のIDです。 |
extensionId |
数値 | この拡張タイプのシステムIDです。この値は同じタイプのすべての拡張機能で同じです。例えば、JavaScriptコード拡張の場合は100036 です。 |
extensionType |
文字列 | この拡張タイプのシステム名です。この値は同じタイプのすべての拡張機能で同じです。例えば、JavaScriptコード拡張の場合はJavascript Code です。 |
name |
文字列 | 拡張機能の名前です。 |
library |
文字列 | 関連するライブラリの名前です。 |
notes |
文字列 | 拡張機能に入力されたメモです。 |
loadRule |
混合 | ロードルールIDのカンマ区切りリスト、またはすべてのページに対してall です。 |
scope |
文字列 | 拡張機能のスコープ名、またはタグスコープ拡張の場合はタグIDのカンマ区切りリストです。utag Sync Pre Loader Before Load Rules After Load Rules DOM Ready Tag Scoped Extensions After Tag Extensions タグスコープ拡張機能とそれがoccurrence とどのように機能するかについての詳細は、スコープの理解を参照してください。 |
occurrence |
文字列 | ページロードごとにJavaScriptコード拡張が実行される回数を決定します。値: Run Once またはRun Always 。 |
status |
文字列 | オン/オフの状態: active またはinactive 。 |
selectedTargets |
マップ<文字列, ブール> | 拡張機能が公開される環境です。 |
environmentVersions |
マップ<文字列, ブール> | 拡張機能が公開される環境の配列です。 |
conditions |
オブジェクトの配列 | 特定の拡張機能に構成された条件です。 |
configuration |
マップ <文字列, オブジェクト> | 各拡張機能の構成のマップです。 |
イベント
オブジェクト | タイプ | 説明 |
---|---|---|
id |
数値 | イベントの一意のIDです。 |
eventID |
数値 | このイベントタイプのシステムIDです。この値は同じタイプのすべてのイベントで同じです。 |
name |
文字列 | イベントの名前です。 |
status |
文字列 | オン/オフの状態: active またはinactive 。 |
eventType |
文字列 | 追跡されるイベントのタイプです。
|
scope |
文字列 | 拡張機能のスコープ名、またはタグスコープイベントの場合はタグIDのカンマ区切りリストです。After Load Rules DOM Ready タグスコープイベントについての詳細は、スコープを参照してください。 |
trackingEvent |
文字列 | イベントが発生したときに行われるイベントコールです。 |
notes |
文字列 | イベントに関するメモです。 |
library |
文字列 | 関連するライブラリの名前です。 |
eventLoadRulesList |
文字列 | イベントで使用されるすべてのロードルールのリストです。 |
eventTrigger |
オブジェクト | 各イベントタイプに特有の構成です。イベントトリガーについての詳細は、イベント > イベントトリガーを参照してください。 |
selectedTargets |
マップ<文字列, ブール> | イベントが公開される環境です。 |
environmentVersions |
マップ<文字列, ブール> | イベントが公開される環境の配列です。 |
eventVariables |
オブジェクト | 各イベントタイプに特有の変数です。 |
rules |
オブジェクト | イベントリスナーがページにロードされるタイミングを決定するルールです。 |
usedIn |
オブジェクト | このイベントが使用されているIDのリストです。 |
最終更新日 :: 2025年May月12日