IOS Native

광고 요청

광고를 조회하는 API 입니다.

Request

completion type은 각각 성공과 실패시 내려오는 type을 뜻합니다.

PHADSResponseModel은 아래 Response 부분을 참고해주세요.

Name	Type	Require	Desc
userKey	String	require	사용자 Key
placementID	String	require	광고 지면 ID
deviceADID	String	optional	기기 광고 ID. 없을 경우 nil 전달.
completion	<PHADSResponseModel, PointHomeError>	require	success, fauilre 콜백

Response

응답 값은PHADSResponseModel입니다. 이 모델의 ads 속성은 PHADSItemsModel의 배열로 이루어져 있습니다.

Name	Type	Desc
ads	[ PHADSItemsModel]	[광고 items model]

다음은 PHADSItemsModel 속성들입니다.

Name	Type	Desc
placementID	String?	광고 지면 ID
advertiseID	String?	광고 ID
title	String?	타이틀
imageUrl	String?	이미지 URL
reward	Int?	보상
landingUrl	String?	랜딩 페이지 URL
useInAppBrowser	Bool?	앱 내 브라우저 사용 여부

Code - getADPlace

// request
PointHomeADS().getADPlace(userKey: {userKey}, placementID: {placeMentID}){ result in
    switch result {
    case .success(let item):
        // item - PHADSResponseModel
        print("getAdPlace item \(item[0])")
    case .failure(let error):
        // error - PointHomeError
        print(getAdPlace failed \(error))
}

---

광고 임프레션

사용자에게 광고가 노출될 경우 호출하는 API 입니다.

주의사항

광고 노출여부를 확인하기 위해 실행하는 메소드입니다. 매 광고마다 광고가 노출되었을 때, 해당 메소드를 호출해주세요.

호출되지 않을 경우 광고 매출정산이 맞지 않을 수 있습니다.

Request

completion Type은 각각 성공과 실패시 내려오는 type을 뜻합니다.

Name	Type	Require	Desc
userKey	String	require	사용자 Key
placementID	String	require	광고 지면 ID
advertiseID	String	require	광고 ID
deviceADID	String	optional	기기 광고 ID. 없을 경우 nil 전달.
deviceID	String	optional	기기 ID. 없을 경우 nil 전달.
completion	<Bool, PointHomeError>	require	success, fauilre 콜백

Response

없음

Code - postADSImpression

// impression
PointHomeADS().postADSImpression(userKey: {userKey}, placementID: {placementID}, advertiseID: {avertiseID}) { result in 
  switch result {
  case .success(let item):
    // item - Bool
    print("postADSImpression success \(item)")
  case .failure(let error):
    // error - PointHomeError
    print("postADSImpression failure \(error)")
  }
}

---

광고 클릭

사용자가 광고를 참여한 경우 호출하는 API입니다.

Request

completion Type은 각각 성공과 실패시 내려오는 type을 뜻합니다. PointHomeError는 아래 에러타입을 참고하세요

Name	Type	Require	Desc
userKey	String	require	사용자 Key
placementID	String	require	광고 지면 ID
advertiseID	String	require	광고 ID
deviceADID	Stirng	optional	기기 광고 ID. 없을 경우 nil 전달.
deviceID	String	optional	기기 ID. 없을 경우 nil 전달.
completion	<Bool, PointHomeError>	require	success, fauilre 콜백

Response

없음

Code - postADSClick

// adClick
PointHomeADS().postADSClick(userKey: {userKey}, placementID: {placementID}, advertiseID: {advertiseID}) { result in 
    switch result {
    case .success(let item):
        // item - Bool
        print("postADSClick success \(item)")
    case .failure(let error):
        // error - PointHomeError
        print("postADSClick failure \(error)")
    }
}

---

에러타입

PointHomeError 속성.

code	type	message
1000	EXCEPTION	문제가 발생하였습니다.
9002	NETWORK_ERROR	네트워크 연결이 원활하지 않습니다
9100	UNAUTHORIZE_ERROR	인증이 만료되었습니다.
5000	SERVER_ERROR	에러가 발생하였습니다. 아바티에 문의해주세요.
2000	INVALID_PARAMETER	파라미터가 알맞지 않습니다.
5003	IN_MAINTENANCE	서비스 점검 중입니다.