광고 요청 정보
AdParam
AdParam 클래스는 광 고 요청에 필요한 다양한 정보를 담은 객체로서 광고 요청에 반드시 필요한 Ad Unit ID를 비롯하여 광고 타겟팅을 위한 다양한 정보를 포함합니다.
AdParam.Builder를 통해 객체를 생성할 수 있고 생성 예시는 아래와 같습니다.
- Kotlin
- Java
val adParam = AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER") // 광고 Unit ID
.setCurrentPageUrl("https://www.naver.com") // 해당 페이지에 대한 설명 link
.setRefererPageUrl("https://www.naver.com") // referer 정보
.addCustomParam("channelId", "41312") // NAM Admin을 통한 타겟팅 설정 및 리포트 지원
.build()
AdParam adParam = new AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER") // 광고 Unit ID
.setCurrentPageUrl("https://www.naver.com") // 해당 페이지에 대한 설명 link
.setRefererPageUrl("https://www.naver.com") // referer 정보
.addCustomParam("channelId", "41312") // NAM Admin을 통한 타겟팅 설정 및 리포트 지원
.build();
AdParam.Builder의 주요 메서드
setAdUnitId()
Ad Unit ID를 설정합니다. 광고를 요청할 경우 반드시 설정해야 하는 필수값입니다.
- Kotlin
- Java
val adParam = AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.build()
AdParam adParam = new AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.build();
addCustomParam()
타겟팅 목적의 사용자 정의 매개변수를 추가합니다. key와 value 값은 NAM 관리자를 통해 확인 및 협의가 필요합니다.
- Kotlin
- Java
val adParam = AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.addCustomParam("channelId", "41312")
.addCustomParam("category", "sports|news") // 여러 값은 | 기호로 구분
.build()
AdParam adParam = new AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.addCustomParam("channelId", "41312")
.addCustomParam("category", "sports|news") // 여러 값은 | 기호로 구분
.build();
setCustomParam()
타겟팅 목적의 사용자 정의 매개변수를 설정합니다. 복수의 사용자 정의 매개변수를 추가할 때 사용할 수 있습니다.
- Kotlin
- Java
val customParams = mapOf(
"channelId" to "41312",
"category" to "sports",
"age" to "25"
)
val adParam = AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.setCustomParam(customParams)
.build()
Map<String, String> customParams = new HashMap<>();
customParams.put("channelId", "41312");
customParams.put("category", "sports");
customParams.put("age", "25");
AdParam adParam = new AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.setCustomParam(customParams)
.build();
setCurrentPageUrl()
타겟팅 목적의 현재 페이지 URL을 설정합니다.
- Kotlin
- Java
val adParam = AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.setCurrentPageUrl("https://www.example.com/current-page")
.build()
AdParam adParam = new AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.setCurrentPageUrl("https://www.example.com/current-page")
.build();
setRefererPageUrl()
타겟팅 목적의 참조 페이지 URL을 설정합니다.
- Kotlin
- Java
val adParam = AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.setRefererPageUrl("https://www.example.com/referer-page")
.build()
AdParam adParam = new AdParam.Builder()
.setAdUnitId("AOS_TEST_BANNER")
.setRefererPageUrl("https://www.example.com/referer-page")
.build();
SDK의 전역 설정
광고 요청마다 설정하는 AdParam 외에, SDK 관련 설정인 SdkProperties와 타겟팅 등에 사용되는 사용자 관련 설정인 UserProperties를 통해 공통 설정을 할 수 있습니다.
SdkProperties
SDK의 전역 설정을 관리하는 오브젝트로서 광고 요청 타임아웃, 음소거 설정, 광고 공급자 옵션 등을 포함합니다.
SdkPropertiesBuilder를 통해 객체를 생성할 수 있고 생성 예시는 아래와 같습니다.
- Kotlin
- Java
GfpSdk.setSdkProperties(GfpSdk.getSdkProperties().buildUpon()
.addProviderOptions(DfpProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(FanProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(UnityProviderOptions.Builder().setTestMode(false).build())
.bannerAdRequestTimeout(60_000L)
.unifiedAdRequestTimeout(60_000L)
.videoAdRequestTimeout(60_000L)
.interstitialAdRequestTimeout(60_000L)
.rewardedAdRequestTimeout(60_000L)
.muteAudio(true)
.theme(ResolvedTheme.SYSTEM)
.build())
GfpSdk.setSdkProperties(GfpSdk.getSdkProperties().buildUpon()
.addProviderOptions(new DfpProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(new FanProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(new UnityProviderOptions.Builder().setTestMode(false).build())
.bannerAdRequestTimeout(60_000L)
.unifiedAdRequestTimeout(60_000L)
.videoAdRequestTimeout(60_000L)
.interstitialAdRequestTimeout(60_000L)
.rewardedAdRequestTimeout(60_000L)
.muteAudio(true)
.theme(ResolvedTheme.SYSTEM)
.build());
SdkPropertiesBuilder의 주요 메서드
addProviderOptions()
일부 광고 제공자의 경우, 광고 제공자별로 제공하는 별도의 기능 설정을 할 수 있습니다.
- Kotlin
- Java
GfpSdk.setSdkProperties(GfpSdk.getSdkProperties().buildUpon()
.addProviderOptions(DfpProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(FanProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(UnityProviderOptions.Builder().setTestMode(false).build())
.build()
)
GfpSdk.setSdkProperties(GfpSdk.getSdkProperties().buildUpon()
.addProviderOptions(new DfpProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(new FanProviderOptions.Builder().setTestMode(false).build())
.addProviderOptions(new UnityProviderOptions.Builder().setTestMode(false).build())
.build()
);
DfpProviderOptions, FanProviderOptions, UnityProviderOptions 는 TestMode 설정을 제공하며 해당 ProviderOptions 를 미설정할 경우에는 TestMode 의 기본값인 false 상태로 설정됩니다.