iQ Profiles APIオブジェクト
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": "バージョン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 、およびロードルールのloadRuleCondition から変数を参照するために使用される変数識別子です。 |
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 です。 |
tagName |
文字列 | このタグタイプのシステム名です。この値は、同じタイプのすべてのタグに対して同じです。たとえば、Facebook Pixelタグの場合はFacebook Pixel です。 |
name |
文字列 | タグ構成から生成されたユーザー生成のタグ名です。 |
library |
文字列 | タグが継承されるライブラリの名前です。 |
status |
文字列 | オン/オフのステータス: active またはinactive 。 |
notes |
文字列 | タグに関するノートです。 |
loadRule |
混合 | ロードルールIDのカンマ区切りリスト、またはすべてのページの場合はall 。 |
loadRuleJoinOperator |
文字列 | 使用されている結合演算子を示します。 all — すべてに一致 any — いずれかに一致 |
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のリストです。 |
loadRuleCondition |
オブジェクトの配列 | 変数名、演算子、値を含むオブジェクトの配列です。配列内の各オブジェクトはand 演算子によって関連付けられ、配列内の各配列はor 演算子によって関連付けられます。 |
拡張機能
オブジェクト | タイプ | 説明 |
---|---|---|
id |
数値 | 拡張機能の一意のIDです。 |
extensionId |
数値 | この拡張機能タイプのシステムIDです。この値は、同じタイプのすべての拡張機能に対して同じです。たとえば、JavaScriptコード拡張機能の場合は100036 です。 |
extesnionType |
文字列 | この拡張機能タイプのシステム名です。この値は、同じタイプのすべての拡張機能に対して同じです。たとえば、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のリストです。 |
最終更新日 :: 2024年March月29日