Offerwall (프로모션 1.0) 

 

목차

  • 1 상수 및 자료형
    • 1.1 OFFERWALL_RESULT
  • 2 함수
    • 2.1 void CS_OfferwallInitialize(const char* uid, int isUsingStaging, OfferwallCB callback)
    • 2.2 void CS_OfferwallInitializeEx(const char* uid, int isUsingStaging, OfferwallCB callback, OfferwallRewardCB rewardCallback)
    • 2.3 void CS_OfferwallSetLog(int isLog)
      • Deprecated
    • 2.4 void CS_OfferwallShowEx(const char* additionalInfo)
    • 2.5 void CS_OfferwallRewardFinish()
      • Deprecated
    • 2.6 int CS_OfferwallGetState()
    • 2.7 const char* CS_OfferwallGetVersion()
  • 3 콜백 함수
    • 3.1 typedef void (*OfferwallCB)(OFFERWALL_RESULT result)
    • 3.2 void offerwallRewardCallBack(int errorNo, const char* errorMessage, int result, const char* eventID, const char* assetCode, int assetAmount)
      • Deprecated

상수 및 자료형

OFFERWALL_RESULT
오퍼월 UI의 열림(open) 혹은 닫힘(close) 상태 및 기타 상태에 대한 콜백의 응답 값

* C Plugin

    typedef  enum _OFFERWALL_RESULT
    {
        OFFERWALL_OPEN                  = -11, // 오퍼월 노출
        OFFERWALL_CLOSE                 = -12, // 오퍼월 종료
        OFFERWALL_NETWORK_DISCONNECT    = -13, // 네트워크 접속장애
        OFFERWALL_ACTIVATION = -14, // 오퍼월 활성 상태
        OFFERWALL_DEACTIVATION = -15, // 오퍼월 비활성 상태
    }OFFERWALL_RESULT;

    // Deprecated, C2S.19.6
    typedef enum CS_OFFERWALL_REWARD_STATE_
    {
        OFFERWALL_REWARD_CANCEL         = 1,    // 보상 취소
        OFFERWALL_REWARD_FINISH         = 2,    // 보상 지급 완료
        OFFERWALL_REWARD_IN_PROGRESS    = 3,    // 보상 진행중
        OFFERWALL_REWARD_SUCCESS        = 4,    // 보상 성공
    }CS_OFFERWALL_REWARD_STATE;


* Unity Plugin

   // OFFERWALL_RESULT
   public const int OFFERWALL_OPEN                 = -11;
   public const int OFFERWALL_CLOSE                = -12;
   public const int OFFERWALL_NETWORK_DISCONNECT   = -13;
   public const int OFFERWALL_ACTIVATION           = -14;
   public const int OFFERWALL_DEACTIVATION         = -15;

   // (Deprecated, C2S.19.6) OFFERWALL_REWARD_STATE
   public const int    OFFERWALL_REWARD_CANCEL         = 1;
   public const int    OFFERWALL_REWARD_FINISH         = 2;
   public const int    OFFERWALL_REWARD_IN_PROGRESS    = 3;
   public const int    OFFERWALL_REWARD_SUCCESS        = 4;


* Android Native

// OFFERWALL_RESULT
public static final int OFFERWALL_OPEN                  = -11;
public static final int OFFERWALL_CLOSE                = -12;
public static final int OFFERWALL_NETWORK_DISCONNECT   = -13;
public static final int OFFERWALL_ACTIVATION         = -14;
public static final int OFFERWALL_DEACTIVATION       = -15;

// (Deprecated, C2S.19.6) OFFERWALL_REWARD_STATE
public static final int OFFERWALL_REWARD_CANCEL          = 1;
public static final int OFFERWALL_REWARD_FINISH          = 2;
public static final int OFFERWALL_REWARD_IN_PROGRESS   = 3;
public static final int OFFERWALL_REWARD_SUCCESS      = 4;

함수

void CS_OfferwallInitialize(const char* uid, int isUsingStaging, OfferwallCB callback)
  • Description
    - Offerwall 모듈을 초기화하고 콜백을 등록합니다.
    - Unity Plugin의 경우 CS_OfferwallInitializeEx API로 호출바랍니다. (C2S.20.0+)
  • Return Value

void

  • Parameter
in/out Type Name Description
in const char* uid

로그인한 유저의 uid

in int isUsingStaging

모듈 테스트 서버 사용 여부
(C2S.19.6 버전 이후 파라메터 isUsingStaging은 더이상 동작하지 않습니다. ActiveUser 초기화 시 설정한 서버에 영향을 받습니다.)

in OfferwallCB callback

구현한 콜백 함수

  • Remark
    Unity Plugin : public void initializeEx(string uid, bool isUsingStaging, C2SOfferwallCallback offerwallCallback, C2SOfferwallRewardCallback offerwallRewardCallback)
    Android Native : public void initializeEx(String uid, boolean _isUsingStaging, OfferwallCB callback, ...)

 

void CS_OfferwallInitializeEx(const char* uid, int isUsingStaging, OfferwallCB callback, OfferwallRewardCB rewardCallback)
  • Description

    - Offrewall 모듈을 초기화하고 콜백을 등록합니다.
    - RewardCB는 게임서버가 없는 싱글모드 게임을 위한 콜백입니다. 싱글모드 게임이 아니며 미사용 시 null로 설정바랍니다.
    - 싱글모드 게임을 위한 게임지원은 C2S.19.6부터 deprecated 처리 고려중이며 해당하는 게임이 있다면 클라이언트팀으로 문의바랍니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in const char* uid

로그인한 유저의 uid

in int isUsingStaging

모듈 테스트 서버 사용 여부
(C2S.19.6 버전 이후 파라메터 isUsingStaging은 더이상 동작하지 않습니다. ActiveUser 초기화 시 설정한 서버에 영향을 받습니다.)

in OfferwallCB callback

구현한 콜백 함수

in OfferwallRewardCB rewardCallback

구현한 콜백 함수
(C2S.19.6 버전 이후부터 RewardCB를 사용하지 않아 null로 설정합니다.)

  • Remark
    Unity Plugin : public void initializeEx(string uid, bool isUsingStaging, C2SOfferwallCallback offerwallCallback, C2SOfferwallRewardCallback offerwallRewardCallback)
    Android Native : public void initializeEx(String uid, boolean _isUsingStaging, OfferwallCB callback, OfferwallRewardCB rewardCallBack) 

 

void CS_OfferwallSetLog(int isLog) (Deprecated, C2S.19.6)
  • Description
    Offerwall log 사용유무 설정 함수.
  • Return Value

void

  • Parameter
in/out Type Name Description
in int isLog

로그 사용 유무. 0은 사용하지 않음. 1은 사용함.

  • Remark
    Android에서는 setLogged(boolean b)와 동일.

 

void CS_OfferwallShowEx(const char* additionalInfo)
  • Description

    - 오퍼월 페이지를 노출합니다.
    - 프로모션 서버와 합의된 특별한 데이터 설정을 전달하려는 경우 additionalInfo에 Json 형태의 데이터를 추가합니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in const char* additionalInfo

- 프로모션 서버와 합의된 추가 설정 데이터
(ex : {“server”:”kr”} )
- 별도 설정이 없는 경우 빈 String 데이터("") 설정

  • Remark
    Unity Plugin : public void showEx(string additionalInfo)
    Android Native : public void showEx(String additionalInfo)

 

 

void CS_OfferwallRewardFinish() (Deprecated, C2S.19,6)
  • Description
    보상처리 완료 후, Offerwall 서버에 클라이언트에서 보상이 완료되었다고 알리기 위한 함수입니다.
    싱글게임 전용 함수로 CS_OfferwallInitializeEx()으로 초기화 한 후, 클라이언트에서 보상처리를 모두 완료하고 Finish를 호출합니다.
    Offerwall 모듈 적용 가이드의 Single Mode 게임 적용 방법 참고
  • Return Value

void

  • Remark
    Android에서는 rewardFinish()와 동일.

 

int CS_OfferwallGetState()
  • Description

    - 오퍼월의 활성화 상태 여부를 반환합니다.
    - 오퍼월 활성은 Hive 콘솔에서 설정합니다.

  • Return Value

* C Plugin

int
/
오퍼월 활성 여부 값
(-1 : 에러, 2 : 서버 갱신 중,
OFFERWALL_RESULT.OFFERWALL_ACTIVATION : 오퍼월 활성 상태, OFFERWALL_RESULT.OFFERWALL_DEACTIVATION : 오퍼월 비활성 상태)

* Unity Plugin

int
/
오퍼월 활성 여부 값
(-1 : 에러, 2 : 서버 갱신 중,
OFFERWALL_RESULT.OFFERWALL_ACTIVATION : 오퍼월 활성 상태, OFFERWALL_RESULT.OFFERWALL_DEACTIVATION : 오퍼월 비활성 상태)

* Android Native

int
/
오퍼월 활성 여부 값
(-1 : 에러, 2 : 서버 갱신 중,
OFFERWALL_RESULT.OFFERWALL_ACTIVATION : 오퍼월 활성 상태, OFFERWALL_RESULT.OFFERWALL_DEACTIVATION : 오퍼월 비활성 상태)

  • Remark
    Unity Plugin : public int getOfferwallState()
    Android Native : public int getOfferwallState()

 

const char* CS_OfferwallGetVersion()
  • Description

    - Offerwall 모듈 버전을 반환합니다.
    - C2S.19.8.1 패키지 이후 모든 모듈 버전이 패키지 버전과 동일한 값을 갖습니다. (ex : C2S.19.8.1)

  • Return Value

* C Plugin

const char* / Offerwall 모듈 버전 값

* Unity Plugin

string / Offerwall 모듈 버전 값

* Android Native

String / Offerwall 모듈 버전 값

  • Remark
    Unity Plugin : public int getVersion()
    Android Native : public int getOfferwallState()

 

 

 

콜백 함수

typedef void (*OfferwallCB)(OFFERWALL_RESULT result)
  • Description
    - OFFERWALL_RESULT 값에 해당하는 오퍼월 페이지의 열림(open) 혹은 닫힘(close) 상태 및 기타 상태, API 호출에 대한 콜백의 응답을 받을 수 있는 콜백
  • Return Value

typedef void

  • Parameter
in/out Type Name Description
in OFFERWALL_RESULT result

프로모션 API 요청에 대한 결과

  • Remark
    Unity Plugin :
    public interface C2SOfferwallCallback { void onOfferwallCallback(int result); }

    Android Native : 
    public static interface OfferwallCB { public void offerwallCallBack(int result); }

  • Sample Code
switch(result)
    {
        case OFFERWALL_OPEN:
            break;
        case OFFERWALL_CLOSE:
            break;
        case OFFERWALL_NETWORK_DISCONNECT:
            break;
        default:
            break;
           
    }

 

void offerwallRewardCallBack(int errorNo, const char* errorMessage, int result, const char* eventID, const char* assetCode, int assetAmount) (Deprecated, C2S.19.6)
  • Description
    Android java callback.
  • Return Value

no return value

  • Parameter
in/out Type Name Description
in int errorNo

errorNumber

in const char* errorMessage

errorMessage

in int result

callback result

in const char* eventID  
in const char* assetCode  
in int assetAmount  
  • Remark
    not comment
  • Sample Code
// offerwall Reward callback
void offerwallRewardCallback(int error, const char* errorMessage, int result, const char* eventID, const char* assetCode, int assetAmount)
{
    CS_knlPrintk("Offerwall reward Callback  (error: %d, errorMSG: %s, result: %d, eventID: %s, assetCode: %s, assetAmount: %d", error, errorMessage, result, eventID, assetCode, assetAmount);

    switch (result) {
    case OFFERWALL_REWARD_SUCCESS:
        CS_knlPrintk("%s", "OFFERWALL_REWARD_SUCCESS\n");
        break;
    case OFFERWALL_REWARD_FINISH:
        CS_knlPrintk("%s", "OFFERWALL_REWARD_FINISH\n");
        break;
    case OFFERWALL_REWARD_IN_PROGRESS:
        CS_knlPrintk("%s", "OFFERWALL_REWARD_IN_PROGRESS\n");
        break;
    case OFFERWALL_REWARD_CANCEL:
        CS_knlPrintk("%s", "OFFERWALL_REWARD_CANCEL\n");
        break;

    default:
        CS_knlPrintk("%s", "Error : Not defined state");
        break;
    }
}