Hive Adiz iOS

Hive Adiz iOS는 AdMob에서 제공하는 광고 노출 기능을 더 편하게 쓸 수 있도록 Hive에서 제공하는 iOS용 광고 모듈입니다. Hive Adiz iOS가 제공하는 광고 형태는 다음과 같습니다.

  • 전면 광고(Interstitial)
  • 배너 광고(Banner)
  • 네이티브 광고(Native)
  • 보상형 광고(Rewarded)
  • 보상형 전면 광고(Rewarded Interstitial)
  • 앱 오프닝 광고(AppOpen)

Hive Adiz iOS를 설치하고 사용하려면 아래 가이드를 순서대로 참고하세요.

설치

Xcode 프로젝트의 Info.plist 파일에 GADApplicationIdentifier 키를 추가하고, AdMobId 값(ca-app-pub-XXXXX~YYYYY 형식)을 키의 값으로 입력합니다.

 

추가로, iOS 14 이상에서는 Update your info.plist 가이드를 참고해 SKAdNetwork 목록을 Info.plist 파일에 추가합니다.

 

그 다음, 프로젝트의 CocoaPods 설정(Podfile)에 다음 내용을 추가합니다.

 

$pod install로 CocoaPod 설정을 적용합니다.

테스트 모드 설정

개발 단계에서는 테스트 광고를 클릭해도 광고주에게 비용을 청구하지 않도록 테스트 모드를 활성화합니다. 테스트 모드를 활성화하면 테스트 광고만 노출됩니다. 테스트 모드에서는 Hive 콘솔에 AdMob 광고 키를 입력하지 않아도 테스트 광고를 노출합니다. 상용 배포 시에는 테스트 모드를 비활성화합니다.

Swift

Objective-C

Hive Adiz AppID 설정

Hive 콘솔 AppCenter에 등록했던 Hive Adiz AppID를 설정합니다. 미설정 시 Bundle ID를 사용합니다.

Swift

Objective-C

Hive 콘솔 서버 설정

사용할 Hive 콘솔 서버를 설정합니다. 기본값은 real입니다. 상용 서버를 사용하더라도 테스트 모드를 활성화하면 테스트 광고만 노출합니다.

  • Hive 테스트 콘솔 서버: AdizZoneType.test
  • Hive 샌드박스 콘솔 서버: AdizZoneType.sandbox
  • Hive 상용 콘솔 서버: AdizZoneType.real
Swift

Objective-C

사용자 특화 광고 노출

iOS 14.5+에서 ATT(App Tracking Transparency) 도입으로 개인 정보 보호가 강화되었습니다. 이에 따라, ATT 동의 팝업에서 사용자가 활동 추적에 동의한 경우에만 사용자에 특화된 광고를 노출할 수 있습니다. 사용자에 특화된 광고를 노출하여 광고 수익을 극대화하려면 IDFA(Identifier for Advertisers) 메세지를 작성해야 합니다.

AdMob 대시보드에서 아래 IDFA 메세지 작성 가이드를 따라 메세지를 작성하고 게시하세요.

AdMob 대시보드에 IDFA 메세지를 게시하면, iOS 14.5+에서 Hive Adiz 초기화 시 자동으로 IDFA 메세지가 노출됩니다. IDFA 메세지 창에서 사용자가 “계속”을 클릭하면 ATT 동의 팝업이 노출됩니다.

ATT 동의 팝업에서 사용자가 “허용을” 클릭하면 IDFA가 활성화되며, 사용자에 특화된 광고가 노출됩니다.

GDPR 동의 팝업 노출(유럽, 영국)

게임이 유럽 및 영국(EEA & UK)을 타겟팅하는 경우, GDPR(유럽 연합 일반 데이터 보호 규칙) 동의 팝업을 노출해야 합니다. GDPR 동의 팝업은 유저 기기 IP 주소가 유럽 및 영국(EEA & UK) IP 주소인 경우에만 노출됩니다. Hive Adiz는 GDPR 동의 팝업 노출을 위해 Google UMP(User Messaging Platform)를 지원합니다. GDPR 팝업을 노출하려면, AdMob 콘솔에서 GDPR 메시지를 작성한 후에 Hive Adiz를 초기화해야 합니다. 유럽 및 영국에서 앱을 서비스할 계획이 없다면, 이 단계를 건너뛰고 Hive Adiz 초기화를 진행하세요.

GDPR 메시지 작성

Google AdMob 콘솔에 접속하여 GDPR 메시지를 작성합니다. GDPR 메시지를 작성하기 전에, 먼저 GDPR 메시지 작성 가이드를 참고하세요.

GDPR 메시지를 작성했다면 Hive Adiz 초기화 시 자동으로 GDPR 동의 팝업이 노출됩니다.

GDPR 동의/철회 기능 구현

GDPR 동의 팝업에 있는 항목들은 유저가 동의 여부를 언제든지 수정할 수 있도록 수정 기능을 제공해야 합니다. 예를 들어, 유저가 처음에는 GDPR에 동의하지 않았지만 맞춤 광고를 보기 위해 다시 동의를 원하거나, 반대로 처음에는 GDPR에 동의했지만 더는 개인 정보를 제공하고 싶지 않아 동의 철회를 원할 수 있습니다. 이러한 상황에 대응하려면 앱 개발사는 각 항목에 다시 동의하거나 기존 동의를 철회하는 기능을 구현해야 합니다. GDPR 동의/철회 기능을 구현하려면 다음 단계를 따릅니다.

  1. GDPR 동의 팝업창을 다시 불러올 수 있는 버튼 UI를 앱에 구현합니다.
  2. Hive Adiz 초기화 구현 시 isPrivacyOptionsRequired()를 호출하여, 유럽 및 영국에서 접속하는 유저에게는 위 버튼 UI를 표시하고, 그렇지 않은 경우에는 표시하지 않도록 구현합니다. 유럽 및 영국에서 접속하는 유저가 위 버튼을 누르면 showPrivacyOptionsForm을 호출하여 GDPR 동의 팝업창을 다시 불러옵니다. 그러면, 유저는 앱에서 언제든지 “Manage Options”와 같은 버튼을 눌러서 GDPR 세부 항목 동의 여부를 수정할 수 있습니다. 아래 showPrivacyOptionsForm은 예시를 위해 임의로 구현한 메서드이며, 개발사에서 원하는 형태로 구현을 변경할 수 있습니다.
  3. Swift

    Objective-C

GDPR 테스트 기기 설정

GDPR 동의 팝업은 기기 IP 주소가 유럽 및 영국 IP 주소일 경우에만 노출됩니다. 개발 단계에서는 IP 주소와 상관 없이 GDPR 동의 팝업을 강제로 노출하여 팝업 노출을 테스트할 수 있으며, 이를 위해 GDPR 테스트 기기를 설정해야 합니다. GDPR 테스트 기기 설정을 위해 아래 단계를 따르세요.

  1. Hive Adiz를 초기화합니다. 테스트 기기 ID를 확인하기 위한 초기화이며 GDPR 동의 메시지를 작성할 필요가 없습니다.
  2. 디버그 로그에서 기기 ID를 확인할 수 있는 메세지를 확인합니다. 아래 메세지는 예시입니다.

    To enable debug mode for this device, set: UMPDebugSettings.testDeviceIdentifiers = @[B74F6468-1516-467C-99AD-CC5973C5DB52]

    메시지에서 기기 ID(예시: B74F6468-1516-467C-99AD-CC5973C5DB52)를 확인합니다.

  3. 기기 ID를 복사합니다.
  4. 기존 Hive Adiz 초기화 코드에서 Adiz.initialize 실행 전에 AdizGDPRManager.setTestDevice(DEVICE_ID)를 추가합니다.
  5. GDPR 동의 메시지를 작성하고 Hive Adiz를 다시 초기화하여 GDPR 동의 팝업이 잘 나타나는지 확인합니다.
Swift

Objective-C

Hive Adiz 초기화

모든 타입의 광고를 노출하기 전 필수적으로 수행해야 하는 단계입니다. Hive Adiz 초기화를 하면 광고를 노출하는 데 필요한 광고 키를 받을 수 있습니다. 테스트 모드를 활성화한 상태라면 테스트 키를 받습니다. Hive SDK를 사용중이라면 AuthV4.setup을 호출한 이후 Adiz 초기화를 진행합니다.

Swift

Objective-C

 

초기화 실행 시 콜백으로 받는 JSON 파일에는 광고 키 목록이 있습니다. 광고 키 목록은 다음과 같은 형식을 가집니다.

 

테스트 모드에서 초기화를 하면 AdMob 광고키를 Hive 콘솔에 등록하지 않았어도 테스트용 광고 키 목록을 받습니다. 상용 모드에서 초기화를 하면 Hive 콘솔에 등록한 AdMob 광고 키 목록을 받습니다.

광고 형태(form)마다 한 개 광고는 기본 광고("is_default":true인 광고)로 사용합니다. 어떤 광고 형태를 최초 등록 시, 최초 등록한 광고가 기본 광고가 됩니다. 기본 광고는, 광고 인스턴스를 생성(initialize())할 때 광고 키(hiveAdKey)를 입력하지 않아도 됩니다. 기본 광고를 변경하려면, Hive 콘솔에서 기존 기본 광고를 삭제하고 광고를 새로 등록해야 합니다.

광고 콜백 리스너 설정

각 광고 인스턴스 생성 시 AdizListener를 구현하면 광고 상태 변화에 따라 콜백을 받을 수 있습니다.

명칭 설명 필수 구현
onLoad() 광고 로드 성공 O
onFail(error: AdizError) 실패(error.getCode()error.getMessage()로 실패 이유를 알 수 있음) O
onShow() 광고 노출 성공 O
onClick() 광고 클릭 O
onPaidEvent(_ revenueData: AdRevenueData) 광고 노출 이후 paid event를 받는 시점으로, 광고 수익 정보가 전달됨 O
onClose() 광고 종료

  • 광고가 종료된 후, 동일한 광고 인스턴스에서 광고를 다시 노출하려면 load()를 다시 호출한 후 show()를 호출해야 합니다.
  • 더는 광고를 노출하지 않으려면 destroy()를 호출하여 광고 인스턴스를 제거합니다.
X
onRewarded(_ rewardItem: RewardItem) 보상형 광고(rewarded, rewarded interstitial)에서 광고 노출 후 유저가 보상을 받는 시점 X
Swift

Objective-C

에러 코드

Adiz.InitializeAdizListener에서 onFail()을 받았을 때 AdizError 에러 코드와 에러 메세지는 다음과 같습니다.

공통 코드

Number Case Explanation
0 Success 성공

Adiz 에러 코드

Number Case Explanation
-1 InvalidParam 잘못된 파라미터
-2 NotSupported 지원하지 않음
-3 InProgress 프로세스 진행중 상태
-4 Network 네트워크 에러
-5 NeedInitialize 초기화 필요
-6 ResponseFail 응답 실패
-7 Timeout 네트워크 타임 아웃
-99 Unknown 알 수 없는 에러

광고 플랫폼 에러 코드

Number Case Explanation
-101 NeedLoad 광고가 로드 되지 않았음
-102 NeedReload 광고 노출 시간 만료로 인한 다시 로드 필요
-103 NotEnoughInventory 미디에이션 응답은 성공하였으나 인벤토리 부족으로 채워진 광고가 없음
-104 MissingAppId 미디에이션 요청을 위한 AppID 오류
-105 InternalNetworkError 미디에이션 네트워크 관련 에러
-106 InvalidUnitId 잘못된 Unit Id
-107 MediationNoFill 미디에이션 어댑터가 광고 요청을 처리하지 못함
-108 AlreadyLoaded 이미 로드된 상태
-109 CannotRequestAds 광고를 요청할 수 없음
-201 GdprConsentError GDPR 동의 에러
-202 IsNotPrivacyOptionsRequired GDPR 동의 팝업을 노출할 수 없거나 노출하지 않아도 되는 상태임

광고 노출과 광고 종료

광고를 노출, 종료하려면 다음 순서를 따릅니다.

  1. 노출하려는 광고 형태별로 광고 클래스에서 광고 인스턴스를 생성합니다. 노출하려는 광고가 기본 광고가 아니라면, 초기화에서 얻은 광고 키를 입력해야 합니다. 광고 키(hiveAdKey)를 입력하지 않으면, 기본 광고 인스턴스를 생성합니다.
  2. 노출하려는 광고를 로드(load())합니다.
  3. 로드한 광고를 노출(show())합니다. 광고를 다시 노출하려면 load()를 다시 호출한 후 show()를 호출해야 합니다.
  4. 광고를 종료하려면 destroy()를 호출합니다.

전면 광고 (Interstitial)

화면 전체를 차지하는 전면 광고입니다.

Swift

Objective-C

배너 광고 (Banner)

특정 사이즈의 배너를 노출하는 배너 광고입니다. 배너 광고는 onClose() 콜백을 전달받지 않습니다. 따라서, 다른 위치에서 destroy()를 호출하여 광고를 종료해야 합니다.

 

BannerSize는 표준 배너 크기를 따릅니다.

크기 포인트 (너비x높이) 설명 지원 대상 BannerSize 상수
320×50 배너 휴대전화 및 태블릿 BannerSize.normal
320×100 대형 배너 휴대전화 및 태블릿 BannerSize.medium
300×250 IAB 중간 직사각형 휴대전화 및 태블릿 BannerSize.large
468 x 60 IAB 전체 크기 배너 태블릿 BannerSize.full

 

PositionType은 최상단 혹은 최하단입니다. 기본값은 최하단입니다.

정렬 설명 PositionType 상수
최상단 정렬 SafeArea 기준 화면 최상단 정렬 지정 PositionType.top
최하단 정렬 (기본값) SafeArea 기준 화면 최하단 정렬 지정 PositionType.bottom
Swift

Objective-C

네이티브 광고 (Native)

특정 크기의 Native 템플릿을 노출하는 네이티브 광고입니다. 네이티브 광고는 세로 화면에 최적화되어 있으므로 세로형 게임(세로 화면 게임)에서 사용하는 것을 권장합니다. 네이티브 광고는 onClose() 콜백을 전달받지 않습니다. 따라서, 다른 위치에서 destroy()를 호출하여 광고를 종료해야 합니다.

 

현재 템플릿은 small 또는 medium 사이즈를 지원합니다.

크기 포인트 (너비x높이) 템플릿 정렬 BannerSize 상수
355×91 (비율 조정) small 사이즈 Top / Bottom BannerSize.normal
355×370 (비율 조정) medium 사이즈 Center (고정) BannerSize.medium,
BannerSize.large,
BannerSize.full

 

small 템플릿에서 PositionType은 최상단 혹은 최하단이며 기본값은 최하단입니다.

정렬 설명 PositionType 상수
최상단 정렬 화면 최상단 정렬 지정 PositionType.top
최하단 정렬 (기본값) 화면 최하단 정렬 지정 PositionType.bottom

 

medium 템플릿은 정렬을 선택할 수 없으며, 기본적으로 중앙 정렬을 사용합니다.

 

Swift

Objective-C

보상형 광고 (Rewarded)

유저가 광고를 일정 시간 이상 시청 시 리워드를 받는 보상형 광고입니다. 리워드 지급을 완료하면 onRewarded() 콜백으로 보상 아이템 정보를 받습니다.

Swift

Objective-C

보상형 전면 광고 (Rewarded Interstitial)

유저가 광고를 일정 시간 이상 시청 시 리워드를 받는 보상형 전면 광고입니다. 리워드 지급을 완료하면 onRewarded() 콜백으로 보상 아이템 정보를 받습니다.

Swift

Objective-C

앱 오프닝 광고 (AppOpen)

앱 상태가 백그라운드에서 포그라운드로 변경될 때 미리 로드해놨던(load()) 광고를 노출하는 앱 오프닝 광고입니다. 광고 로드 후 3시간이 경과한 후에 show()를 호출하면, 광고를 자동으로 다시 로드한 후에 광고를 노출합니다. 일단 광고를 한 번이라도 노출한 후에는 광고는 자동으로 로드되지 않습니다.

Swift

Objective-C