BuzzAd-Benefit 2.0 SDK: Type A - Native Ads

본 가이드는 BuzzAd-Benefit SDK의 네이티브 타입 광고를 연동하는 방법을 다루는 문서입니다.

※ 주의사항

1. Native Ads 타입을 연동하기 전, 공통 가이드의 연동 사항을 모두 적용했는지 확인해 주세요.

2. 네이티브 타입 광고가 노출될 지면이 Activity 또는 Fragment로 구현되어 있어야 합니다. 만일 이와 다르게 구현되어있다면 버즈빌 측에 사전 문의 부탁드립니다.

Index

Basic Usage

Step 1: NativeAdLoader 로 광고 요청

1. NativeAdLoader 객체를 인스턴스화

   • YOUR_NATIVE_AD_UNIT_ID 세팅

2. loadAd() 호출

final String TAG = YourActivity.class.getSimpleName();
final NativeAdLoader loader = new NativeAdLoader("YOUR_NATIVE_AD_UNIT_ID");
loader.loadAd(new NativeAdLoader.OnAdLoadedListener() {
    @Override
    public void onLoadError(@NonNull AdError adError) {
        Log.e(TAG, "Failed to load a native ad.", adError);
    }

    @Override
    public void onAdLoaded(@NonNull NativeAd nativeAd) {
    	populateAd(nativeAd); // Step 3 참고
    }
});

Step 2-1: 광고 레이아웃 생성 - 일반 광고

Benefit 2.5.X 버전 이후로 버즈빌의 광고는, 일반 광고와 쇼핑 광고를 구분하여 보여주고 있습니다. 기존에 연동 중인 경우, 기존 사용하던 광고를 일반 광고로 구분합니다.

다음은 일반 광고를 매체사 앱 내에 레이아웃을 생성하고 광고 컴포넌트들을 관련 뷰에 연결합니다. 

• BuzzAd Benefit 광고 레이아웃의 Root 는 com.buzzvil.buzzad.benefit.presentation.nativead.NativeAdView 으로 설정되어야 합니다.

  • NativeAdView 클래스는 하나의 광고에 대응되는 ViewGroup 의 일종으로, 광고를 표시하기 위한 하위 컴포넌트들은 반드시 이 오브젝트의 child 로 등록되어야 합니다.

• 광고 소재를 보여주는 뷰에는 com.buzzvil.buzzad.benefit.presentation.media.MediaView가 반드시 포함되어야 합니다.

하위 컴포넌트

<com.buzzvil.buzzad.benefit.presentation.nativead.NativeAdView
    android:id="@+id/native_ad_view"
    ... >
    <LinearLayout
        ... >
        <com.buzzvil.buzzad.benefit.presentation.media.MediaView
            android:id="@+id/mediaView"
            ... />
        <TextView
            android:id="@+id/textTitle"
            ... />
        <TextView
            android:id="@+id/textDescription"
            ... />
        <ImageView
            android:id="@+id/imageIcon"
            ... />
        <com.buzzvil.buzzad.benefit.presentation.media.CtaView
            android:id="@+id/ctaView"
            .../>
    ...
    </LinearLayout>
    ...
</com.buzzvil.buzzad.benefit.presentation.nativead.NativeAdView>

Step 2-2: 광고 레이아웃 생성 - 쇼핑 광고

다음은 쇼핑 광고를 매체사 앱 내에 레이아웃을 생성하고 광고 컴포넌트들을 관련 뷰에 연결합니다. 일반 광고와 다르게, 원가 (price) + 할인율 (discountPercentageText) + 할인된 가격 (discountedPrice) + 상품 카테고리 (category) 가 추가 되었습니다.

• Layout에 com.buzzvil.buzzad.benefit.presentation.nativead.NativeAdView를 추가하고, 다음과 같은 component를 추가합니다.

<?xml version="1.0" encoding="utf-8"?>
<com.buzzvil.buzzad.benefit.presentation.nativead.NativeAdView
    android:id="@+id/native_ad_view"
    ...>
    <LinearLayout
        ...>
        <com.buzzvil.buzzad.benefit.presentation.media.MediaView
            android:id="@+id/mediaView"
            ... />
        <TextView
            android:id="@+id/textDescription"
            ... />
        <TextView
            android:id="@+id/priceText"
            ... />
        <TextView
            android:id="@+id/originalPriceText"
            ... />
        <TextView
            android:id="@+id/discountPercentageText"
            ... />
        <TextView
            android:id="@+id/categoryText"
            ... />
        <com.buzzvil.buzzad.benefit.presentation.media.CtaView
            android:id="@+id/ctaView"
            ... />
    ...
    </LinearLayout>
    ...
</com.buzzvil.buzzad.benefit.presentation.nativead.NativeAdView>

쇼핑 광고 적용하기

• 쇼핑 광고와 일반 광고 구분 - Step 1: NativeAdLoader 로 광고 요청할 때, CPS 광고를 확인할 수 있습니다.

final String TAG = YourActivity.class.getSimpleName();
final NativeAdLoader loader = new NativeAdLoader("YOUR_NATIVE_AD_UNIT_ID");
loader.loadAd(new NativeAdLoader.OnAdLoadedListener() {
    @Override
    public void onLoadError(@NonNull AdError adError) {
        Log.e(TAG, "Failed to load a native ad.", adError);
    }

    @Override
    public void onAdLoaded(@NonNull NativeAd nativeAd) {
    	final AdRevenueType revenueType = AdRevenueType.getAdRevenueTypeFromName(ad.getRevenueType());
        if (AdRevenueType.CPS.equals(revenueType)) {
            // CPS 광고
            populateCPSAd(nativeAd);
        } else {
            // 다른 타입의 광고
            populateAd(nativeAd);
        }
    }
});

• CPS 광고에 제공되는 추가정보는 다음과 같이 가져올 수 있습니다.

private void populateCPSAd(final NativeAd nativeAd) {
    final Ad ad = nativeAd.getAd();
    final Product product = ad.getProduct();
    if (product != null) {
        if (product.getDiscountedPrice() != null) {
            // 할인된 가격 정보. 할인중인 상품이 아닌경우, null 값이 반환됨
        }
        long originalPrice = product.getPrice();
        String category = product.getCategory();
    } 
}

• (중요) 사용 예시

private void populateCPSAds(final NativeAd nativeAd) {
    final Ad ad = nativeAd.getAd();
    final Product product = ad.getProduct();
    if (product != null) {
        if (product.getDiscountedPrice() != null) {
            // 할인이 있는 쇼핑 광고
            originalPriceText.setPaintFlags(originalPriceText.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG);
            int percentage = 0;

            // 할인된 가격 정보로 할인율을 계산하여 보여줄 수 있습니다
            if (product.getPrice() > product.getDiscountedPrice()) {
                percentage = Math.round(((product.getPrice() - product.getDiscountedPrice()) / product.getPrice() * 100));
            }
            if (percentage > 0) {
            // 할인이 있는 쇼핑 광고의 경우 원래 가격, 할인 가격, 할인율을 아래와 같이 표기할 수 있습니다
                priceText.setText(getCommaSeparatedPrice(product.getDiscountedPrice().longValue()));
                originalPriceText.setText(getCommaSeparatedPrice((long) product.getPrice()));
                discountPercentageText.setText(String.format(Locale.ROOT, "%d%%", percentage));
                discountPercentageText.setVisibility(View.VISIBLE);
            } else {
            // 할인 가격이 있지만 원래 가격과 차이가 없는 경우, 아래와 같이 원래의 가격만 노출합니다
                priceText.setText(getCommaSeparatedPrice((long) product.getPrice()));
                originalPriceText.setText("");
                discountPercentageText.setVisibility(View.GONE);
            }
        } else {
            // 할인이 없는 쇼핑 광고의 경우 원래의 가격만 노출합니다
            priceText.setText(getCommaSeparatedPrice((long) product.getPrice()));
            originalPriceText.setText("");
            discountPercentageText.setVisibility(View.GONE);
        }
        // 카테고리가 있는 경우 아래와 같이 노출 할 수 있습니다.
        categoryText.setText(product.getCategory());
        if (!TextUtils.isEmpty(product.getCategory())) {
            categoryText.setVisibility(View.VISIBLE);
        }
    }
}

// 아래와 같이 가격 정보를 format하여 UI 가독성을 높일 수 있습니다
private String getCommaSeparatedPrice (long price) {
    return String.format(Locale.getDefault(), "₩%,d", price);
}

Step 3: NativeAd 오브젝트로 레이아웃 구성

Step 1 의 onAdLoaded 에서 받은 NativeAd 오브젝트를 이용하여 광고 뷰를 그립니다.

1. 위 Step 2에서 생성한 광고 컴포넌트 뷰에 NativeAd.getAd() 를 통해 가져온 Ad 의 각 요소를 세팅합니다.

2. clickableViews list를 생성하여 광고 클릭이 가능하도록 설정할 영역을 지정합니다. 해당 뷰 영역을 클릭 시 광고 랜딩 페이지로 이동하게 됩니다.

3. NativeAdView 에 clickableViews, MediaView, NativeAd 를 세팅합니다.

4. 광고 참여 완료 후 UI 변경을 위해 NativeAdView 에 OnNativeAdEventListener 를 등록하고, onParticipated 콜백에서 해당 광고에 참여하였음을 표시합니다.

   public void populateAd(final NativeAd nativeAd) {
       final NativeAdView view = findViewById(R.id.native_ad_view);
   
       final Ad ad = nativeAd.getAd();
       final Creative.Type creativeType = ad.getCreative() == null ? null : ad.getCreative().getType();
       
       final MediaView mediaView = view.findViewById(R.id.mediaView);
       final TextView titleTextView = view.findViewById(R.id.textTitle);
       final ImageView iconView = view.findViewById(R.id.imageIcon);
       final TextView descriptionTextView = view.findViewById(R.id.textDescription);
       final CtaView ctaView = view.findViewById(R.id.ctaView);
       final CtaPresenter ctaPresenter = new CtaPresenter(ctaView); // CtaView should not be null
       ctaPresenter.bind(nativeAd);
   
       // 1) Assign Ad Properties.
       if (mediaView != null) {
           mediaView.setCreative(ad.getCreative());
           mediaView.setVideoEventListener(new VideoEventListener() {
               // Override and implement methods
           });
       }
   
       if (titleTextView != null) {
           titleTextView.setText(ad.getTitle());
       }
   
       if (iconView != null) {
           ImageLoader.getInstance().displayImage(ad.getIconUrl(), iconView);
       }
   
       if (descriptionTextView != null) {
           descriptionTextView.setText(ad.getDescription());
       }
   
       // 2) Create a list of clickable views.
       final List<View> clickableViews = new ArrayList<>();
       clickableViews.add(ctaView);
       clickableViews.add(mediaView);
       clickableViews.add(titleTextView);
       clickableViews.add(descriptionTextView);
   
       // 3) Register ClickableViews, MediaView and NativeAd to NativeAdView.
       nativeAdView.setClickableViews(clickableViews);
       nativeAdView.setMediaView(mediaView);
       nativeAdView.setNativeAd(nativeAd);
   
       // Advanced : 광고 View를 Scale 해서 사용하는 경우에 한하여 적용
       // nativeAdView.setScaleValue(SCALE_X_VALUE, SCALE_Y_VALUE);
   
       // 4) Add OnNativeAdEventListener to NativeAdView and implement participated UI.
       nativeAdView.addOnNativeAdEventListener(new NativeAdView.OnNativeAdEventListener() {
           @Override
           public void onImpressed(@NonNull NativeAdView view, @NonNull NativeAd nativeAd) {
   
           }
   
           @Override
           public void onClicked(@NonNull NativeAdView view, @NonNull NativeAd nativeAd) {
               // Action형 광고에 대한 CTA 처리
               ctaPresenter.bind(nativeAd);
           }
   
           @Override
           public void onRewardRequested(@NonNull NativeAdView view, @NonNull NativeAd nativeAd) {
               // 퍼블리셔 기획에 따라 리워드 로딩 이미지를 보여주는 등의 처리
           }
   
           @Override
           public void onRewarded(@NonNull NativeAdView view, @NonNull NativeAd nativeAd, @Nullable RewardResult rewardResult) {
               // 리워드 적립의 결과 (RewardResult) SUCCESS, ALREADY_PARTICIPATED, MISSING_REWARD 등에 따라서 적절한 유저 커뮤니케이션 처리
           }
   
           @Override
           public void onParticipated(@NonNull NativeAdView view, @NonNull NativeAd nativeAd) {
               // 퍼블리셔 기획에 따라 UI 처리
               ctaPresenter.bind(nativeAd);
           }
       });
   }

   
   

5. (Optional) 광고의 상태별 콜백에 대해 다양한 커스터마이즈를 원하는 경우 콜백의 정의 및 동작은 광고 노출/클릭/참여와 관련한 콜백 변화 문서 참고

6. (Optional) 광고의 디자인 커스터마이즈를 원하는 경우 하단의 Advantage Usage - 디자인 커스터마이즈를 참고