Pixel URL Macros
You can add macros as key-value pairs within a pixel URL The selection of macros available for an audience delivery depends on the delivery platform (app).
Note: The pixel URL macros refer to campaign IDs. Although campaigns are not visible in the UI, they are created internally by the platform when you deliver audiences. The platform uses campaigns to manage data delivery. Each campaign has a unique campaign ID.
Macro | Replaced by |
---|---|
$_BK_UUID
|
Obfuscated Oracle Data Cloud unique user ID (BKUUID). The BKUUID is a 16-character alphanumeric identifier that may include upper-case and lower-case letters and some special characters. For example: dXF+DNR/99YjF70X |
$_BK_UUID_NOSLASH
|
Returns the BKUUID with dashes (-) instead of slashes (/). For example: dXF+DNR-99YjF70X |
$ADID
|
The Android user's Google Advertising ID |
$CAMPAIGNS
|
The list of recently winning campaign IDs
To limit the number of items in one call, append parentheses with a number, for example: $CAMPAIGNS(5) |
$CATEGORIES
|
The list of tag category numbers matching this win
By default, items are separated by vertical bar ("|") characters. To change the separator, append square brackets with the separator character you want to use, for example: To change the separator and limit the number of items in a tag call, use the parentheses with the limit first, and then use the square brackets with the separator, for example: |
$COLO
|
Returns the ID of the co-location server that the user hits
Used only for the user data API. |
$COUNTRY_CODE_UPPER
|
The ISO 3166-1 alpha-2 country code of the user |
$DMP_Audience_Name_Macro
|
The name of the audience targeted and won |
$IDFA
|
The iOS user's identifier for advertising (IDFA) |
$LEAF_CATEGORIES
|
A list of category IDs matching the win not including parent nodes (only includes the lowest categories in the tree) This macro is otherwise the same as the $CATEGORIES macro. |
$PCATSTIME
|
The time when the data was collected on the user |
$PRICE
|
Win price |
$RAND
|
A dynamically-generated, random 32-bit unsigned integer value, which can be used to avoid browser caching ("cache busting") |
$REPEAT_VISITOR(siteID)
|
To list multiple site IDs, separate them with commas. For example ( Multiple site IDs are treated as an OR condition:
|
$TIMESTAMP
|
The current Unix time (in seconds since Jan. 1 1970 UTC) when the win occurred |
$URL_ARG(field, inDelims, outDelim, minVal, maxVal, T|R)
|
Reformatted key-value pairs (phints) in an Oracle Data Cloud tag URL or referrer URL
See $URL_ARG macro. |
$URL_ENCODED_ARG(keyName)
|
Returns the value of the named phint matching keyName in the argument passed. This macro requires the delivery and site to be owned by the same partner. For example:
Important: This macro does not work for redirects using |
$URL_ARG macro
The $URL_ARG(field, inDelims, outDelim, minVal, maxVal, T|R)
macro parses and transforms the key-value pairs (phints) in an Oracle Data Cloud tag URL or referrer URL to a new format. This macro takes the following comma-separated parameters:
Parameter | Description |
---|---|
field
|
The name of the key to be parsed and transformed. |
inDelims
|
Enter one or more delimiters in the inbound URL that you want to transform. If the key only has one value, you do not need to enter a delimiter. The following delimiters must be expressed as literal values:
|
minVal
|
Specify the range of values to be transformed and sent. For example:
|
outDelim
|
Enter the delimiter to be used in the outbound URL to separate the key's values. This outbound delimiter will replace all the delimiters you entered in the inDelims parameter. You can only enter one delimiter. If the key only has one value, do not enter a delimiter. You must enter the delimiter as a literal value. |
T | R |
Specifies from which part of the inbound request to get the attribute to be converted.
|
Examples:
URL_ARG macro | URL | Result |
---|---|---|
test, COMMA, DASH, 0, 2, R
|
http://example.com/def?test=all,that&test=jazz,plays
|
all-that-jazz |
test, UNDERSCORE|VERTBAR, COMMA, 2, 3, T
|
https://stags.bluekai.com/site/1234?ret=html&test=abc_def|xyz_pdq
|
xyz,pdq |