Tapad iOS SDK

This open source iOS library allows you to integrate Tapad features into your iOS application include iPhone, iPad and iPod touch.

Except as otherwise noted, the Tapad iOS SDK is licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html)

Getting Started

The SDK has a dependency on OpenUDID (https://github.com/ylechelle/OpenUDID). The source code of OpenUDID is included in this project and will be kept up-to-date on a weekly basis.

Setup Your Environment

• If you haven't already done so, set up your iPhone development environment by following the iPhone Dev Center Getting Started Documents.

• The projects were created with Xcode 4.2 with ARC enabled.

• Install Git.

• Pull this SDK from GitHub:

   git clone git://github.com/Tapad/tapad-ios-sdk.git
  

Event Tracking

Sample Application

This SDK comes with a sample application that demonstrates launch event tracking.

To build and run the sample application with Xcode (4.2 with ARC enabled):

• Open the included Xcode Project File by selecting File->Open... and selecting DemoApp/DemoApp.xcodeproj.

• Specify your Tapad AppId in DemoAppAppDelegate.m if available.

• Select Product->Build and then Product->Run.

• Check the output console for logging indicating that the launch tracking event was successfully sent and received.

• The launch tracking event is sent only on the first app launch. Update the preferences or Reset Content and Settings... in the iOS Simulator to enable the demo app to send it again.

Integrate With Your Own Application

To integrate the Tapad Event Tracking capability into an existing application, follow these steps:

• Copy the Tapad Event Tracking SDK into your Xcode project:

  • In Xcode, select File->Open... and select src/event-tracking/TapadEvent.xcodeproj.

  • With your own application project open in Xcode, create a group called TapadEvent and drag and drop the contents of the "TapadEvent/TapadEvent" group from the TapadEvent project into the group in your own application project.

  • With your own application project open in Xcode, create a group called OpenUDID and drag and drop the contents of the "TapadEvent/OpenUDID" group from the TapadEvent project into the group in your own application project.

  • Include the TapadEvent headers in your code:

    \#import "TapadEvent.h"
    

  • You should now be able to compile your project successfully.

Usage

With the Tapad Event Tracking SDK, you can do two main things:

• Track application install events.

• Track arbitrary events.

Initialization

Register the Tapad application ID, if available, by calling:

    [TapadEvent registerAppWithId:appId];

Where appId is your Tapad application ID string.

If not registered, the application ID on the events sent will default to CFBundleName.

Tracking Application Install Events

In "- (void)applicationDidFinishLaunching:(UIApplication *)application" of the main application delegate, add the following code:

    [TapadEvent applicationDidFinishLaunching:application];

Tracking Arbitrary Events

In the appropriate location, add the following code:

    [TapadEvent send:eventName];

Where eventName is the event type string you wish to track.

Disabling ARC Support

If your Xcode project is compiling without ARC support, please take a look at the non-ARC version of the SDK and DemoApp as provided in src/non-arc. All usages described above remain the same.

Ad Serving

Sample Application

This SDK comes with a sample application that demonstrates requesting ads from the Tapad Ad Server.

To build and run the sample application with Xcode (4.2 with ARC disabled):

• Open the included Xcode Project File by selecting File->Open... and selecting src/adserving/TapadAdSDKDemoApp-NonArc/TapadAdSDKDemoApp-NonArc.xcodeproj.

• Select Product->Build and then Product->Run.

• On launch, the app will load a 300x50 ad unit into a 50 pxl high web view.

Integrate With Your Own Application

To integrate the Tapad Ad Serving capability into an existing application, follow these steps:

• Copy the Tapad Ad SDK into your Xcode project:

  • In Xcode, select File->Open... and select src/adserving/non-arc/TapadAdSDK.xcodeproj.

  • With your own application project open in Xcode, create a group called TapadAdSDK and drag and drop the contents of the "TapadAdSDK" group from the TapadAdSDK project into the group in your own application project.

  • With your own application project open in Xcode, create a group called OpenUDID in TapadAdSDK and drag and drop the contents of the "TapadAdSDK/OpenUDID" group from the TapadAdSDK project into the group in your own application project.

  • Include the TapadAdSDK headers in your code:

    \#import "TapadAdSDK.h"
    \#import "TapadAdRequest.h"
    

  • You should now be able to compile your project successfully.

Usage

Preparing the Ad Request

Sample code with parameters for your organization will be provided upon registration with Tapad. To experiment on your own, follow these steps:

• Fetch a new ad request object with \TapadAdRequest* adRequest = [TapadAdSDK newAdRequest]

• Configure the ad server url with \adRequest.adServerUrl =

• Configure your organization id with \adRequest.publisherId =

• Configure your application id with \adRequest.propertyId =

• Configure your ad context id with \adRequest.placementId =

• Request an ad of a particular size with \adRequest.adSize =

Loading the Ad Unit

Once an ad request has been prepared, it is reusuable for fetching ads with the same configuration. The ads can be loaded in the following ways:

• Letting an UIWebView load the ad unit

  • Allocate a UIWebView with the appropriate dimensions
  • Load the prepared request with [webView loadRequest:[adRequest getRequest]]

• Synchronously load the markup data

  • Load the markup data synchronously as a string with \NSString *adData = [adRequest getAd]
  • Insert the markup data into a UIWebView with [webView loadHTMLString:adData baseURL:nil]