adinfo

Welcome to our newly overhauled Zephyr pages! See our new Overview, Examples, and Index.
Feedback is welcome at bottom of each page.

Description

Returns meta information about an Ad Targeter ad placement

 object adinfo( string zonename )

Given a zone name, returns a data structure containing information about the Ad Targeter banner scheduled that particular zone, Ad Plan, and day of send.

Will return nullif no banner has been scheduled in that particular zone on that particular day, or if no Ad Plan has been set.

The data contained in the structure is as follows:

Field Description Example
width Width of the banner 300
height Height of the banner 200
image Relative path to the banner image 1/1jv/3/i/4d839f79d5d25.gif
advertiser Name of the advertiser Acme Inc
description Description of the banner Explosive tennis balls
url URL that the banner clicks through to http://acme.example.com/explosive-tennis-balls" title="http://acme.example.com/explosive-tennis-balls" rel="nofollow">http://acme.example.com/explosive-tennis-balls
zone_name Name of the zone that the banner belongs to top banner
vars Custom vars attached to the banner {"metadata":"here"}

Example

To include more information about your Ad Targeter ad in a template, such as description and advertiser name.

This script uses the ad() function to render an ad image from an Ad Targeter ad plan, which is created and scheduled in the Ad Targeter page. Additionally, it uses adinfo() to pull in the description and advertiser name, allowing for a more descriptive ad experience.

Zephyr:

{{ad('top banner')}}
{adinfo("top banner").description} by our friends at {adinfo("top banner").advertiser}!

Output:

<img src="http://example.com/ads/image.png">
Great advertisement by our friends at Sailthru!

Display Additional Content with Ad

Use Case: Include more information about your Ad Targeter ad in a template, such as its description and advertiser name.

Zephyr:

{{ad('top banner')}}
{adinfo("top banner").description} by our friends at {adinfo("top banner").advertiser}!

In Ad Targeter:
zephyr example upload banner desktop size target everyone

Output:

zephyr example sailthru logo square
Great advertisement by our friends at Sailthru!

Explanation:

This script uses the ad() function to render an ad image from an Ad Targeter ad plan, which is created and scheduled in the Ad Targeter page. Additionally, it uses adinfo() to pull in the description and advertiser name, allowing for a more descriptive ad experience.

Top