スタートガイド

こちらは、楽天リワードSDKをご利用の開発者様で、アプリネイティブ広告をご利用のためのガイドになります。動作環境は楽天リワードSDKのドキュメントをご参照ください。(楽天リワードSDK) こちらの機能はSDK5.0バージョン以降になります。

7.0.0ではSDKの組み込みはiOS 8から可能ですが、SDKの機能はiOS 11以上で有効です (iOS 8 - 10のユーザはSDKの機能を利用できません) 7.0.0からWKWebViewを使用しております。

導入手順

アプリケーションを開発者ポータルに登録する(開発者ポータル)
SDKをダウンロードページよりダウンロードする(SDKダウンロード)
開発者ポータルよりアプリを登録する(アプリごとにキーを取得する)
SDKをプロジェクトにインポートする
SDKを初期化する(初期化処理を行う)
Adのレイアウトをアプリに追加する

SDKをプロジェクトにインポートする

"RakutenRewardSDK.framework" を "Embed Framework"　に追加する。

import

Objective-Cでアプリケーションを開発する場合

Swift の Framework を読み込むために”Build Settings”で Swift のコンパイルに関する設定をする必要があります。 “Always Embed Swift Standard Libraries” を Yes に設定します。

Always Swift

Objective-C++ でアプリを開発している場合

Objective-C での設定に加えて、Objective-C++ で Swift のヘッダーを読み込むのに必要な場合があります。(RewardSDK.h ではなく RewardSDK-Swift.h)

#import <RakutenRewardSDK/RakutenRewardSDK-Swift.h>

ATSの設定

SDK を使用する上で、いくつかのドメインに対して ATS の設定が必要になります。下記のドメインに対して、ATS の例外設定を追加してください。 (こちらに設定している理由は広告主様のページがSSL設定をしていないケースがあるからです)

ATS

SDK の初期化

SDKの初期化に関しましては、楽天リワードSDK導入マニュアルを参照してください。

※こちらはリワードSDKのミッション機能を使う場合になります。ネイティブAdの機能のみを使う場合は以下を呼び出します。

Swift

import RakutenRewardSDK

class AppDelegate : UIResponder, UIAppliationDelegate {
      func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: Any]?) → Bool {
            RakutenRewardAds.sharedInstance.initialize(appCode: "YOUR_APP_CODE")
      }
     func applicationWillEnterForeground(_ application: UIApplication) {
             RakutenRewardAds.sharedInstance.initialize(appCode: "YOUR_APP_CODE")
     }
}

Objective-C

#import <RakutenRewardSDK/RakutenRewardSDK.h>

-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
       [[RakutenRewardAds sharedInstance] initializeWithAppCode: "YOUR_APP_CODE"];
       return YES;
}

-(void)applicationWillEnterForeground:(UIApplication *)application {
        [[RakutenRewardAds sharedInstance] initializeWithAppCode: "YOUR_APP_CODE"];
}

App Store へのアップロード時の設定について

SDK は実機及びシミュレータに対応した、ユニバーサルフレームワークの形式を取っています。そのためアプリをアーカイブして iTunes Connect にアップロードする際、 simulator 用の architecture が含まれていることによるエラーが発生する場合があります。その際は下記のように simulator 用の architecture をビルドから除外する設定を追加してください。

“Build Phases” を選択
左上の+ボタンからNew Run Script Phase を選択
下記のスクリプトを追加(サンプルアプリからコピー可能) ※スクリプト内で使用している${TARGET_BUILD_DIR}等の環境変数がセットされていることをご確認ください。

script

# Create log to check environment variables
env > env.log

UNIVERSAL_OUTPUTFOLDER=${BUILD_DIR}/${CONFIGURATION}-universal
FRAMEWORK_NAME=RakutenRewardSDK

# Build Device and Simulator versions
xcodebuild -target "${PROJECT_NAME}" ONLY_ACTIVE_ARCH=NO -configuration ${CONFIGURATION} -sdk iphoneos  BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" build
xcodebuild -target "${PROJECT_NAME}" -configuration ${CONFIGURATION} -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" build

# make sure the output directory exists
mkdir -p "${UNIVERSAL_OUTPUTFOLDER}"

# 1. Copy the iphone device's framework structure to the universal folder
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${FRAMEWORK_NAME}.framework" "${UNIVERSAL_OUTPUTFOLDER}/"

# 2. Copy the Modules content from simulator's framework to universal folder
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${FRAMEWORK_NAME}.framework/Modules/${FRAMEWORK_NAME}.swiftmodule/x86_64.swiftmodule" "${UNIVERSAL_OUTPUTFOLDER}/${FRAMEWORK_NAME}.framework/Modules/${FRAMEWORK_NAME}.swiftmodule/"


# 3. Create universal binary file using lipo and place the combined executable in the copied framework directory
lipo -create -output "${UNIVERSAL_OUTPUTFOLDER}/${FRAMEWORK_NAME}.framework/${FRAMEWORK_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${FRAMEWORK_NAME}.framework/${FRAMEWORK_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${FRAMEWORK_NAME}.framework/${FRAMEWORK_NAME}"

# 4. Copy the framework to the project's directory
cp -R "${UNIVERSAL_OUTPUTFOLDER}/${FRAMEWORK_NAME}.framework" "${PROJECT_DIR}"

# 5. Open the project's directory in Finder
open "${PROJECT_DIR}"

Info.plist

Ad 機能では広告の最適化のためユーザの位置情報を取得しております。位置情報を取得するため、 Info.plistに位置情報を取得するための設定を追加します。

<key>NSLocationWhenInUseUsageDescription</key>
<string>広告最適化のため位置情報を取得します</string>

SDKが提供する広告のサイズ

SDKでは3つのバナータイプとインタースティシャルタイプの広告を提供いたします。

広告名	サイズ	クラス名	広告タイプ(Swift)	広告タイプ(Objective-C)
バナー(320x50)	320 x 50	RakutenADBannerView	RAdSize.Banner	RAdSizeBanner
~~バナー(320x100)~~	~~320 x 100~~	~~RakutenADBannerView~~	~~RAdSize.Large~~	~~RAdSizeLarge~~
~~バナー(300x250)~~	~~300 x 250~~	~~RakutenADBannerView~~	~~RAdSize.Rectangle~~	~~RAdSizeRectangle~~
インタースティシャル	全画面	RakutenADInterstitial

バナータイプの広告を利用する

広告は60秒自動で更新されます(変更不可)。

Storyboard を利用する場合

RakutenADBannerView(UIView) を storyboard　に追加する
登録したUIViewをRakutenADBannerViewに設定する
コードに紐付ける
locationid を設定する
広告タイプ(サイズ)を設定する
広告をロードする

コードで追加する場合

プロパティを定義する
インスタンスを作成してViewに追加する
locationid を設定する
広告タイプ(サイズ)を設定する
広告をロードする

3〜5の部分は、Storyboardの4〜6の部分と同じです。

Storyboard を利用する場合

(以下の例は320x50のバナーになります)

RakutenADBannerView を storyboard　に追加する

UIView(サイズ width: 320, height: 50) をstoryboard もしくはxibに追加する。 (任意の場所に置くことができます)

Storyboard

登録したUIViewをRakutenADBannerViewに設定する

設置したUIViewをXCodeのInspectorよりRakutenADBannerViewに設定する

Add class

コードに紐付ける

Storyboard からドラッグ&ドロップでUIをコードに紐付けます

Swift

@IBOutlet weak var bannerAdView: RakutenADBannerView!

Objective-C

@property (weak, nonatomic) IBOutlet RakutenADBannerView *bannerAdView;

locationid を設定する

※locationIdは、広告位置を区別してレポートに反映させるために使用します。(現在使用していませんが必須項目にしております)

Swift

self.bannerAdView.locationId = "YOUR_LOCATION_ID"

Objective-C

self.bannerAdView.locationId = @"YOUR_LOCATION_ID";

※locationidは英数字20文字まで利用できます

広告タイプ(サイズ)を設定する

Swift

self.bannerAdView.adSize = RAdSize.Banner
self.bannerAdView.adSize = RAdSize.Large
self.bannerAdView.adSize = RAdSize.Rectangle

Objective-C

self.bannerAdView.adSize = RAdSizeBanner;
self.bannerAdView.adSize = RAdSizeLarge;
self.bannerAdView.adSize = RAdSizeRectangle;

広告をロードする

Swift

self.bannerAdView.load()

Objective-C

[self.bannerAdView load];

広告のロードはサイズも指定できます。

Swift

self.bannerAdView.load(AdSize: RAdSize.Banner)
self.bannerAdView.load(AdSize: RAdSize.Large)
self.bannerAdView.load(AdSize: RAdSize.Rectangle)

Objective-C

[self.bannerAdView loadWithAdSize:RAdSize.Banner];
[self.bannerAdView loadWithAdSize:RAdSize.Large];
[self.bannerAdView loadWithAdSize:RAdSize.Rectangle];

コードで追加する場合

プロパティを定義する

Swift

var bannerAdView: RakutenADBannerView

Objective-C

@property (weak, nonatomic) RakutenADBannerView *bannerAdView;

インスタンスを作成してViewに追加する

Swift

self.bannerAdView = RakutenADBannerView(frame: CGRect(x:0, y: 0, width: 320, height: 50))
self.view.addSubview(self.bannerAdView)

Objective-C

self.bannerAdView = [[RakutenADBannerView alloc] initWithFrame: CGRectMake(0,0,320,50)];
[self.view addSubview:self.bannerAdView];

バナータイプその他の機能

RakutenADBannerViewDelegate

このデリゲートは広告イベントのコールバックを提供します。

/// Tells the delegate an ad request loaded an ad.
/// - parameter bannerView: RakutenADBannerView
@objc func didReceiveAd(bannerView: RakutenADBannerView)
/// Tells the delegate an ad request failed.
/// - parameter bannerView: RakutenADBannerView, message: Error message, code: RADErrorCode
@objc func didFailToReceiveAd(bannerView: RakutenADBannerView, message: String, code: RADErrorCode)

メソッド	説明
didReceiveAd	広告を取得に成功した
didFailToReciveAd	広告の取得に失敗した

このコールバックを受け取るにはデリゲートを実装してセットする必要があります。 (以下はその例になります)

Swift

class YourViewController : UIViewController {
    override func viewDidLoad() {
         super.viewDidLoad()
         self.bannerAdView.delegate = self
    }
}

extension YourViewController : RakutenADBannerViewDelegate {
    func didReceiveAd(bannerView: RakutenADBannerView) {
    }

    func didFailedToRecveiveAd(bannerView: RakutenADBannerView, message: String, code: RADErrorCode) {
    }
}

Objective-C

#import "RakutenRewardSDK/RakutenRewardSDK.h"

@interface YourViewController : UIViewController<RakutenADBannerViewDelegate> {

}

@implementation YourViewController {
    -(void)viewDidLoad {
         [super viewDidLoad];
         self.bannerAdView.delegate = self;
    }

    - (void)didReceiveAdWithBannerView:(RakutenADBannerView * _Nonnull)bannerView {
    }

    - (void)didFailToReceiveAdWithBannerView:(RakutenADBannerView * _Nonnull)bannerView message:(NSString * _Nonnull)message code:(enum RADErrorCode)code {
    }
}

エラーコード

didFailToReceiveAdWithBannerViewで受け取るエラーコードは以下のようになります。

エラー	値	説明
NetworkError	1001	ネットワークエラー
NoAvailableAd	1002	広告の供給が止まっています
Unknown	9999	予期せぬエラーが発生しました

広告のリロード

loadメソッドを呼び出すことで広告をリロードできます。

Swift

self.bannerAdView.load()

Objective-C

[self.bannerAdView load];

サーチクーポンを利用する

楽天リワードSDKの広告では検索ワードに連動した広告(クーポン)を配信しております。特定のワードやユーザ入力に連動した広告を出す場合は以下のメソッドを使って検索ワードを更新します。

Swift

self.bannerAdView.keyword = "カバン"

Objective-C

self.bannerAdView.keyword = @"カバン";

※設定をしてもサーチクーポンが必ず表示されることはありません。

インタースティシャルタイプの広告を提供する

インタースティシャル広告を実装する手順は以下になります (インタースティシャル広告は縦表示のみをサポートします。横表示の場合は表示されません。また縦表示から横表示に変えた場合は自動的に閉じます)。
※バージョン7以降ではiPhoneの場合強制的に縦表示になります

RakutenADInterstitialのインスタンスをViewController上で作成する
locationidを設定する
表示するViewControllerを設定する
(任意) RakutenADInterstitialDelegate を設定する
広告をロードする

RakutenADInterstitialのインスタンスをViewController上で作成する

Swift

var interstitial = RakutenADInterstitial.instantiate()

Objective-C

#import "RakutenRewardSDK/RakutenRewardSDK.h"
@interface YourviewController : UIViewController
@property (nonatomic,strong)  RakutenADInterstitial *interstitial;
@end

@implementation InterstialAdTestViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    _interstitial = [[RakutenADInterstitial alloc] instantiate];
}
@end

locationidを設定する

Swift

interstitial?.locationId = "abc"

Objective-C

_interstitial.locationId = @"123";

表示するViewControllerを設定する

Swift

interstitial?.rootViewController = self

Objective-C

_interstitial?.rootViewController = self;

(任意) RakutenADInterstitialDelegate を設定する

Swift

interstitial?.delegate = self

Objective-C

_interstitial.delegate = self;

広告をロードする(自動的に開く)

Swift

interstitial?.loadAd()

Objective-C

[_interstitial loadAd];

広告をロードする(自動的に開かない)

オプションとしてこちらも用意してあります。

Swift

interstitial?.loadAd(true)

この場合、広告を開くには以下のメソッドを呼びます

Swift

interstitial?.showAd()

インタースティシャルタイプその他の機能

RakutenADInterstitialDelegate

このデリゲートはインタースティシャル広告イベントのコールバックを提供します。

メソッド	説明
interstitialDidReceiveAd	広告を受け取ることに成功した
interstitialDidFailToReceiveAd	広告を受け取ることに失敗した
interstitialWillPresentScreen	インタースティシャル広告が表示される時
interstitialWillDismissScreen	インタースティシャル広告が閉じる時
interstitialDidDismissScreen	インタースティシャル広告が閉じた時
interstitialWillLeaveApplication	インタースティシャル広告がアプリ〜ションから削除される時

Swift

/// Tells the delegate an ad request loaded an ad.
/// - parameter ad: RakutenADInterstitial
@objc func interstitialDidReceiveAd(ad: RakutenADInterstitial)
/// Tells the delegate an ad request failed.
/// - parameter ad: RakutenADInterstitial, message: Error message, code: RADErrorCod
@objc func interstitialDidFailToReceiveAd(ad: RakutenADInterstitial, message: String, code: RADErrorCode)
/// Tells the delegate that an interstitial will be presented.
/// - parameter ad: RakutenADInterstitial
@objc optional func interstitialWillPresentScreen(ad: RakutenADInterstitial)
/// Tells the delegate the interstitial is to be animated off the screen.
/// - parameter ad: RakutenADInterstitial
@objc optional func interstitialWillDismissScreen(ad: RakutenADInterstitial)
/// Tells the delegate the interstitial had been animated off the screen.
/// - parameter ad: RakutenADInterstitial
@objc optional func interstitialDidDismissScreen(ad: RakutenADInterstitial)
/// Tells the delegate that a user click will open another app
/// (such as the App Store), backgrounding the current app.
/// - parameter ad: RakutenADInterstitial
@objc optional func interstitialWillLeaveApplication(ad: RakutenADInterstitial)

extension YourViewController: RakutenADInterstitialDelegate {
    func interstitialDidReceiveAd(ad: RakutenADInterstitial) {
        // Callback when interstitial ad received
    }

    func interstitialDidFailToReceiveAd(ad: RakutenADInterstitial, message: String, code: RADErrorCode) {
        // Callback if interstitial ad failed
    }

    func interstitialWillDismissScreen(ad: RakutenADInterstitial) {
        // Callback before dismiss interstitial ad
    }

    func interstitialDidDismissScreen(ad: RakutenADInterstitial) {
        // Callback after dismiss interstitial ad
    }    

    func interstitialWillLeaveApplication(ad: RakutenADInterstitial) {
        // Callback when interstitial ad leave application
    }

    func interstitialWillPresentScreen(ad: RakutenADInterstitial) {
        // Callback when interstitial ad will present on screen
    }
}

Objetive-C

@interface YourTestViewController : UIViewController<RakutenADInterstitialDelegate>
@end

@implementation InterstialAdTestViewController

- (void)interstitialDidFailToReceiveAdWithAd:(RakutenADInterstitial * _Nonnull)ad message:(NSString * _Nonnull)message code:(enum RADErrorCode)code {
    NSLog(@"Callback if interstitial ad failed: %@", message);
}

- (void)interstitialDidReceiveAdWithAd:(RakutenADInterstitial * _Nonnull)ad {
    NSLog(@"Callback when interstitial ad received");
}

- (void) interstitialWillDismissScreenWithAd:(RakutenADInterstitial *)ad {
    NSLog(@"Callback before dismiss interstitial ad");
}

- (void)interstitialDidDismissScreenWithAd:(RakutenADInterstitial *)ad {
    NSLog(@"Callback after dismiss interstitial ad");
}

- (void)interstitialWillPresentScreenWithAd:(RakutenADInterstitial *)ad {
    NSLog(@"Callback when interstitial ad will present on screen");
}

- (void)interstitialWillLeaveApplicationWithAd:(RakutenADInterstitial *)ad {
    NSLog(@"Callback when interstitial ad leave application");
}
@end

エラーコード

RakutenADInterstitialDelegateで受け取るエラーコードは以下のようになります。

エラー	値	説明
NetworkError	1001	ネットワークエラー
NoAvailableAd	1002	広告の供給が止まっています
Unknown	9999	予期せぬエラーが発生しました

広告の例

楽天リワードSDK iOS Ad 機能 - RakutenReward/RakutenRewardSDK GitHub Wiki

スタートガイド

導入手順

SDKをプロジェクトにインポートする

Objective-Cでアプリケーションを開発する場合

Objective-C++ でアプリを開発している場合

ATSの設定

SDK の初期化

Swift

Objective-C

App Store へのアップロード時の設定について

Info.plist

SDKが提供する広告のサイズ

バナータイプの広告を利用する

Storyboard を利用する場合

コードで追加する場合

Storyboard を利用する場合

RakutenADBannerView を storyboard に追加する

登録したUIViewをRakutenADBannerViewに設定する

コードに紐付ける

Swift

Objective-C

locationid を設定する

Swift

Objective-C

広告タイプ(サイズ)を設定する

Swift

Objective-C

広告をロードする

Swift

Objective-C

Swift

Objective-C

コードで追加する場合

プロパティを定義する

Swift

Objective-C

インスタンスを作成してViewに追加する

Swift

Objective-C

バナータイプその他の機能

RakutenADBannerViewDelegate

Swift

Objective-C

エラーコード

広告のリロード

Swift

Objective-C

サーチクーポンを利用する

Swift

Objective-C

インタースティシャルタイプの広告を提供する

RakutenADInterstitialのインスタンスをViewController上で作成する

Swift

Objective-C

locationidを設定する

Swift

Objective-C

表示するViewControllerを設定する

Swift

Objective-C

(任意) RakutenADInterstitialDelegate を設定する

Swift

Objective-C

広告をロードする(自動的に開く)

Swift

Objective-C

広告をロードする(自動的に開かない)

Swift

Swift

インタースティシャルタイプその他の機能

RakutenADInterstitialDelegate

Swift

Objetive-C

エラーコード

広告の例

⚠️ **GitHub.com Fallback** ⚠️

RakutenADBannerView を storyboard　に追加する

⚠️ GitHub.com Fallback ⚠️