Latest 1.0.3
Homepage https://github.com/satishbabariya/SwiftyAd
License MIT
Platforms ios 9.0
Frameworks UIKit
Authors

CI Status
Version
License
Platform

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

Installation

SwiftyAd is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod 'SwiftyAd'
import SwiftyAd
  • Setup up the helper with your AdUnitIDs as soon as your app launches e.g AppDelegate or 1st ViewController.
SwiftyAd.shared.setup(
      withBannerID:    "Enter your real id or leave empty if unused", 
      interstitialID:  "Enter your real id or leave empty if unused", 
      rewardedVideoID: "Enter your real id or leave empty if unused"
)
  • To show an Ad call these methods anywhere you like in your project

UIViewController

SwiftyAd.shared.showBanner(from: self) 
SwiftyAd.shared.showBanner(from: self, at: .top) // Shows banner at the top
SwiftyAd.shared.showInterstitial(from: self)
SwiftyAd.shared.showInterstitial(from: self, withInterval: 4) // Shows an ad every 4th time method is called
SwiftyAd.shared.showRewardedVideo(from: self) // Should be called when pressing dedicated button

SKScene
(Do not call this in didMoveToView as .window property is still nil at that point. Use a delay or call it later)

if let viewController = view?.window?.rootViewController {
     SwiftyAd.shared.showBanner(from: viewController) 
     SwiftyAd.shared.showBanner(from: viewController, at: .top) // Shows banner at the top
     SwiftyAd.shared.showInterstitial(from: viewController)
     SwiftyAd.shared.showInterstitial(from: viewController, withInterval: 4) // Shows an ad every 4th time method is called  
     SwiftyAd.shared.showRewardedVideo(from: viewController) // Should be called when pressing dedicated button
}

Note:

You should only show rewarded videos with a dedicated button and you should only show that button when a video is loaded (see below). If the user presses the reward video button and watches a video it might take a few seconds for the next video to reload afterwards. Incase the user immediately tries to watch another video this helper will show an alert informing the user that no video is available at the moment.

Tip:

From my personal experience and from a user perspective you should not spam full screen interstitial ads all the time. This will also increase your revenue because user retention rate is higher so you should not be greedy. Therefore you should

1) Not show an interstitial ad everytime a button is pressed
2) Not show an interstitial ad everytime you die in a game
3) Use the "withInterval" property in the show method and set it to a minimum of 5/6 depending on the frequence the method is called. There might be special cirumstances where you could set it lower e.g in a game where it takes a while to die but usually 5/6 mimimum is what I think is best. You could also randomise the interval e.g random number between 5-8.

  • To check if ads are ready
if SwiftyAd.shared.isRewardedVideoReady {
    // add/show reward video button
}

if SwiftyAd.shared.isInterstitialReady {
    // maybe show custom ad or something similar
}

// When these return false the helper will try to preload an ad again.
  • To remove Banner Ads, for example during gameplay

    SwiftyAd.shared.removeBanner() 
  • To remove all Ads, mainly for in app purchases simply call
    SwiftyAd.shared.isRemoved = true 

NOTE: Remove Ads bool

If set to true all the methods to show banner and interstitial ads will not fire anymore and therefore require no further editing.

This will not stop rewarded videos from showing as they should have a dedicated button. Some reward videos are not skipabble and therefore should never be shown automatically. This way you can remove banner and interstitial ads but still have a rewarded videos button.

For permanent storage you will need to create your own "removedAdsProduct" property and save it in something like UserDefaults, or preferably iOS Keychain. Than at app launch check if your saved property is set to true and than updated the helper poperty.

  • Implement the delegate methods.

Set the delegate in the relevant SKScenes DidMoveToView method or in your ViewControllers ViewDidLoad method
to receive delegate callbacks.

SwiftyAd.shared.delegate = self 

Than create an extension conforming to the AdsDelegate protocol.

extension GameScene: SwiftyAdDelegate {
    func swiftyAdDidOpen(_ swiftyAd: SwiftyAd) {
        // pause your game/app if needed
    }
    func swiftyAdDidClose(_ swiftyAd: SwiftyAd) { 
       // resume your game/app if needed
    }
    func swifyAd(_ swiftyAd: SwiftyAd, didRewardUserWithAmount rewardAmount: Int) {
        self.coins += rewardAmount
       // Reward amount is a DecimelNumber I converted to an Int for convenience. 

       // You can ignore this and hardcore the value if you would like but than you cannot change the value dynamically without having to update your app.

       // You can also ingore the rewardAmount and do something else, for example unlocking a level or bonus item.

       // leave empty if unused
    }
}

Note:

This helper will pass a default value to the below method

func swiftyAd(_ swiftyAd: SwiftyAd, didRewardUserWithAmount rewardAmount: Int) {

incase there is a problem fetching the value from the ad network or you set it to 0 or lower by accident. The default value is 1. Incase you need to change this e.g to 20, you can change this in the setup method.

SwiftyAd.shared.setup(
      withBannerID:        ..., 
      interstitialID:  ..., 
      rewardedVideoID: ...,
      rewardAmountBackup: 20
)

Supporting both landscape and portrait orientation

  • If your app supports both portrait and landscape orientation go to your ViewControllers and add the following method.
override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
        super.viewWillTransition(to: size, with: coordinator)

        coordinator.animate(alongsideTransition: { (UIViewControllerTransitionCoordinatorContext) in

            SwiftyAd.shared.updateOrientation()

            }, completion: { (UIViewControllerTransitionCoordinatorContext) -> Void in
                print("Device rotation completed")
        })
    }

When you submit your app to Apple

When you submit your app to Apple on iTunes connect do not forget to select YES for "Does your app use an advertising identifier", otherwise it will get rejected. If you use reward videos you should also select the 3rd point.

License

SwiftyAd is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "SwiftyAd",
    "version": "1.0.3",
    "summary": "A Swift helper to integrate Ads from AdMob so you can easily show Banner Ads, Interstitial Ads and RewardVideoAds anywhere in your project.",
    "homepage": "https://github.com/satishbabariya/SwiftyAd",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Satish Babariya": "[email protected]"
    },
    "source": {
        "git": "https://github.com/satishbabariya/SwiftyAd.git",
        "tag": "1.0.3"
    },
    "platforms": {
        "ios": "9.0"
    },
    "source_files": "SwiftyAd/Classes/**/*",
    "frameworks": "UIKit",
    "vendored_frameworks": "GoogleMobileAdsSDK/GoogleMobileAds.framework",
    "pushed_with_swift_version": "3.0"
}

Pin It on Pinterest

Share This