Getting started with ADXLibrary

가입을 원하시면 [email protected]로 연락 부탁 드립니다.

0. Latest ADXLibrary

Version : 1.17.0

Release Date : 2021/06/18

1. build.gradle 추가

repositories {
    // ... other project repositories
    jcenter()
    maven { url 'https://jitpack.io' }
    maven { url 'https://maven.google.com' }
}

// ...
dependencies {
    // 라이브러리 전체를 포함할 경우(추가 시 [email protected]로 노티 필요)
    implementation 'com.github.adxcorp.ADXLibrary_Android:adx-library:1.17.0'

    // 네이티브만 포함할 경우
    implementation 'com.github.adxcorp.ADXLibrary_Android:adx-library-native:1.17.0'

    // 전면/배너만 포함할 경우
    implementation 'com.github.adxcorp.ADXLibrary_Android:adx-library-standard:1.17.0'

    // 리워드 비디오만 포함할 경우
    implementation 'com.github.adxcorp.ADXLibrary_Android:adx-library-rewarded-video:1.17.0'

    // 예를 들어 전면/배너/네이티브를 포함할 경우 아래와 같이 추가하시면 됩니다.
    implementation 'com.github.adxcorp.ADXLibrary_Android:adx-library-standard:1.17.0'
    implementation 'com.github.adxcorp.ADXLibrary_Android:adx-library-native:1.17.0'

    // Google Play Service Ads 20.1.0 버전을 사용합니다.
    implementation 'com.google.android.gms:play-services-ads:20.1.0'
}

android {
    compileOptions {
       sourceCompatibility 1.8
       targetCompatibility 1.8
    }
}

2. Initialize

MainActivity onCreate에서 광고 관련 코드를 호출하기 전, 아래와 같이 추가합니다. 발급받으신 Ad Unit ID 중 하나만 사용하여 initialize 해주시고, onResult가 호출 된 다음 광고 관련 코드를 작성해주세요. initialize function은 한 번만 호출해주시면 됩니다.

EU 트래픽이 없으신 경우에는 initWithSaveGDPRState를 이용하여 ADXConsentStateNotRequired로 동의 여부를 업데이트 해주시면 되며, initWithShowAdxConsent의 isDebug를 true로 설정하시면 EU 내에서 노출되는 Consent UI를 확인하실수 있습니다.

상세한 내용은 하단의 GDPR 가이드를 참고하여 주시면 됩니다.

- 사용자의 위치 및 동의 여부를 확인하여 동의 UI 노출이 필요한 경우

ADXGDPR.initWithShowAdxConsent(activity, "<YOUR AD Unit ID>", isDebug, new ADXGDPR.ADXConsentListener() {
        @Override
        public void onResult(ADXGDPR.ADXConsentState adxConsentState) {
                
        }
});

- 직접 동의 여부를 설정하시는 경우 (동의 UI 노출되지 않음)

ADXGDPR.initWithSaveGDPRState(activity, "<YOUR AD Unit ID>", adxConsentState, new ADXGDPR.ADXConsentListener() {
        @Override
        public void onResult(ADXGDPR.ADXConsentState adxConsentState) {

        }
});

- Native Ad와 관련된 function을 initialize function과 동일한 activity에서 호출하시는 경우

initWithShowAdxConsent 또는 initWithSaveGDPRState와 같은 initialize function을 호출하시기 전, NativeAdFactory.init()과 NativeAdFactory.setViewBinder()를 먼저 호출해주시고, 아래 예시 코드와 같이 ADXConsentListener의 onResult 내에서 NativeAdFactory.preloadAd()를 호출해주셔야 합니다.

NativeAdFactory.init(context);
NativeAdFactory.setViewBinder(DefineAdUnitId.NATIVE_AD_UNIT_ID, new ViewBinder.Builder(R.layout.layout_native_ad)
                .mainImageId(R.id.mainImageId)
                .iconImageId(R.id.iconImageId)
                .titleId(R.id.titleId)
                .privacyInformationIconImageId(R.id.privacyInformationIconImageId)
                .callToActionId(R.id.callToActionId)
                .addExtra("ad_choices_container", R.id.ad_choices_container)
                .build());
NativeAdFactory.setAdxViewBinder(DefineAdUnitId.NATIVE_AD_UNIT_ID, new ADXViewBinder.Builder(R.layout.layout_media_native_ad)
                .mediaViewContainerId(R.id.mediaContainerId)
                .adIconViewContainerId(R.id.adIconContainerId)
                .titleId(R.id.titleId)
                .adChoiceContainerId(R.id.adChoicesContainerId)
                .callToActionId(R.id.callToActionId)
                .build());

ADXGDPR.initWithShowAdxConsent(this, DefineAdUnitId.BANNER_AD_UNIT_ID, true, new ADXGDPR.ADXConsentListener() {
        @Override
        public void onResult(ADXGDPR.ADXConsentState adxConsentState) {
                NativeAdFactory.preloadAd(DefineAdUnitId.NATIVE_AD_UNIT_ID);
        }

});

3.Rewarded Video 연동 선택

MoPub/AdMob 연동 코드를 함께 사용하시면 정상적으로 callback 호출이 되지 않을 수 있으므로, 반드시 하나의 연동 코드만 사용해주셔야 합니다.

4. Add test device

AdMob Rewarded Video를 이용하실 경우 개발중 반드시 아래 내용을 참고하여 테스트 디바이스를 등록 후 사용해주시기 바랍니다. 테스트 디바이스 미등록 상태로 테스트할 경우 계정이 정지될 수 있습니다.

AdMob을 이용하여 Rewarded Video를 로드하는 코드가 삽입 된 상태로 run 해주시면 아래와 같은 로그를 확인하실 수 있습니다.

 Ads: Use RequestConfiguration.Builder().setTestDeviceIds(Arrays.asList("9E928D273E90AF6642DB99539DB71311") 
      to get test ads on this device.

출력 된 Device ID를 복사하여 아래와 같이 AdRequest에서 AddTestDevice를 call 하도록 수정해주세요.

RequestConfiguration configuration = new RequestConfiguration.Builder()
                        .setTestDeviceIds(Arrays.asList("9E928D273E90AF6642DB99539DB71311")).build();
MobileAds.setRequestConfiguration(configuration);

5. 디버깅 로그 활성화

미디에이션이 정상 동작 확인을 위해 Initialize 하기 전에 아래와 같이 추가해야 합니다.

ADXLogUtil.setLogEnable(true);

* GDPR Guide

• GDPR 규정을 준수하기 위해 ADXGDPR class 에서 제공하고 있는 아래와 같은 function을 사용하실수 있습니다.

// ADXLibrary를 초기화 하고, GDPR 규정을 준수하기 위하여 기존 동의 여부와 EU 사용자 여부를 확인하여 개인정보 수집 및 이용에 대한 동의 화면을 노출하여 동의 정보를 저장합니다.
public static void initWithShowAdxConsent(final Activity activity, String mopubAdUnitId, final boolean isDebug, final ADXConsentListener gdprListener)

// ADXLibrary를 초기화 하고, 동의 화면 노출 없이 직접 동의 여부를 설정합니다.
public static void initWithSaveGDPRState(final Context context, final String mopubAdUnitId, final ADXConsentState consentState, final ADXConsentListener gdprListener)

// ADXGDPR에 설정된 사용자의 동의 정보를 확인하실 수 있습니다.
public static int getResultGDPR(Context context)

// 직접 동의 여부를 변경합니다.
public static void saveResultGDPR(Context context, ADXGDPR.ADXConsentState consentState)

// AD(x)의 Privacy Policy URL을 요청할 수 있습니다.
public static String getPrivacyURL()

• ADXConsentState는 아래와 같은 4가지 상태가 존재합니다.

// 동의여부가 존재하지 않는 사용자로, initialize function 미호출 상태입니다. 개인화 광고가 노출되지 않습니다.
ADXConsentStateUnknown
// EU내의 사용자가 아니므로 동의여부가 불필요한 사용자입니다. 개인화 광고가 노출됩니다.
ADXConsentStateNotRequired
// 개인정보 활용 동의 화면에서 거절을 선택한 사용자입니다. 개인화 광고가 노출되지 않습니다.
ADXConsentStateDenied
// 개인정보 활용 동의 화면에서 승인을 선택한 사용자입니다. 개인화 광고가 노출됩니다.
ADXConsentStateConfirm

• Application 실행시 원하시는 방식에 맞춰 initWithShowAdxConsent 또는 initWithSaveGDPRState를 호출해주시면 됩니다.
• EU 트래픽이 없으신 경우에는 initWithSaveGDPRState를 이용하여 ADXConsentStateNotRequired로 동의 여부를 업데이트 해주시면 됩니다.
• initWithShowAdxConsent의 isDebug를 true로 설정하시면 EU 내에서 노출되는 Consent UI를 확인하실수 있습니다.
• 광고 관련 코드는 ADXConsentListener의 onResult가 호출된 후 사용하여 주세요.
• NativeAdFactory의 init()과 setViewBinder()가 initialize function과 동일한 activity에서 호출될 경우, initialize function 보다 먼저 호출해주세요.
• initialize function의 AD Unit ID는 발급받으신 것들 중 임의의 것을 하나 사용해주시면 됩니다.
• AdMob Rewarded Video를 사용하실 경우 AdRequest에 다음과 같이 extra data를 추가해주셔야 합니다.

Bundle extras = new Bundle();
if (ADXGDPR.ADXConsentState.values()[ADXGDPR.getResultGDPR(this)] == ADXGDPR.ADXConsentState.ADXConsentStateDenied) {
        extras.putString("npa", "1");
}

AdRequest request =  new AdRequest.Builder()
                .addNetworkExtrasBundle(AdMobAdapter.class, extras)
                .build();