[Ext.point] 공통 적용 항목 연동

공통 적용 항목 연동을 통해 Extauth 모듈을 이용하여 고유 포인트 서비스가 없어도, 외부 포인트 시스템을 통하여 포인트 서비스를 제공합니다. 해당 문서에서는 SDK 적용 및 초기화를 진행하고, 사용자 정보 관리와 연관된 항목을 설정합니다.

이 문서는 광고 지면의 종류/ 수와 상관없이 연동이 되어야 하는 공통 적용 항목입니다. 

 

다음 과정이 완료되었는지 확인이 필요합니다.

Android X 환경이 준비 완료되었는지 (링크)
App Id 가 발급 완료되었는지
연동하려는 버전이 확인되었는지

위의 과정 중 완료되지 않은 항목이 있다면, 버즈빌의 BD 매니저에게 문의 바랍니다.

 


연동하기

1. SDK 적용하기

build.gradle 적용하기

[1] build.gradle 의 dependencies 에 아래의 코드를 적용해야 합니다.

repositories { maven { url "https://dl.buzzvil.com/public/maven" } } ... dependencies { implementation ("com.buzzvil:buzzad-benefit:3.29.+") }

 

SDK 초기화하기

[1] AndroidManifest.xml 에 다음 코드를 적용해야 합니다.

<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.buzzvil.packagename"> <application> ... <!-- Caution: Replace `000000000000` with Your AppKey --> <meta-data android:name="com.buzzvil.APP_KEY" android:value="app-pub-000000000000" /> </application> </manifest>

[2] Application Class - onCreate 에 다음 코드를 적용해야 합니다.

public class App extends Application { @Override public void onCreate() { //// Extauth 모듈 활성화를 위해 다음 항목들을 추가합니다. //// // ExtauthConfig - (1) AppIcon (3) loginTitle (4) loginDescription (5) comebackDeeplink 를 변경할 수 있습니다. final BuzzAdBenefitExtauthConfig extauthConfig = new BuzzAdBenefitExtauthConfig.Builder(this) .setAppIcon(context.getApplicationInfo().getIcon()) .build(); // ExtauthInstaller final BuzzAdBenefitExtauthInstaller extauthInstaller = new BuzzAdBenefitExtauthInstaller(extauthConfig); final BuzzAdBenefitConfig buzzAdBenefitConfig = extauthInstaller.installTo(new BuzzAdBenefitConfig.Builder(this)) .build(); // (3) 초기화 BuzzAdBenefit.init(this, buzzAdBenefitConfig); } }

색상은 테마변경 가이드에 따라 변경할 수 있습니다.

[3] 확인이 필요한 항목 - 각각 위 항목의 (1), (2), (3) 에 해당합니다. 

Config 는 위의 ‘Extauth 모듈 미리 보기’ - '1) 광고를 처음으로 참여하여 인증 화면이 노출' 에 해당하며, 다음을 설정할 수 있습니다. (아래를 클릭하여 이미지를 확인할 수 있습니다.)

 

  1. setAppIcon(@DrawableRes int) 을 통해 ‘외부 서비스 연동 페이지’에서 사용할 앱 아이콘을 설정합니다. 위의 예시에는 기본 설정값을 적용하였습니다. 앱 전체 설정에 영향을 주지 않습니다.

  2. setThemeColor(@ColorInt int) 을 통해 ‘외부 서비스 연동 페이지’에서 사용할 버튼의 기본색을 설정합니다. 위의 예시에는 기본 설정값을 적용하였습니다. 앱 전체 설정에 영향을 주지 않습니다.

  3. setLoginTitle(String) 을 통해 ‘외부 서비스 연동 페이지’에서 사용할 타이틀 문구를 설정합니다. 위의 예시에는 'this is loginTitle'을 설정했습니다.

  4. setLoginDescription(String) 을 통해 ‘외부 서비스 연동 페이지’에서 사용할 설명 문구를 설정합니다. 위의 예시에는 'this is loginDescription'을 설정했습니다.

  5. (중요init 코드는 onCreate 에 적용하는 것을 권장합니다. 어떤 이유(내부 정책 등)로 다음 위치에 코드를 적용하지 못할 경우, 반드시 최초로 광고를 요청하는 위치보다 이전에 배치되어야 합니다.

 

(Optional) 딥링크 커스터마이징

BuzzAd Ext.Point에서는 외부 포인트사 연동 완료 시 웹페이지를 띄웁니다. 연동 완료시 보여지는 웹페이지에는 ‘앱으로 돌아가기’ 버튼이 있으며, 버튼을 눌렀을때 (실행중이던) 앱으로 돌아갑니다. 추가로 ‘앱으로 돌아가기’ 버튼을 눌렀을 때 실행할 딥링크를 커스터마이징할 수 있습니다.

 

딥링크 커스터마이징을 하며, application Id 와 package name을 다르게 설정한 경우

Application Id 와 package name 이 동일하지 않은 경우 의도치 않은 동작을 야기할 수 있습니다.
이런 경우 아래 가이드를 참조하여 setComebackDeeplink 를 설정해야합니다.

 


연동하기

2. 사용자 정보 관리하기

User profile 및 Session Ready Broadcast

사용자 정보는 userProfile 에서 관리합니다. 자체 포인트 서비스를 사용하는 경우, 일반적으로 사용자 정보는 내부에서 관리하는 정보를 설정합니다. 하지만, 이 연동의 경우 외부 인증을 통하여 사용자 정보를 설정합니다. 따라서 별도의 User profile 설정이 필요하지 않습니다.

[1] 외부 인증을 통한 로그인에 성공하면 Session Ready Broadcast 가 호출됩니다. 이때 BroadcastReceiver 를 사용하여 로그인 상태에 따른 동작을 구현할 수 있습니다.

[2] (선택) 유저의 타겟팅 (성별, 생년) 정보 입력하기

외부 인증을 통한 로그인 이후, 유저의 아이디가 고유하게 정해집니다. 이후, 파트너에서 직접 유저의 성별 및 출생년도 정보를 직접 입력할 수 있습니다. 유저의 타겟팅 정보가 입력될 경우, 유저가 더 많은 광고를 참여할 수 있습니다. (해당 정보는 유저가 직접 입력할 수 있습니다.)

타겟팅 정보

  • gender

    • UserProfile.Gender.MALE: 남성

    • UserProfile.Gender.FEMALE: 여성

  • birthYear: 출생년도 (4자리)

 

User preference 설정하기

앞선 단계의 Session Ready Broadcast 를 이용하여, 유저가 로그인에 성공한 시점에 다음을 설정합니다.

autoplayType()은 동영상 광고의 자동 재생에 대한 설정입니다. 기본값은 Wifi 환경에서만 자동 재생하도록 설정되어 있습니다. 선택 가능한 설정값은 다음과 같습니다.

  • AutoplayType.ON_WIFI: Wifi 환경에서만 자동 재생됩니다. (기본값)

    • 외부 포인트 연동이 완료 되지 않은 경우, 자동 재생하지 않습니다.

  • AutoplayType.ENABLED: 항상 자동 재생됩니다.

  • AutoplayType.DISABLED: 자동 재생을 사용하지 않습니다.

 

사용자 정보 삭제하기

외부 인증을 통한 로그인이 만료되는 시점 혹은 앱 사용 종료로 설정값 삭제가 필요할 경우, 다음을 설정합니다. 

 


다음 과정으로 넘어가기

→ 광고 지면 연동하기 (최신 연동가이드)