1.0.2 • Published 4 years ago

@ff0000-ad-tech/cs-plugin-msnbc-apple-news v1.0.2

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago
RED Interactive Agency - Ad Technology

npm (tag) GitHub issues npm downloads

GitHub contributors GitHub commit-activity npm license PRs Welcome

Creative Server Plugin - Apple News Responsive Ad Builder

This plugin is to assist with building ads to deploy on Apple News. This means that they must resize to the size associated with the Apple device and orientation defined by the Apple News HTML spec.

There are two main Apple News sizes: the Double Banner and the Large Banner.

For both, you would choose two sizes to designate as either the Landscape or Portrait creative.

Then the Apple News ad will use the size appropriate for the given device and orientation.

Important Notes

  • If asked to built another Apple News creative, may be worth building out a size per device instead of just one creative that responds to every listed size
    • then having the parent index choose among a given size instead of just landscape or portrait, like it's currently doing
  • When asked to make a specific size for Apple News (e.g. 1242x699 for Large Banners on iPhones 6-8), be sure to build it to the dimension in points
    • so for the 1242x699 size, build it in 414x233 instead b/c those are the dimensions of the iframe on that particular form factor

How It Works

The ad's main index.html has an iframe that renders the appropriate size creative based on the device (iPhone 5, 6, X, etc.) and orientation (i.e. landscape vs. portrait).

To enable clickthrough on iOS apps such as the Apple News app, we need to use an <a> with the href set to the clickthrough URL. The parent window has a message listener that waits for data that looks something like this:

{
	// key-value pair this index uses to update clickTag
	type: 'UPDATE_CLICKTAG', 
	// URL to set clickTag to
	message: 'http://msnbc.com/something'
}

In the Apple News Responsive Build Source (TODO), a postClickTagURL() function exists within the index.html which gets called in AdData.js. In AdData, you can call postClickTagURL() with the dynamic clickTag URL you need.

Usage

  • In the Creative Server root interface: 1. Select the two sizes you'll need for your responsive creative (e.g. 1242x699 and 2208x699 for the Large Banner's portrait and landscape orientations, respectively) 1. In the Plugins dropdown, select MSNBC Apple News and hit the 🔥
  • On the plugin page: 1. Fill out the fields and choose the appropriate sizes for the landscape/portrait orientations 1. Hit Render Ad when ready 1. You will get a prompt telling you that the ads have been built successfully 1. files will be in the _apple-news-output directory of project root - note about underscore in directory name: not having the underscore will cause a nested Creative Server to pop up