{"id":3009,"date":"2014-03-18T17:51:51","date_gmt":"2014-03-19T00:51:51","guid":{"rendered":"http:\/\/www.nathalielawhead.com\/candybox\/?p=3009"},"modified":"2014-03-18T17:53:59","modified_gmt":"2014-03-19T00:53:59","slug":"introduction-to-iad-in-flash-air-for-ios-kick-start-tutorial-samples","status":"publish","type":"post","link":"http:\/\/www.nathalielawhead.com\/candybox\/introduction-to-iad-in-flash-air-for-ios-kick-start-tutorial-samples","title":{"rendered":"Introduction to iAd in Flash AIR for iOS – Kick Start Tutorial & Samples"},"content":{"rendered":"

Sourcefiles for the tutorials are here<\/a>.<\/p>\n

SUMMARY<\/strong><\/p>\n

It can be very confusing to know where to start when you want to add advertisements in your Flash\/AIR based iOS app. Google search results can be ambiguous at best, and there are a number of free solutions out there, but little or no support. The most recommended pay for solution is Milkman Games\u2019s iAd for iOS<\/a> Extension. There are also a number of others (like Smaato For Android and iOS <\/a>) for pay, but I\u2019m a firm believer in that \u201cif they do it, I should be able to do it too\u201d.
\n…I’d like to make my own ANE someday. That would be so awesome.<\/p>\n

Once you find a service you will quickly figure out that relying on one ad network (like iAd) isn\u2019t enough. iAd only shows ads in specific countries, for example.
\nIf you plan to use the \u201cpay to remove ads\u201d feature, you will need to use more than one ad network. If you don\u2019t, some people will essentially get the game\/app for free.
\nTo avoid this you would need to use a number of other services. If one fails then fall back on the other \u2014 like Tapjoy<\/a>, Placeplay<\/a>, Admob<\/a>, RevMob<\/a>. Most of them provide their own AIR SDKs. Then you would have to write your own ad mediation (if iAd fails, show from other service, if that fails, show the other, if that fails have a final fallback showing something that promotes your work — a “house ad”\u2026), etc. Some SDK\u2019s will do this for you (like adwhirl<\/a>) \u2014 specify\/linkup your network (links bellow, see More iAd ane\u2019s (SDKs, etc)<\/strong>).
\nFrom what I have heard (but can\u2019t stand by because I haven\u2019t tried it) displaying ads are not the best way to generate revenue (don\u2019t base a business model on it because of those overnight success stories!). It takes a lot more effort than that.<\/p>\n

My goal for this post is to save people time, hassle, and hopefully money, by offering sourcecode samples, and a compilation of links all in one convenient place. I will continue to build on, and update, this post as I find more.<\/p>\n

RESOURCES<\/strong><\/p>\n

Documentation:<\/strong>
\nAdobe\u2019s docs for All Packages: http:\/\/www.adobe.com\/devnet-docs\/gamingsdk\/anedocs\/<\/a><\/p>\n

StageAd docs: http:\/\/www.adobe.com\/devnet-docs\/gamingsdk\/anedocs\/com\/adobe\/ane\/stageAd\/package-detail.html<\/a><\/p>\n

Adobe Gaming SDK support forum: http:\/\/forums.adobe.com\/community\/game_developers\/adobe_gaming_sdk<\/a> –If you have an issue, this is where you would search for answers (not always on Google).<\/p>\n

Getting started with Adobe Game Developer Tools<\/a><\/p>\n

It is also a good idea to browse through Apple\u2019s iAd Programming Guide: HERE<\/a>.
\nFrom what I heard (and know from their process) they have some fairly strict requirements for how you are allowed to display Ads. For example their fullscreen ads section: HERE<\/a>.
\nThis will make your app less likely to be rejected for “overlooked” reasons\u2026<\/p>\n

More Air Native Extensions:<\/strong>
\nhttp:\/\/www.as3gamegears.com\/category\/air-native-extension\/<\/a> This is one of the best places that rounds up resources for AS3. In this case it\u2019s a great collection for any App developer. Like CameraRoll<\/a>, iAd<\/a>, Ad Network<\/a>, etc\u2026 It\u2019s a very exciting summary to get you started, and will save you time.<\/p>\n

Adobe AIR Native Extensions round-up: HERE<\/a>, has some more good links to other iAd solutions.<\/p>\n

More iAd ane\u2019s (SDKs, etc):<\/strong>
\nadwhirl-flash-sdk<\/a> (An unofficial port of the Adwhirl Client SDK to Actionscript 3. Usage HERE (see first post)<\/a>. Source here: HERE<\/a>.)<\/p>\n

iad-ane-for-flash-air-mobile-ios<\/a> (A free actionscript native extension for iAd, for Flash AIR for iOS applications. Android is not supported. This air ane supports all native function, including all size type banners, interstitial, and events\u2026)<\/p>\n

adoble-flash-air-ad-network-framework<\/a> (adwhirl for actionscript. Like adwhirl, but simpler, and no need for a server. Add a variety of ad networks advertising in mobile applications. Comes with support for admob (ios, android), inmobi (ios, android), chartboost (ios, android), iad (ios) 4 ad platforms\u2026<\/p>\n

adwhirl<\/a> (Use the AdWhirl technology to display ads from different ad networks in your Android and iPhone applications. Switch ad networks on the fly, all for free. With the source code available, you can see how it all works. ) <\/p>\n

Smaato ANE<\/a> (Not free. The iOS version can be configured to show Apple iAd. If iAd fails and can\u2019t be fetched then a iSmaato banner is displayed.)<\/p>\n

Keep These Tutorials At Hand:<\/strong>
\nUsing the Game Center Adobe AIR native extensions for iOS: http:\/\/www.adobe.com\/devnet\/air\/articles\/gamecenter-ane-ios.html<\/a><\/p>\n

Getting StageAd:<\/strong><\/p>\n

You may download all the SDK\u2019s, ane\u2019s, libraries, etc. from Adobe Gaming\u2019s (very impressive & helpful) Adobe Gaming SDK: http:\/\/gaming.adobe.com\/technologies\/gamingsdk\/<\/a><\/p>\n

Once you do this you need StageAd.ane
\nIt should be provided in the \u201cNative Extensions (ANEs)<\/em>\u201d folder of Adobe Gaming SDK.
\nDocs are also provided in the \u201cDocs\u201d folder. In this case Native Extensions (ANEs)>Docs>com>adobe>ane>stageAd<\/em>\u2026<\/p>\n

Working examples are in Samples>Native Extensions (ANEs)>StageAd>src<\/em><\/p>\n

\"\"<\/p>\n

TUTORIAL<\/strong><\/p>\n

stageAd EXAMPLE<\/strong><\/em>
\nGetting StageAd Running In Flash CS6, Flash CC<\/strong><\/p>\n

Start a new AIR for iOS project.<\/p>\n

\"\"<\/p>\n

Open the Edit ActionScript<\/em> settings window. Click on the Wrench icon next to the ActionScript tab in the Properties panel.<\/p>\n

\"\"<\/p>\n

Go to the Library path tab.<\/p>\n

Select Add New Path<\/em>.<\/p>\n

\"\"<\/p>\n

Then Browse to a Native Extension (ANE)<\/em> file.<\/p>\n

\"\"<\/p>\n

Navigate to the StageAd.ane<\/em><\/p>\n

\"\"<\/p>\n

And hit OK.
\nThat\u2019s the setup\u2026<\/p>\n

Code:<\/strong><\/p>\n

Again, stageAd docs are here<\/a>.
\nThe samples given by Adobe in Samples>Native Extensions (ANEs)>StageAd>src<\/em> are more elaborate. This is a very simplified example\/walkthrough.<\/p>\n

Following is for a simple banner positioned bottom or top of the screen.<\/p>\n

<\/p>\n

\n
import<\/span> com.adobe.ane.stageAd.<\/span>*;<\/span>\r\n\r\n\/\/create an instance of a normal banner ad<\/span>\r\nvar<\/span> ad:StageBannerAd<\/span>;<\/span>\r\n\r\n\/\/HANDLERS<\/span>\r\n\r\nfunction <\/span>onActionCompleteHandler<\/span>(<\/span>event:<\/span>StageAdEvent<\/span>)<\/span>\r\n{<\/span>\r\n\r\n\ttrace<\/span>(<\/span>"Action complete handler properties:bubbles-"<\/span> +<\/span> event.<\/span>bubbles<\/span> +<\/span> "cancelable:"<\/span> +<\/span> event.<\/span>cancelable<\/span> +<\/span> "target:"<\/span> +<\/span> event.<\/span>target<\/span> +<\/span> "type:"<\/span> +<\/span> event.<\/span>type<\/span> +<\/span> "leaveApplication"<\/span> +<\/span> event.<\/span>willLeaveApplication<\/span>);<\/span>\r\n\r\n}<\/span>\r\n\r\n\r\nfunction <\/span>onAdLoadCompleteHandler<\/span>(<\/span>event:<\/span>StageAdEvent<\/span>)<\/span>\r\n{<\/span>\r\n\r\n\ttrace<\/span>(<\/span>"AD load handler properties:bubbles-"<\/span> +<\/span> event.<\/span>bubbles<\/span> +<\/span> "cancelable:"<\/span> +<\/span> event.<\/span>cancelable<\/span> +<\/span> "target:"<\/span> +<\/span> event.<\/span>target<\/span> +<\/span> "type:"<\/span> +<\/span> event.<\/span>type<\/span> +<\/span> "leaveApplication"<\/span> +<\/span> event.<\/span>willLeaveApplication<\/span>);<\/span>\r\n\r\n}<\/span>\r\n\r\nfunction <\/span>onActionStartingHandler<\/span>(<\/span>event:<\/span>StageAdEvent<\/span>)<\/span>\r\n{<\/span>\r\n\ttrace<\/span>(<\/span>"Action starting handler properties:bubbles-"<\/span> +<\/span> event.<\/span>bubbles<\/span> +<\/span> "cancelable:"<\/span> +<\/span> event.<\/span>cancelable<\/span> +<\/span> "target:"<\/span> +<\/span> event.<\/span>target<\/span> +<\/span> "type:"<\/span> +<\/span> event.<\/span>type<\/span> +<\/span> "leaveApplication"<\/span> +<\/span> event.<\/span>willLeaveApplication<\/span>);<\/span>\r\n\r\n}<\/span>\r\n\r\nfunction <\/span>onAdLoadFailHandler<\/span>(<\/span>event:<\/span>StageAdEvent<\/span>)<\/span>\r\n{<\/span>\r\n\ttrace<\/span>(<\/span>"ADLoadfail handler properties:bubbles-"<\/span> +<\/span> event.<\/span>bubbles<\/span> +<\/span> "cancelable:"<\/span> +<\/span> event.<\/span>cancelable<\/span> +<\/span> "target:"<\/span> +<\/span> event.<\/span>target<\/span> +<\/span> "type:"<\/span> +<\/span> event.<\/span>type<\/span> +<\/span> "leaveApplication"<\/span> +<\/span> event.<\/span>willLeaveApplication<\/span>);<\/span>\r\n\r\n}<\/span>\r\n\r\nfunction <\/span>onAdUnloadHandler<\/span>(<\/span>event:<\/span>StageAdEvent<\/span>)<\/span>\r\n{<\/span>\r\n\ttrace<\/span>(<\/span>"AdUnload handler properties:bubbles-"<\/span> +<\/span> event.<\/span>bubbles<\/span> +<\/span> "cancelable:"<\/span> +<\/span> event.<\/span>cancelable<\/span> +<\/span> "target:"<\/span> +<\/span> event.<\/span>target<\/span> +<\/span> "type:"<\/span> +<\/span> event.<\/span>type<\/span> +<\/span> "leaveApplication"<\/span> +<\/span> event.<\/span>willLeaveApplication<\/span>);<\/span>\r\n}<\/span>\r\n\r\n\/\/Normal advertisements<\/span>\r\nif<\/span> (<\/span>StageBannerAd.<\/span>isSupported<\/span>)<\/span>\r\n{<\/span>\r\n\r\n\tad =<\/span> new<\/span> StageBannerAd<\/span>();<\/span>\r\n\t\/\/if set to true the ad will only display once loaded<\/span>\r\n\tad.<\/span>showOnlyIfLoaded<\/span> =<\/span> false<\/span>;<\/span>\r\n\t\/\/set the stage<\/span>\r\n\tad.<\/span>stage<\/span> =<\/span> this<\/span>.<\/span>stage<\/span>;<\/span>\r\n\r\n\tad.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_ACTION_COMPLETE<\/span>,<\/span>onActionCompleteHandler);<\/span>\r\n\tad.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_ACTION_START<\/span>,<\/span>onActionStartingHandler);<\/span>\r\n\tad.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_LOAD_COMPLETE<\/span>,<\/span>onAdLoadCompleteHandler);<\/span>\r\n\tad.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_LOAD_FAIL<\/span>,<\/span>onAdLoadFailHandler);<\/span>\r\n\tad.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_UNLOAD<\/span>,<\/span>onAdUnloadHandler);<\/span>\r\n\r\n\t\/\/placement - default is bottom<\/span>\r\n\t\/\/ad.align = StageAdAlign.BOTTOM;<\/span>\r\n\t\/\/ad.align = StageAdAlign.TOP;<\/span>\r\n\r\n\t\/\/to unload set it to null<\/span>\r\n\t\/\/ad instance gets disposed once ad gets loaded on the screen and cancelled by the user<\/span>\r\n\t\/\/ad.stage = null;<\/span>\r\n\r\n\ttrace<\/span>(<\/span>"iad init"<\/span>);<\/span>\r\n\r\n}<\/span>\r\nelse<\/span>\r\n{<\/span>\r\n\r\n\ttrace<\/span>(<\/span>"StageBannerAd.isSupported=false"<\/span>);<\/span>\r\n\r\n\r\n}<\/span>\r\n<\/pre>\n<\/div>\n
To remove an ad set the instance to null: ad.stage = null;<\/em>
\nFrom what I read, you do not need to remove listeners. It gets fully disposed of once it is cancelled by the user (SOURCE<\/a>).<\/p>\n
Alternatively, this is a fullscreen ad<\/strong>:
\nIt\u2019s basically the same except you create a: var fullscreenAd:StageFullscreenAd;<\/em>
\nAnd check for:<\/p>\n
<\/p>\n
\n
var<\/span> fullscreenAd:StageFullscreenAd<\/span>;<\/span>\r\n\r\n\/\/Fullscreen advertisements from the iAd network (fullscreen ads are supported on iPad devices only). <\/span>\r\n\/\/https:\/\/developer.apple.com\/library\/ios\/documentation\/userexperience\/conceptual\/iAd_Guide\/Full-ScreenAdvertisements\/Full-ScreenAdvertisements.html<\/span>\r\n\/\/Fullscreen<\/span>\r\nif<\/span> (<\/span>StageFullscreenAd.<\/span>isSupported<\/span>)<\/span>\r\n{<\/span>\r\n\t\/\/<\/span>\r\n\tfullscreenAd=<\/span>new<\/span> StageFullscreenAd<\/span>();<\/span>\r\n\tfullscreenAd.<\/span>addToStage<\/span>();<\/span>\r\n\t\/\/<\/span>\r\n\tfullscreenAd.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_ACTION_COMPLETE<\/span>,<\/span>onActionCompleteHandler);<\/span>\r\n\tfullscreenAd.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_ACTION_START<\/span>,<\/span>onActionStartingHandler);<\/span>\r\n\tfullscreenAd.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_LOAD_COMPLETE<\/span>,<\/span>onAdLoadCompleteHandler);<\/span>\r\n\tfullscreenAd.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_LOAD_FAIL<\/span>,<\/span>onAdLoadFailHandler);<\/span>\r\n\tfullscreenAd.<\/span>addEventListener<\/span>(<\/span>StageAdEvent.<\/span>AD_UNLOAD<\/span>,<\/span>onAdUnloadHandler);<\/span>\r\n\t\/\/<\/span>\r\n}<\/span>\r\nelse<\/span>\r\n{<\/span>\r\n\ttrace<\/span>(<\/span>"stageFullscreenAd.isSupported=false"<\/span>);<\/span>\r\n}<\/span>\r\n<\/pre>\n<\/div>\n
Note that fullscreen ads are only supported on iPad<\/em>.<\/p>\n
If it\u2019s working you will see a fake \u201cwelcome\u201d ad by Apple.<\/p>\n
\"\"<\/p>\n
And that\u2019s stageAd.
\nSourcefiles here: http:\/\/nathalielawhead.com\/sourcefiles\/StageAd_iAd_WorkingExample\/<\/a><\/p>\n
iAd EXAMPLE<\/strong><\/em><\/p>\n
iAd is another one. It\u2019s free. So here it is…
\nLink: http:\/\/code.google.com\/p\/iad-ane-for-flash-air-mobile-ios\/<\/a>
\nANE here: http:\/\/code.google.com\/p\/iad-ane-for-flash-air-mobile-ios\/source\/browse\/#svn%2Ftrunk%2Fane<\/a>
\nDownload Source Here: http:\/\/nathalielawhead.com\/sourcefiles\/StageAd_iAd_WorkingExample\/iad-ane_Example\/<\/a><\/p>\n
Start a new AIR for iOS project.
\nBrowse to the ANE, as described above.<\/p>\n
Code:<\/strong><\/p>\n
<\/p>\n
\n
import<\/span> so.cuo.platform.iad.<\/span>*;<\/span>\r\n\r\nif<\/span> (<\/span>IAd.<\/span>getInstance<\/span>().<\/span>supportDevice)<\/span>\r\n{<\/span>\r\n\tIAd.<\/span>getInstance<\/span>().<\/span>showBanner(<\/span>IAd.<\/span>BANNER<\/span>,<\/span>IAdPosition.<\/span>BOTTOM_CENTER<\/span>);<\/span>\r\n}<\/span>\r\n\r\n\/\/ Check ane support. Apple does not provide Interstitial ad on iphone.;<\/span>\r\nif<\/span> (<\/span>IAd.<\/span>getInstance<\/span>().<\/span>supportDevice &&<\/span> IAd.<\/span>getInstance<\/span>().<\/span>supportedInterstitial)<\/span>\r\n{<\/span>\r\n\tIAd.<\/span>getInstance<\/span>().<\/span>addEventListener(<\/span>IAdEvent.<\/span>onInterstitialReceive<\/span>,<\/span>onAdReceived);<\/span>\r\n\tIAd.<\/span>getInstance<\/span>().<\/span>cacheInterstitial();<\/span>\r\n}<\/span>\r\n\r\nfunction <\/span>onAdReceived<\/span>(<\/span>event:<\/span>IAdEvent<\/span>)<\/span>\r\n{<\/span>\r\n\tif<\/span> (<\/span>event.<\/span>type<\/span> ==<\/span> IAdEvent.<\/span>onInterstitialReceive<\/span>)<\/span>\r\n\t{<\/span>\r\n\t\tIAd.<\/span>getInstance<\/span>().<\/span>showInterstitial();<\/span>\r\n\t}<\/span>\r\n}<\/span>\r\n<\/pre>\n<\/div>\n
Download Source Here: http:\/\/nathalielawhead.com\/sourcefiles\/StageAd_iAd_WorkingExample\/iad-ane_Example\/<\/a><\/p>\n
CONCLUSION<\/strong><\/p>\n
I wrote this walkthrough to help people starting out. I will be building on it as I find more information, and adding more examples. Perhaps this will grow into a reliable reference as things unfold.
\nHope this helps, good luck!<\/p>\n
If you found this helpful maybe you will enjoy Making an App: Adobe AIR for iOS \u2013 Flash to iOS Walkthrough<\/a>. It will guide you through the setup, and development process of an AIR app (as well as getting started with Apple Developer, certificates, etc)…<\/p>\n","protected":false},"excerpt":{"rendered":"
Sourcefiles for the tutorials are here. SUMMARY It can be very confusing to know where to start when you want to add advertisements in your Flash\/AIR based iOS app. Google search results can be ambiguous at best, and there are a number of free solutions out there, but little or no support. The most recommended pay for solution is Milkman Games\u2019s iAd for iOS Extension. There are also a number of others (like Smaato For Android and iOS ) for pay, but I\u2019m a firm believer in that \u201cif they do it, I should be able to do it too\u201d....<\/p>\n","protected":false},"author":1,"featured_media":4522,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"fifu_image_url":"","fifu_image_alt":"","footnotes":"","_links_to":"","_links_to_target":""},"categories":[12],"tags":[],"class_list":["post-3009","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-resources"],"_links":{"self":[{"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/posts\/3009","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/comments?post=3009"}],"version-history":[{"count":11,"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/posts\/3009\/revisions"}],"predecessor-version":[{"id":3020,"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/posts\/3009\/revisions\/3020"}],"wp:featuredmedia":[{"embeddable":true,"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/media\/4522"}],"wp:attachment":[{"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/media?parent=3009"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/categories?post=3009"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.nathalielawhead.com\/candybox\/wp-json\/wp\/v2\/tags?post=3009"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}