iQ Profiles API Objects
iQ Profiles are returned as JSON objects with child objects for each type of configuration component.
Available fields
Object | Type | Description |
---|---|---|
account | String | The Tealium account name. |
profile | String | The Tealium profile name. |
versionTitle | String | The title of this version of the iQ profile. |
version | String | The version ID of this iQ profile. |
minorVersion | String | The version ID that is updated after you save a profile whether published or not. If you save and then publish, the minorVersion and version will not match. They will match only if you perform a Save As. |
creation | Date | Date of profile creation. |
customTargets | String | List of user-defined custom target environments. |
versionDetails | Object | Details about the current version including: location of where the current profile version is published to, the email of user who published the profile, and notes about the profile. |
environmentVersions | Object | List of the current published profile version for each environment. |
dataCloudLinkedProfiles | String | The linked server-side profile name. |
libraryType | String | The type of library being inherited. If no library is inherited, the value is NONE . Required - All profiles include this library automatically.Optional - You specify which profiles include this library.NONE - Indicates the given profile is not a library. |
linkedProfiles | Array[object] | For libraries, this field lists the values that the profiles inherit from this library. For profiles, this value is null . |
linkedLibraries | Array[object] | For profiles, this field represents the libraries linked to the profile. For libraries this value is null . |
variables | Array of variables | Array of variable objects in the profile. |
tags | Array of tags | Array of tags objects in the profile. |
loadRules | Array of loadrules | Array of loadrules objects in the profile. |
extensions | Array of extensions | Array of extensions objects in the profile. |
Example
{
"account": "my_account",
"profile": "main",
"versionTitle": "Version 2022.03.22.2108",
"version": "202203222108",
"minorVersion": "202203222108",
"creation": "202201131654",
"customTargets": null,
"versionDetails": {},
"environmentVersions": {},
"dataCloudLinkedProfiles": "{}",
"libraryType": "NONE",
"linkedProfiles": null,
"linkedLibraries": [],
"variables": [],
"extensions": [],
"loadRules": [],
"tags": []
}
Variables
Object | Type | Description |
---|---|---|
id | Number | Variable ID. |
uniqueIdentifier | String | Variable identifier used to refer to the variable from extension conditions , tag dataMappings , and load rule loadRuleCondition . |
name | String | The variable title. |
alias | String | The variable name. |
type | String | A prefix representing the variable type.udo - Universal Data Objectqp - Query string parametercp - Cookiejs_page - JavaScript page variablemeta - Meta data elementva - AudienceStream attribute |
notes | String | Notes about the variable. |
context | Array | The scope for attributes imported from AudienceStream. Values: current_visit or visitor |
library | String | Name of the library from which the variable is inherited. |
imported | String | The source of an imported variable. This is set to AudienceStream for all AudienceStream attributes. |
usedIn | Object | The list of IDs where this variable is used. |
Tags
Object | Type | Description |
---|---|---|
id | Number | The unique ID of the tag. |
tagID | Number | The system ID for this tag type. This value is the same for all tags of the same type. For example, 6037 for the Facebook Pixel tag. |
tagName | String | The system name for this tag type. This value is the same for all tags of the same type. For example, Facebook Pixel for the Facebook Pixel tag. |
name | String | The user generated tag name from the tag configuration. |
library | String | Name of the library from which the tag is inherited. |
status | String | The on/off status: active or inactive . |
notes | String | Notes about the tag. |
loadrule | Mixed | A comma-separated list of load rule IDs, or all for All Pages. |
loadRuleJoinOperator | String | Indicates the join operator used, if any. all — match all any — match any |
dataMappings | Map <String, String> | Returns Tealium IQ variable and its corresponding mapped destination. |
selectedTargets | Map<String, Boolean> | An object of environments where the tag is allowed to be published. |
environmentVersions | Map<String, Boolean> | An array of the environments where this tag was last published. |
advancedConfiguration | Object | A set of advanced configurations corresponding to the tag configuration settings. advConfigBundle — True or FalseadvConfigLoadType — True or FalseadvConfigOptOut — TrueadvConfigSend — True or False advConfigSrc — Text fieldtagTiming — DOM Ready or Prioritized |
configuration | Map <String, Object> | A String and Object Map of tag configurations made available by the vendor. |
template | Object | Returns the full tag template. Requires includes = tags.template in the request. |
Load rules
Object | Type | Description |
---|---|---|
id | Number | The unique ID of the load rule. |
name | String | The name of load rule. |
status | String | The on/off status: active or inactive . |
library | String | The name of the associated library. |
notes | String | Notes about the load rules. |
startDate | Date | For scheduled load rules, the start date. |
endDate | Date | For scheduled load rules, the end date. |
environmentVersions | Map<String, Boolean> | List of the current published load rule version for each environment. |
usedIn | Object | The list of IDs where this load rule is used. |
loadRuleCondition | Array[object] | An array of objects that include variable name, operator, and value. Each object within an array is associated by an and operator while each array within the array is associated by an or operator. |
Extensions
Object | Type | Description |
---|---|---|
id | Number | The unique ID of the extension. |
extensionId | Number | The system ID for this extension type. This value is the same for all extensions of the same type. For example, 100036 for the JavaScript Code extension. |
extensionType | String | The system name for this extension type. This value is the same for all extensions of the same type. For example, Javascript Code for the JavaScript Code extension. |
name | String | The name of extension. |
library | String | The name of the associated library. |
notes | String | The notes entered for the extension. |
loadRule | Mixed | A comma-separated list of load rule IDs, or all for All Pages. |
scope | String | The name of the extension scope or, for tag-scoped extensions, a comma-separated list of tag IDs. utag Sync Pre Loader Before Load Rules After Load Rules DOM Ready Tag Scoped Extensions After Tag Extensions For more information about tag-scoped extensions and how they work with occurrence , see Understanding Scope. |
occurrence | String | Determines the number of times the JavaScript code extension runs per page load. Values: Run Once or Run Always . |
status | String | The on/off status: active or inactive . |
selectedTargets | Map<String, Boolean> | Environments where the extension is allowed to be published. |
environmentVersions | Map<String, Boolean> | An array of the environments where the extension is published. |
conditions | String or Boolean | The conditions set for the specific extension. |
configuration | Map <String, Object> | A Map of configurations for each extension. |
This page was last updated: January 30, 2023