exelbid_plugin 1.0.2

Exelbid SDK for Flutter

Exelbid SDK for Flutter

Flutter Plugin 가이드입니다.

목차

• Version History
• Plugin 정보
• SDK 정보
• 시작하기
  • Flutter Plugin 추가하기
  • Android 설정
  • iOS 설정
• 광고 적용하기
  • 인스턴스 공통 메소드
  • 배너 광고
  • 전면 광고

Version History

Version 1.0.2

• Fix android permission
• Modify example

시작하기 전에

• Exelbid에서는 광고 요청에 대한 응답 후 노출까지의 시간(노출 캐시 시간)을 30분 이내로 권장합니다.(IAB 권장)
• 광고 응답 이후 노출 시간 차이가 해당 시간보다 길어지면 광고 캠페인에 따라서 노출이 무효 처리될 수 있습니다.

Plugin 정보

Flutter 3.102.0 버전

SDK 정보

SDK 정보는 아래 링크를 참고해주세요.

• Android SDK 정보
• iOS SDK 정보

시작하기

Flutter Plugin 추가하기

명령어를 이용한 설치

다음 명령어로 종속성 추가 및 설치하세요.

flutter pub add exelbid_plugin

수동으로 설치

pubspec.yaml 파일에 종속성 설정을 해주세요.

dependencies:
  exelbid_plugin: any

종속성 설정 후 다음 명령어로 설치하세요.

flutter pub get

Android 설정

AndroidManifest 설정

권장 권한 설정

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />

iOS 설정

Info.plist 설정

광고 식별자 및 HTTP 트래픽 허용을 위한 권한을 설정합니다.

Exelbid에서는 광고 요청등의 Api에 https를 사용하지만 Exelbid에 연결된 많은 광고주 플랫폼사들의 광고 소재 리소스(image, js등)의 원할한 활용을 위해 http사용 허가 설정이 필요합니다.

1. Flutter 프로젝트에서 ios/Runner/Info.plist 파일을 엽니다.
2. 아래 내용을 추가하세요.

<key>NSUserTrackingUsageDescription</key>
<string>이 앱은 사용자 맞춤 광고를 제공하기 위해 광고 식별자를 사용합니다.</string>

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

광고식별자 권한 요청

사용자로부터 개인정보 보호에 관한 권한을 요청해야 합니다.
앱 설치 후 한번만 요청되며, 사용자가 권한에 대해 응답 후 더 이상 사용자에게 권한 요청을 하지 않습니다.
광고식별자를 수집하지 못하는 경우 광고 요청에 대해 응답이 실패할 수 있습니다.

※ 광고를 호출하기 전에 완료되어야 합니다.
※ 앱이 실행될때 광고식별자 권한 요청을 권장합니다.

1. Flutter 프로젝트에서 ios/Runner/AppDelegate.swift 파일을 엽니다.
2. 아래 내용을 추가하세요.

import AppTrackingTransparency

...

@main
@objc class AppDelegate: FlutterAppDelegate {

    ...

    override func applicationDidBecomeActive(_ application: UIApplication) {
        super.applicationDidBecomeActive(application)

        if #available(iOS 14.0, *) {
            ATTrackingManager.requestTrackingAuthorization { _ in }
        }
    }
}

광고 적용하기

1. Exelbid 계정을 생성합니다.

2. Inventory -> App -> Create New App [new app]

3. Inventory -> Unit -> Create New Unit [new app]

인스턴스 공통 메소드

광고의 효율을 높이기 위해 나이, 성별을 설정하는 것이 좋습니다.

Key	Type	Default	Desc
adUnitId	String		광고 아이디를 셋팅 합니다.
yob	String?	null	태어난 연도 4자리(2016)
gender	bool?	null	성별 (true : 남자, false : 여자)
keywords	Map<String, String>?	null	Custom 메타 데이터 (Key, Value)
isTest	bool?	false	광고의 테스트를 위해 설정하는 값입니다. 통계에 적용 되지 않으며 항상 광고가 노출되게 됩니다.
coppa	bool?	false	선택사항으로 미국 아동 온라인 사생활 보호법에 따라 13세 미만의 사용자를 설정하면 개인 정보를 제한하여 광고 입찰 처리됩니다. (IP, Device ID, Geo 정보등)
rewarded	bool?	false	지면의 리워드 여부를 설정한다.
listener	EBPAdListener?	null	콜백 이벤트 리스너.

배너 광고

배너 광고 인스턴스

Key	Type	Default	Desc
isFullWebView	bool?	true	광고 안에 너비 100%로 웹뷰가 바인딩되게 설정.

EBBannerAdView({super.key,
                required this.adUnitId,
                this.isFullWebView,
                this.coppa,
                this.yob,
                this.gender,
                this.keywords,
                this.isTest,
                this.listener});

예시)

EBBannerAdView(
    adUnitId: "<<Ad Unit Id>>",
    yob: "2014",
    gender: true,
    listener: EBPBannerAdViewListener(
        onLoadAd: () {
            print("Banner onLoadAd");
        }, onFailAd: (String? errorMessage) {
            print("Banner onFailAd");
        }, onClickAd: () {
            print("Banner onClickAd");
        }
    )
)

배너 광고 이벤트 리스너

EBPBannerAdViewListener {
    /// 광고 요청 성공
    final Function() onLoadAd;

    /// 광고 요청 실패
    final Function(String? errorMessage) onFailAd;

    /// 광고 클릭
    final Function()? onClickAd;
}

전면 광고

배너 광고 이벤트 리스너

EBPInterstitialAdViewListener {
    /// 광고 요청 성공
    final Function() onLoadAd;

    /// 광고 요청 실패
    final Function(String? errorMessage) onFailAd;

    /// 광고 클릭
    final Function()? onClickAd;

    /// 전면 광고가 화면에 표시된 후에 전송됩니다.
    final Function()? onInterstitialShow;

    /// 전면 광고가 화면에서 해제 된 후 전송됩니다.
    final Function()? onInterstitialDismiss;
}

전면 광고 콜백 리스너 설정

ExelbidPlugin.shared.setInterstitialListener(EBPInterstitialAdViewListener(
    onLoadAd: () {
        print("Interstitial onLoadAd");
    }, onFailAd: (String? errorMessage) {
        print("Interstitial onFailAd");
    }, onClickAd: () {
        print("Interstitial onClickAd");
    }, onInterstitialShow: () {
        print("onInterstitialShow");
    }, onInterstitialDismiss: () {
        print("onInterstitialDismiss"); 
    })
);

전면 광고 초기화

Future<void> loadInterstitial({
    required String adUnitId,
    bool? coppa,
    String? yob,
    bool? gender,
    Map<String, dynamic>? keywords,
    bool? isTest,
  })

예시)

ExelbidPlugin.shared.loadInterstitial(adUnitId: "<<Ad Unit Id>>", yob: "2014", gender: true);

전면 광고 보기

전면 광고 초기화가 이루어진 후 광고 보기를 요청해야 합니다.

ExelbidPlugin.shared.showInterstitial();