이 문서는 AP SSP Web SDK를 사용하여 광고를 노출하고 이벤트를 처리하는 방법에 대한 연동 가이드입니다.

1. [공통] SDK 라이브러리 로드

연동이 필요한 페이지에 아래 SDK 스크립트를 추가합니다.

<head>
   <script
      async
      src="<https://webapi.adpopcorn.com/ssp/web-sdk/ap-ssp-web-sdk-1.1.0.min.js>"
    ></script>
</head>

2. [공통] SDK 초기화 및 설정

SDK를 초기화하고 config를 설정해야 합니다. init 함수를 호출하여 **app_key**와 **placement_id**를 설정하고, setConfig 함수를 사용하여 Android 또는 iOS 플랫폼에 따라 해당 운영 체제에 맞는 config를 구성합니다.

[ init 함수 전달용 객체 속성 정의 ]

속성명	구분	기본값	타입	설명
app_key	required	없음	string	매체용으로 발급된 광고 앱 키
placement_id	required	없음	string	매체용으로 발급된 광고 지면 아이디
log_enabled	optional	false	boolean	sdk 세부 로그 출력 유, 무(설정하지 않을 경우, 에러 레벨의 로그만 출력됩니다.)

[ setConfig 함수 전달용 객체 속성 정의 ]

플랫폼	속성명	구분	타입	기본값	설명
Android	adid	required	string	없음	Android 광고 식별자
iOS	idfa	required	string	없음	iOS 광고 식별자
iOS	idfv
optional
(required)	string	없음	벤더 식별자
(단, 광고 추적 미동의로 idfa를 전달할 수 없는 경우 idfv 값을 필수로 전달해야 한다)
Android	android_opt_out_enabled	optional	boolean	true	Android 광고 추적 거부 여부
iOS	ios_ifa_tracking_enabled	optional	boolean	false	iOS 광고 추적 여부
공통	network	optional	mobile	wifi	“”
공통	carrier	optional	string	“”	통신사
공통	model	optional	string	“”	모델명
공통	manufacturer	optional	string	“”	제조사
공통	os_version	optional	string	0	플랫폼 OS 버전

<head>
  <script>
    window.AdPopcornSSPWebSDK = window.AdPopcornSSPWebSDK || { cmd: [] };
    AdPopcornSSPWebSDK.cmd.push(() => {
      AdPopcornSSPWebSDK.init({
        app_key: "...",
        placement_id: "...",
        ...optional,
      });
      
      // android용 config 설정
      AdPopcornSSPWebSDK.setConfig({
        adid: "...",
        ...optional,
      });

      // iOS용 config 설정
      AdPopcornSSPWebSDK.setConfig({
        idfa: "...",
        ...optional,
      });
    });
  </script>
</head>

3. 광고 연동

광고를 노출할 **div** 요소에 **id** attribute를 포함하여 HTML에 추가합니다. 설정한 **id**를 **display** 함수 인자로 전달하면 해당 요소에 광고가 삽입되어 노출됩니다. 실행 스크립트는 **<body>** 요소의 하단에 삽입하는 것을 권장합니다.

3-1. 광고 노출

아래 코드는 광고를 표시할 요소(광고 인벤토리 영역)와 실행 코드를 포함하고 있습니다. SDK에서 제공하는 인스턴스 생성 함수를 사용하여 광고 타입별 인스턴스를 생성하고, display 함수를 사용하여 광고를 표시합니다.

[ 인스턴스 생성 함수 정의] 앱키, 지면 아이디를 전달하면 SDK init 설정과 별개로 인스턴스 개별 설정을 사용할 수 있습니다.

함수명	설명
createInterstitial	전면 광고 인스턴스 생성용
createInterstitialVideo	전면 비디오 광고 인스턴스 생성용

[ 인스턴스 생성 함수 전달용 객체 속성 정의 ] 앱키, 지면 아이디를 전달하면 SDK init 설정과 별개로 인스턴스 개별 설정을 사용할 수 있습니다.

속성명	구분	타입	기본값	설명
app_key	optional	string	없음	매체용으로 발급된 광고 앱 키
placement_id	optional	string	없음	매체용으로 발급된 광고 지면 아이디