Appendix D - Pulse Macros

What Are Pulse Macros?

Pulse macros are placeholders and used to add information to third party tags and external tracking links in the Pulse UI. Pulse macros are resolved into values when the third party tags and external tracking links are added to an ad response. Many of the Pulse macros depend on the ad request itself, which means that a macro can resolve into different values for different ad requests.

The main use case of Pulse Macros is to enable the ad ops to send data from Pulse and the client-side integration to third parties without doing additional integrations. This also enables better workflows for the ad ops as it usually decreases the number of different tags in use.

Where to Use Pulse Macros?

How to Use Pulse Macros?

You would like to send impression tracking events to a third party and to correlate the data to your video assets, you want to send in the ID of the asset and the duration of the asset. To achieve this, create an external impression tracking link with the ${content.id} and ${content.duration} macros:

http://funkyclip.com/track?event=imp&id=${content.id}&duration=${content.duration}

The ${content.id} and ${content.duration} macros resolve into the asset's ID and duration, respectively, when used in an ad response. If the asset's id is sunday_night_football and it's duration is 1320 seconds, the link above resolves into this link when used in an ad response:

http://funkyclip.com/track?event=imp&id=sunday_night_football&duration=1320

URL Encoding in Pulse Macros

The encoding functions can be used inside any tag that you want to URL encode, for example ${urlenc(tags)} or ${urlenc(request.referrerurl)}. For example:

http://funkyclip.com/track?event=imp&ref=${urlenc(tags)}

If the content item is tagged with this tag abcdefghijklmnopqrstuvwxyzåäö (Swedish alphabet) the link above would resolve into this when used in an ad response:

http://funkyclip.com/track?event=imp&ref=abcdefghijklmnopqrstuvwxyz%C3%A5%C3%A4%C3%B6

They can also be used to encode random parts of a URL with the pattern ${urlenc(WORD)} where WORD is a set of characters, for example:

http://funkyclip.com/track?event=${urlenc(görüntüleme)} 

(görüntüleme is Turkish for viewing)

The link above resolves into this when used in an ad response:

http://funkyclip.com/track?event=g%C3%B6r%C3%BCnt%C3%BCleme

For more information, see http://en.wikipedia.org/wiki/Percent-encoding.

Pulse Macro Reference

Content Macros

Content macros carry metadata about the content item. The content item is the clip or video that is being monetised. The combined monetisation of a viewing of a content item by an end-user is called an ad session.

Request macros

Request macros carry general information about the ad request.

All ad requests made for a viewing of a content item by an end-user are called an ad session. All ad requests in an ad session use the same ticked id.

Campaign macros

Campaign macros carry information about the campaign that the ad is a part of.

* Universally unique identifier: http://en.wikipedia.org/wiki/Universally_unique_identifier.

Goal macros

Goal macros carry information about the goal that the ad is a part of.

* Universally unique identifier: http://en.wikipedia.org/wiki/Universally_unique_identifier.

Ad macros

Ad macros carry information about the ad that the end-user sees.

* Universally unique identifier: http://en.wikipedia.org/wiki/Universally_unique_identifier.

Helper macros

Helper macros are convenience macros that try to remove friction in third party integrations.

Custom macros

Deprecated Macros

The following macros are still available, but it is not recommended to use them, because they may be unaccessible in the future.