Skip to content

czwuwei/public-foxengagement-ios-sdk

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

- F.O.X Engagement iOS Integration Guide -

F.O.Xエンゲージメント配信とは

本サービスは、以下2つのキャンペーンを配信するためのネットワーク広告となっています。

  • アクション目的の広告配信

データフィードを活用しダイナミッククリエイティブ、レコメンド広告を配信します。

  • インストール目的の広告配信

アドネットワークのようなピクチャーバナーによる広告を配信します。

目次

## 1. インストール

1.1 入手

  • SDK本体をこちらよりダウンロードしてください。
  • ダウンロードしたSDKを展開し、ライブラリファイルをアプリケーションのプロジェクトに組み込んでください。

1.2 ライブラリ内訳

  • libFoxEngagementSdk.a
  • FEGAdView.h
  • FEGAdStateDelegate.h

1.3 必要なframework

  • UIKit.framework
  • Foundation.framework
  • Security.framework
  • ImageIO.framework
  • AdSupport.framework

1.4 plist設定ファイル

ファイル名

  • FoxEngagement.plist

設定項目

  • API_KEY 値は案件開始時に弊社より発行させて頂くIDとなります。 広告表示に必須となります。
キー バリュー
API_KEY 値は案件開始時に弊社より発行させて頂くIDとなります。広告表示に必須となります。

1.5 App Transport Security (ATS)設定

ATSを有効した場合、NSExceptionDomainsに下記の設定を追加してください。

<key>forceoperationx.com</key>
<dict>
	<key>NSExceptionAllowsInsecureHTTPLoads</key>
	<true/>
	<key>NSIncludesSubdomains</key>
	<true/>
</dict>
## 2. API

FEGAdView

プローパティー タイプ 詳細
placementId NSString 広告表示ID(管理者より発行されます)
size Enum 広告表示サイズ
adStateDelegate id 広告表示の際のイベントを取得するためのdelegate
返り値型 メソッド 詳細
void show 広告を表示します。

FEG_ADVIEW_SIZE

変数名 詳細
NS_ENUM FEG_ADVIEW_SIZE_320x50 横320×縦50(ピクセル)の広告をリクエストします
NS_ENUM FEG_ADVIEW_SIZE_320x100 横320×縦100(ピクセル)の広告をリクエストします
NS_ENUM FEG_ADVIEW_SIZE_300x250 横300×縦250(ピクセル)の広告をリクエストします
NS_ENUM FEG_ADVIEW_SIZE_336x280 横336×縦280(ピクセル)の広告をリクエストします
NS_ENUM FEG_ADVIEW_SIZE_112x112 横112×縦112(ピクセル)の広告をリクエストします

FEGAdStateDelegate

返り値型 メソッド 詳細
void onAdSuccess ( UIView v )

v : 広告のView
広告の表示が正常だった場合に呼ばれます。
void onAdFailed ( UIView v )

v : 広告のView
広告が表示できなかった場合に呼ばれます。
void onAdClicked ( UIView v )

v : 広告のView
広告がクリックされた場合に呼ばれます。
BOOL onAdFallback ( UIView v )

v : 広告のView
表示する広告がなかった場合に呼ばれます。Fallbackの場合、メディア側で用意したクリエイティブを表示することが可能となっています。
その場合は返り値にYESを指定してください。また、任意の処理を行うため広告枠を非表示にする場合にはNOを返してください。

・onAdFallbackが発生しYESを返した場合、メディア側で用意したクリエイティブが表示される際のonAdSuccessとonAdFailedは呼ばれません。

## 3. コードへの組み込み

3.1 広告表示サンプル その1

NSString* placementId = xxx; // 管理者より発行される
CGRect frame = CGRectMake(x, y, 0, 0);;// 場所だけ指定する
FEGAdView* adView = [[FEGAdView alloc] initWithFrame:frame];
adView.placementId = placementId;
adView.size = FEG_ADVIEW_SIZE_320x50;
[parentView addSubview:adView];
[adView show];

3.2 広告表示サンプル その2

NSString* placementId = xxx; // 管理者より発行される
CGRect frame = CGRectMake(x, y, 0, 0);;// 場所だけ指定する
FEGAdView* adView = [[FEGAdView alloc] initWithFrame:frame];
adView.placementId = placementId;
adView.size = FEG_ADVIEW_SIZE_320x50;
adView.adStateDelegate = adStateDelegate;
[parentView addSubview:adView];
[adView show];


// FEGAdStateDelegate 実装
-(void) onAdSuccess:(UIView *) view {
    NSLog(@"onAdSuccess delegate implement");
}

-(void) onAdFailed:(UIView *) view {
    NSLog(@"onAdFailed delegate implement");
}
-(void) onAdClicked:(UIView*) view {
    NSLog(@"onAdClicked delegate implement");
}
-(BOOL) onAdFallback:(UIView*) view {
    NSLog(@"onAdFallback delegate implement");
    return NO;
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published