Versions Compared

Old Version 9

changes.mady.by.user Dio Heo

Saved on

compared with

New Version Current

changes.mady.by.user Olivia Kim

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

목차

Table of Contents
minLevel1
maxLevel1
exclude목차

개요

본 가이드에서는 여기에서는 BuzzAd Android Android용 SDK의 Pop 지면의 지면에서 구현하는 기능을 설명하고 각 기능을 변경하는 방법을 설명합니다.

...

PopConfig

...

설정하기

PopConfig를 통해 Pop의 사용해 기존 Feed 지면과 별개의 Unit ID로 Pop 지면을 관리하거나 FeedConfig을 통해 설정된 기능 외에 다른 기능을 설정할 수 있습니다. 6.2.1 기본 설정 에서의 기본 Pop 설정과는 다른 기능이나 UI를 적용하고 싶을 때, 혹은 Default Feed와 다른 Unit ID를 사용하고 싶을 때는 사용합니다.
다음은 PopConfig를 BuzzAdBenefitConfig에 추가하는 예시입니다.

Code Block
languagejava
final FeedConfig popFeedConfig = new FeedConfig.Builder("YOUR_POP_UNIT_ID").build();
final PopConfig popConfig = new PopConfig.Builder(popFeedConfig)
                      .build();
        
final BuzzAdBenefitConfig buzzAdBenefitConfig = new BuzzAdBenefitConfig.Builder(context)
        ...생략...
        .setPopConfig(popConfig)
        .build();
        
BuzzAdBenefit.init(this, buzzAdBenefitConfig);

Pop 활성화 버튼

...

Feed 지면에 Pop 지면 활성화 버튼을 표시할 수 있습니다. 사용자는 Pop 지면 활성화 버튼을 통해 자연스럽게 Pop 을 활성화할 수 있습니다.

사용자에게 Pop 활성화 버튼을 표시하는 방법은 다음과 같습니다.

PopConfig를 설정하지 않고, FeedConfig를 아래와 같이 설정한 경우

...

 Info
FeedConfig로 설정하는 기능에 대한 자세한 내용은 Feed 고급 설정 토픽을 참고하세요.
Pop 표시 시간 변경하기
Pop 버튼이 뜬 후 사라지기 전까지 노출되는 시간을 수정할 수 있습니다. 초기 설정 값은 5초입니다.
 Code Block
languagejava
PopConfig popConfig = new 
...
PopConfig.Builder(
...
feedConfig)
    .idleTimeInMillis(5000) //Pop 표시 
...
시간
    
...
.build();
PopConfig를 설정한 경우
...
languagejava
...
Pop 표시 위치 변경하기
사용자가 기기의 화면을 잠금해제할 때마다 Pop이 표시되는 위치를 설정할 수 있습니다. 초기 설정 값은 SidePosition.Side.RIGHT, 0.6f(사용자 기기 화면 우측에서 상단 기준으로 60% 높이)입니다.
 Code Block
languagejava
PopConfig popConfig = new PopConfig.Builder(feedConfig)
    .initialSidePosition(SidePosition(SidePosition.Side.RIGHT, 0.6f)) // Pop 표시 위치
    
...
.build();
...
위의 조건을 충족하도록 연동했다면, Pop을 활성화하지 않은 사용자에게 Pop 활성화 버튼이 보입니다. 
Pop 활성화 버튼을 표시하지 않기 위해서는 아래와 같이 설정해야합니다. 위의 표시 가능 조건과 무관하게 Pop 활성화 버튼은 보이지 않습니다. 
 Code Block
languagejava
final FeedConfig feedConfig = new FeedConfig.Builder("YOUR_POP_UNIT_ID")
        .optInAndShowPopButtonHandlerClass(null) // Pop 활성화 버튼 숨김
        .build();
Pop Service Notification 자체 구현
...
Pop이 정상적으로 동작하기 위해서 Service 를 필요로 합니다. 그래서 Pop이 활성화되어 있는 동안에 Service Notification이 보입니다. 
다음은 Service Notification 을 직접 구현하여 BuzzAd Android SDK에서 제공하는 Notification 을 대체하는 방법을 안내합니다. Notification의 동작, UI 레이아웃까지 직접 구현하여 수정할 수 있습니다. 만일 BuzzAd Android SDK에서 제공하는 Notification 을 기반으로 간단한 UI 수정을 원하는 경우는 Notification UI 수정을 참고하시기 바랍니다. 
Pop Notification 을 수정하기 위해서는 PopControlService 의 상속 클래스를 구현합니다. 필요에 따라 notificationChannel 을 생성하거나 View 를 등록할 수 있습니다. NotificationId는 PopNotificationConfig에서 설정할 수 있습니다. 구현한 상속 클래스는 Manifest에 등록해야 합니다.
 PopControlService 은 몇 가지 편리한 기능을 제공합니다. 필요에 따라 사용할 수 있습니다.
...
API
...
설명
...
getPopPendingIntent(unitId, context)
...
Pop 지면으로 진입하는 PendingIntent 를 제공합니다.
...
Pop 포그라운드 서비스 알림 자체 구현하기
PopConfig를 사용해 Pop 포그라운드 서비스 알림을 직접 구현해 알림의 동작과 UI 레이아웃을 변경할 수 있습니다.
Pop을 사용하면 Pop의 포그라운드 서비스 알림이 활성화되며 PopConfig를 사용해 직접 구현하지 않으면 사용자 모바일 기기 상단의 알림 창에는 BuzzAd Android용 SDK에서 기본으로 제공하는 포그라운드 서비스 알림이 표시됩니다. 
 Info
BuzzAd Android용 SDK에서 기본으로 제공하는 포그라운드 서비스 알림의 디자인을 변경하려면 Pop 포그라운드 서비스 알림 디자인 변경하기 토픽을 참고하세요.
...
Pop 포그라운드 서비스 알림을 직접 구현하려면 다음의 절차를 따르세요.
  1. PopControlService의 상속 클래스를 구현하세요. 
    •  notificationChannel을 생성하거나 View를 등록할 수 있습니다.
    • getPopPendingIntent(unitId, context)으로 Pop 지면으로 진입하는 PendingIntent를 이용할 수 있습니다.
      다음은 PopControlService의 상속 클래스를 구현하는 예시입니다. 
       Code Block
      languagejava
      public class YourControlService extends PopControlService {

    @Override
    protected Notification buildForegroundNotification(@NonNull String unitId, @NonNull PopNotificationConfig popNotificationConfig) {
        // Pop을 표시하는 PendingIntent (원형 아이콘)
        PendingIntent popPendingIntent = getPopPendingIntent(unitId, this);

        // 필요에 따라 notificationChannel을 등록합니다.
        NotificationCompat.Builder builder;
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
            createNotificationChannelIfNeeded();
            builder =
...
    •  new NotificationCompat.Builder(this, NOTIFICATION_CHANNEL_ID);
        } 
...
    • else {
            builder = new NotificationCompat.Builder(this
...
    • );
        }
...
    • 

        // Pop Service Notification 에 사용할 View 를 등록합니다.
        RemoteViews 
...
    • remoteView = new 
...
    • RemoteViews(getPackageName(), R.layout.view_custom_notification);
        
...
    • builder.setSmallIcon(popNotificationConfig.getSmallIconResId())
         
...
    •  
...
    •  
...
    •  
...
    •  
...
    •  
...
    •  
...
    •  
...
    • .setContent(remoteView)
   
...
    •  
...
    •  
...
    •  
...
    •  
...
    •          
...
    • .
...
    • setContentIntent(popPendingIntent)
                .
...
    • setPriority(
...
    • PRIORITY_LOW)
                .
...
    • setShowWhen(
...
    • false);
        if (popNotificationConfig.getColor() != null) {
            builder.setColor(popNotificationConfig.
...
    • getColor(
...
    • ));
        }
        return builder.
...
    • build(
...
    • );
    }

   
...
    •  @TargetApi(
...
    • Build.VERSION_CODES.O)

...
    •  
...
    •  
...
    •   protected void createNotificationChannelIfNeeded() {
  
...
    •       final NotificationManager notificationManager 
...
    • = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
        
...
    • if 
...
    • (notificationManager.
...
    • getNotificationChannel(
...
    • NOTIFICATION_CHANNEL_ID) == null) {
    
...
    •       
...
    •   final NotificationChannel channel 
...
    • = 
...
    • new 
...
    • NotificationChannel(NOTIFICATION_CHANNEL_ID, NOTIFICATION_CHANNEL_NAME, NotificationManager.IMPORTANCE_LOW);
       
...
    •  
...
    •  
...
    •  
...
    •  
...
    •  channel.setShowBadge(false);
        
...
    •     
...
    • notificationManager.
...
    • createNotificationChannel(channel);
        }
    }
}
    • notificationId는 PopNotificationConfig 객체에 설정하세요. 다음의 예시를 참고하세요.
       Code Block
      languagejava
      final 
...
    • PopNotificationConfig 
...
    • popNotificationConfig = new 
...
    • PopNotificationConfig.Builder(context)
                
...
    • .
...
    • notificationId(
...
    • NOTIFICATION_ID)
                
...
    • .
...
    • build(
...
    • );

final FeedConfig popFeedConfig = new 
...
languagejava
...
    • FeedConfig.Builder("YOUR_POP_UNIT_ID").build();
final PopConfig popConfig = new 
...
    • PopConfig.Builder(
...
    • popFeedConfig)
...
    • 
        
...
    • .popNotificationConfig(popNotificationConfig)
        .
...
    • controlService(YourControlService.class)
...
    • 
   
...
    •  
...
    •  
...
    •  
...
    •  
...
    •  
...
    • .build();

final 
...
    • BuzzAdBenefitConfig 
...
    • buzzAdBenefitConfig = new 
...
    • BuzzAdBenefitConfig.Builder(
...
    • context)
        .
...
    • setPopConfig(
...
    • popConfig)
        .
...
    • build();
  2. 구현한 상속 클래스를 AndroidManifest.xml 에 service로 등록하세요.
     Code Block
    languagexml
    <!-- AndroidManifest.xml -->

<application
    <service android:name=".YourControlService" />
</application> 
Pop 활성화 버튼 숨기기
Pop 지면을 추가하면 기존에 연동한 Feed에 Pop 활성화 버튼이 자동으로 표시됩니다. Pop을 활성화하지 않은 사용자는 이 버튼을 통해 자연스럽게 Pop을 활성화할 수 있으며, Pop을 한 번 활성화하면 버튼은 Feed 지면에서 사라집니다.
...
Pop 활성화 버튼을 숨기려면 optInAndShowPopButtonHandlerClass(null)을 호출하세요.
 Code Block
languagejava
// AndroidManifest.xml

<application
    ...생략...
 final FeedConfig feedConfig = new FeedConfig.Builder("YOUR_POP_UNIT_ID")
       <service android:name=".YourControlService" />
 .optInAndShowPopButtonHandlerClass(null) // Pop 활성화 버튼 숨김
       ...생략...
</application>
툴바 영역 View 자체 구현
...
Pop지면의 툴바 영역의 UI를 변경할 수 있습니다. Buzzvil Android SDK가 제공하는 UI을 이용하여 변경하는 방법과 사용하지 않고 변경하는 방법이 있습니다. 
 Table of Contents
minLevel2
maxLevel7
include(SDK가 제공하는 UI를 이용하여 변경)|(UI를 직접 구현하여 변경)
SDK에서 제공하는 UI를 이용하여 변경
...
기본으로 제공되는 UI를 이용하여 변경하는 방법입니다. 간단하지만 제약이 있습니다.
DefaultPopToolbarHolder의 상속 클래스는 구현하여 툴바를 변경합니다. SDK에서 제공하는 PopToolbar 를 이용하여 정해진 레이아웃에서 변경합니다. 상속 클래스는 PopConfig의 feedToolbarHolderClass에 설정합니다. 
...
 .build();
툴바 자체 구현하기
Pop 지면 내 툴바의 디자인을 변경할 수 있습니다. 툴바 영역의 UI를 변경하는 방법은 2가지입니다. 아래 2가지 방법 중 하나를 선택하여 연동하세요.
...
SDK 기본 UI 사용하기
BuzzAd Android용 SDK에서 제공하는 기본 UI를 수정하여 Pop 지면 툴바의 디자인을 변경할 수 있습니다.
...
BuzzAd Android용 SDK에서 제공하는 기본 UI의 디자인을 변경하려면 DefaultPopToolbarHolder를 상속받은 클래스를 구현하고 기본 UI인 PopToolbar 를 사용하여 레이아웃에서 변경합니다. 그리고 FeedConfig의 feedToolbarHolderClass에 구현한 클래스를 추가합니다.
다음은 BuzzAd Android용 SDK에서 제공하는 UI를 이용하여 Pop 지면의 툴바를 직접 구현하는 예시입니다.
 Code Block
languagejava
class YourPopToolbarHolder extends DefaultPopToolbarHolder {
    @Override
    public View getView(Activity activity, @NonNull final String unitId) {
        toolbar = new PopToolbar(activity); // PopToolbar 에서 제공하는 기본 Template 사용
        toolbar.setTitle("TemplatePopToolbarHolder"); // 툴바 타이틀 문구를 변경합니다.
        toolbar.setIconResource(R.mipmap.ic_launcher); // 툴바 좌측 아이콘을 변경합니다. 
        toolbar.setBackgroundColor(Color.LTGRAY); // 툴바 배경색을 변경합니다.

        addSettingsMenuItemView(activity, unitId); // 메뉴 버튼 추가 (메뉴 안에 문의하기 버튼이 있습니다)
//        addInquiryMenuItemView(activity, unitId); // 문의하기 버튼은 이 함수를 통해 간단하게 추가 가능합니다.
        addRightMenuItemView(activity, unitId); // custom 버튼 추가
        return toolbar;
    }

    // custom 버튼 추가는 toolbar.buildPopMenuItemView 를 사용하여 PopMenuImageView 를 생성하고
    // toolbar.addRightMenuButton 를 사용하여 toolbar 에 추가합니다.
    private void addRightMenuItemView(@NonNull final Activity activity, @NonNull final String unitId) {
        PopMenuImageView menuItemView = toolbar.buildPopMenuItemView(activity, R.mipmap.ic_launcher);
        menuItemView.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                showInquiry(activity, unitId); // 문의하기 페이지로 연결합니다. 
            }
        });
        toolbar.addRightMenuButton(menuItemView);
    }
}
FeedConfig에 FeedConfig에 Pop 지면을 추가한 경우에는 다음의 예시를 참고하여 YourPopToolbarHolder를 설정합니다설정하세요. 
 Code Block
languagejava
final FeedConfig popFeedConfig = new FeedConfig.Builder("YOUR_POP_UNIT_ID")
  
 ...생략...     .feedToolbarHolderClass(YourPopToolbarHolder.class)
    .build();
new PopConfig.Builder(popFeedConfig)
    ...생략...
    .build();;
직접 구현한 Custom View 사용하기
BuzzAd Android용 SDK에서 제공하는 UI를 사용하지 않고 직접 Custom View를 
...
구현하여 Pop지면의 툴바를 변경할 수 있습니다.
...
SDK에서 제공하는 PopToolbar를 사용하지 않고 직접 구성한 레이아웃을 사용합니다. DefaultPopToolbarHolder를 상속해 새로운 클래스를 구현하고, 구현한 상속 클래스는 PopConfig에 설정합니다.
다음은 레이아웃을 직접 구성하여 구현하는 예제입니다.
...
다음은 Custom View를 직접 생성하여 툴바를 변경하는 예시입니다. 이 예시에서는 DefaultPopToolbarHolder의 상속 클래스를 구현합니다. 그런 다음 PopConfig에 구현한 클래스를 추가합니다.
 Code Block
languagejava
public class YourPopToolbarHolder extends DefaultPopToolbarHolder {
    @Override
    public View getView(Activity activity, @NonNull final String unitId) {
        // 직접 구성한 layout 을 사용합니다
        ViewGroup root = (ViewGroup) activity.getLayoutInflater().inflate(R.layout.your_pop_custom_toolbar_layout, null);

        View buttonInquiry = root.findViewById(R.id.yourInquiryButton);
        buttonInquiry.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                // 문의하기 페이지 열기
                showInquiry(activity, unitId);
            }
        });
        return root;
    }
}
 
 Code Block
languagejava
final FeedConfig popFeedConfig = new FeedConfig.Builder("YOUR_POP_UNIT_ID")
    ...생략...
    .feedToolbarHolderClass(YourPopToolbarHolder.class)
    .build();
new PopConfig.Builder(popFeedConfig)
    ...생략...
    .build();
Pop 유틸리티 영역 
...
변경하기
Pop 지면 우측 하단의 유틸리티 영역에는 앱 메뉴 실행, 다른 페이지로 이동 등 원하는 기능을 추가할 수 있습니다.
...
다음은 유틸리티 영역을 변경하는 예시입니다. PopUtilityLayoutHandler의 상속 이 예시에서는 PopUtilityLayoutHandler를 상속받는 클래스를 구현하고, 구현한 Custom View(your_pop_utility_view)를 추가합니다. 그리고 그런 다음 FeedConfig에 구현한 클래스를 추가합니다.
...
info
 Code Block
languagejava
new PopConfig.Builder(popFeedConfig)
      .popUtilityLayoutHandlerClass(CustomPopUtilityLayoutHandler.class)
      .build();
유틸리티 영역 아이콘 
...
추천 이미지 사이즈
...
24*24 dp (mdpi 기준)
...
이미지 규격
유틸리티 영역에 추가하는 기능의 아이콘의 이미지 규격은 아래의 표를 참고하세요.
항목
규격
이미지 유형
픽셀 또는 벡터 이미지
사이즈
  • mdpi 기준: 24 x 24 dp
  • 96 x 96 px (xxxhdpi까지 지원, 
...
  • 픽셀 기준 최대 4배)
...
아이콘은 PNG 와 벡터이미지가 모두 가능합니다.
색상
흑백 또는 채색
커스텀 페이지 
...
추가하기
Pop 지면을 이용하여 원하는 내용을 표시할 지면에 직접 내용을 구성하는 커스텀 페이지를 추가할 수 있습니다. 커스텀 페이지는 툴바와 컨텐츠로 이루어져있습니다.
...
콘텐츠로 구성됩니다. 툴바에는 타이틀을 설정할 수 
...
컨텐츠영역에 원하는 Fragment를 설정할 수 있습니다. 
아래 예시 코드에 따라 구현할 수 있습니다.
있으며, 콘텐츠 영역에는 원하는 프래그먼트를 설정할 수 있습니다.
...
커스텀 페이지를 추가하려면 기본 Pop 지면의 툴바를 직접 구현하거나 Pop 유틸리티 영역을 변경할 때 아래의 코드를 추가하세요.
 Code Block
languagejava
new PopNavigator().launchCustomFragment(
    context,
    new CustomInAppLandingInfo(
        new YourFragment(),
        R.stirng.your_title
    )
);
...
 Info
커스텀 페이지의 유틸리티 영역과 툴바도 기본 Pop 지면과 동일한 방법으로 변경할 수 있습니다.