배너 구성에 필요한 정보를 리스트 형태로 제공합니다. API 응답은 Request Body type_banner값에 따라 3개로 나뉩니다.

  1. small: 일반 배너, 공지사항, 롤링 배너 구성에 필요한 정보를 함께 전달합니다.
  2. great: 전면 배너 구성에 필요한 정보만 전달합니다.
  3. rolling: 롤링 배너 구성에 필요한 정보만 전달합니다.

 

  • Request URL
    상용 URL https://promotion.qpyou.cn/api/banner
    Sandbox URL https://sandbox-promotion.qpyou.cn/api/banner
    HTTP Method POST
    Content-Type text/html
    Data Format JSON
  • Header
    필드명 설명 타입 필수여부
    Authorization Bearer Authorization으로 certificationKey 유효 판단 String N
  • Request Body
    필드명 설명 타입 필수여부
    user 사용자 정보 Object Y
    ㄴ uid 플랫폼에서 관리하는 유저 ID String N
    ㄴ vid 통합 모듈 로그인 센터가 관리하는 VID 또는 Hive 인증 v4에서 관리하는 PlayerID. Hive SDK v4가 아닌 C2S 개별모듈 사용 시, 이 필드 값은 존재하지 않음. String N
    ㄴ player_token 유저 인증 정보 String N
    ㄴ did Hive 프로비저닝에서 발급하는 기기의 고유 ID String Y
    ㄴ world 게임 서버 정보 String Y
    ㄴ language 게임 또는 기기 설정 언어 코드 (ISO 639-1 기준) String Y
    ㄴ hive_country 요청하는 국가 정보
    값이 없을 경우 요청 IP를 기준으로 국가를 결정
    String N
    ㄴ age_gate_u13 COPPA 적용에 필요한 13세 나이 제한 여부
    Hive SDK 함수 호출 결과 값을 게임에서 그대로 전달

    • true: 13세 미만 유저 제한
    • false: 제한 없음
    Boolean Y
    game 게임 정보 Object Y
    ㄴ appid 배너를 활용할 게임의 AppID String Y
    ㄴ app_version 검수 배너 노출 여부를 결정할 때 확인하는 게임 버전 String Y
    promotion 프로모션 캠페인 정보 Object Y
    ㄴ type_camp 프로모션 캠페인 타입 (Hive 콘솔에서 캠페인 등록 시 선택 또는 직접 입력)

    • all: 모든 타입
    • event: 이벤트 타입
    • notice: 공지 타입
    • cross: 크로스 캠페인 타입
    • 기타: 사용자가 정의하는 공지 타입으로, 최대 10자 영소문자로 구성 가능
    String Y
    ㄴ type_banner 캠페인 배너 타입

    • small: 일반 배너 (띠배너)
    • great: 전면 배너
    • rolling: 롤링 배너
    String Y
  • 호출 예제
  • 요청 예제
  •  

    • Response (Request Body type_banner값이 small: 일반 배너, 공지사항, 롤링 배너)
      필드명 설명 타입 필수여부
      result_code 응답 코드

      • 200: 검증 성공
      • 그 외: 실패
      Integer Y
      result_message 응답 메시지 String Y
      count 배너 개수 Integer Y
      banner 배너 목록
      배너를 등록하지 않은 경우 배열이 비어 있음 ([])
      Array Y
      ㄴ pid 프로모션 캠페인 ID String N
      ㄴ image 캠페인 배너 이미지 URL String N
      ㄴ link 캠페인 배너를 클릭했을 때 이동하는 URL String N
      ㄴ start_date 캠페인 시작 시각 String N
      ㄴ end_date 캠페인 종료 시각 String N
      ㄴ start_unixtimestamp 캠페인 시작 시각 (Unix timestamp) Integer N
      ㄴ end_unixtimestamp 캠페인 종료 시각 (Unix timestamp) Integer N
      ㄴ type_link 캠페인 배너를 클릭했을 때 이동하는 타입 (Hive 콘솔에서 캠페인 등록 시 선택하는 항목)

      • webview: 내부 링크로 이동
      • webbrowser: 외부 링크로 이동
      • market: 마켓(앱스토어)으로 이동
      • notice: Hive 공지로 이동
      • text: 프로모션 텍스트 공지로 이동
      • interwork: 게임에서 지정된 경로로 이동
      • none: 이동 안 함
      String N
      ㄴ interwork_data 게임 내 특정 위치로 이동할 수 있도록 API와 파라미터 제공 (해당하는 정보가 없는 경우 NULL)

      Object N
      ㄴㄴ api API URI String N
      ㄴㄴ param API URI에서 사용할 쿼리 스트링 파라미터 값 String N
      ㄴ type_banner 캠페인 배너 타입

      • small: 일반 배너
      • rolling: 롤링 배너
      String N
      ㄴ type_camp 프로모션 캠페인 타입

      • event: 이벤트 타입
      • notice: 공지 타입
      • permit: 검수 배너
      • cross: 크로스 배너
      String N
      ㄴ badge 이벤트 종료 임박 여부와 선물 수령 기간을 알리는 배지 정보입니다. 일반 배너만 이 필드값을 반환합니다. 롤링 배너는 항상 NULL을 반환합니다. 일반 배너도 Hive 콘솔기간 알림 배지에서 설정한 배지 정보가 없으면 NULL을 반환합니다. 공지사항은 이 필드 자체가 존재하지 않습니다. Object N
      ㄴㄴ title 배지 문구 String N
      ㄴㄴ type 노출하는 배지 타입

      • shutdown: 이벤트 종료 임박 배지
      • gift: 선물 수령 기간 알림 배지
      String N
      ㄴㄴ start_date 배지 노출 시작 날짜 (ISO-8601 포맷) String N
      ㄴㄴ end_date 배지 노출 종료 날짜 (ISO-8601 포맷) String N
      ㄴㄴ start_unixtimestamp 배지 노출 시작 시간 (Unix TimeStamp) Integer N
      ㄴㄴ end_unixtimestamp 배지 노출 종료 시간 (Unix TimeStamp) Integer N
      notice_count 공지 개수 Integer Y
      notice 공지 게시글 정보 Array Y
      ㄴ nid 공지 게시글 ID String N
      ㄴ notice_type 공지 게시글 타입 String N
      ㄴ title 공지 게시글 제목 String N
      ㄴ link 공지 게시글 연결 URL String N
      ㄴ start_date 게시글 노출 시작 시각 String N
      ㄴ end_date 게시글 노출 종료 시각 String N
      ㄴ start_unixtimestamp 게시글 노출 시작 시각 (Unix timestamp) String N
      ㄴ end_unixtimestamp 게시글 노출 종료 시각 (Unix timestamp) String N
      ㄴ view_count 게시글 조회 수 String N
      ㄴ game_index 게시글 게임 인덱스 정보 String N
      ㄴ language 게시글 설정 언어 코드((ISO 639-1 기준) String N
      rolling_count 롤링 배너 개수 Integer Y
      rolling 롤링 배너 정보 Array Y
      ㄴ pid 프로모션 캠페인 ID String N
      ㄴ image 캠페인 배너 이미지 URL String N
      ㄴ link 배너 클릭 시 이동하는 URL String N
      ㄴ start_date 캠페인 시작 시각 String N
      ㄴ end_date 캠페인 종료 시각 String N
      ㄴ start_unixtimestamp 캠페인 시작 시각 (Unix timestamp) String N
      ㄴ end_unixtimestamp 캠페인 종료 시각 (Unix timestamp) String N
      ㄴ type_link 캠페인 배너를 클릭했을 때 이동하는 타입 (Hive 콘솔에서 캠페인 등록 시 선택하는 항목)

      • webview: 내부 링크로 이동
      • webbrowser: 외부 링크로 이동
      • market: 마켓(앱스토어)으로 이동
      • notice: Hive 공지로 이동
      • text: 프로모션 텍스트 공지로 이동
      • interwork: 게임에서 지정된 경로로 이동
      • none: 이동 안 함
      String N
      ㄴ type_banner 캠페인 배너 타입

      • small: 일반 배너
      • rolling: 롤링 배너
      String N
      ㄴ type_camp 프로모션 캠페인 타입

      • event: 이벤트 타입
      • notice: 공지 타입
      • permit: 검수 배너
      • cross: 크로스 배너
      String N
      ㄴ interwork_data 게임 내 특정 위치로 이동할 수 있도록 API와 파라미터 제공(정보가 없는 경우 NULL) Object N
      ㄴㄴ api API URI String N
      ㄴㄴ param API URI에서 사용할 쿼리 스트링 파라미터 값 String N
    • Result code
      코드 메시지 설명
      200 Success 데이터 전달 성공
    • Response Example (일반 배너, 공지사항, 롤링 배너)

     

    • Response (Request Body type_banner값이 great 또는 rolling: 전면 배너 또는 롤링 배너)
      필드명 설명 타입 필수여부
      result_code 응답 코드

      • 200: 검증 성공
      • 그 외: 실패
      String Y
      result_message 응답 메시지 String Y
      count 배너 개수 Integer Y
      banner 배너 목록
      배너를 등록하지 않은 경우 배열이 비어 있음 ([])
      Array Y
      ㄴ pid 프로모션 캠페인 ID String N
      ㄴ image 캠페인 배너 이미지 URL String N
      ㄴ link 캠페인 배너를 클릭했을 때 이동하는 URL String N
      ㄴ start_date 캠페인 시작 시각 String N
      ㄴ end_date 캠페인 종료 시각 String N
      ㄴ start_unixtimestamp 캠페인 시작 시각 (Unix timestamp) Integer N
      ㄴ end_unixtimestamp 캠페인 종료 시각 (Unix timestamp) Integer N
      ㄴ type_link 캠페인 배너를 클릭했을 때 이동하는 타입 (Hive 콘솔에서 캠페인 등록 시 선택하는 항목)

      • webview: 내부 링크로 이동
      • webbrowser: 외부 링크로 이동
      • market: 마켓(앱스토어)으로 이동
      • notice: Hive 공지로 이동
      • text: 프로모션 텍스트 공지로 이동
      • interwork: 게임에서 지정된 경로로 이동
      • none: 이동 안 함
      String N
      ㄴ interwork_data 게임 내 특정 위치로 이동할 수 있도록 API와 파라미터 제공(정보가 없는 경우 NULL)

      Object N
      ㄴㄴ api API URI String N
      ㄴㄴ param API URI에서 사용할 쿼리 스트링 파라미터 값 String N
      ㄴ type_banner 캠페인 배너 타입

      • great: 전면 배너
      • small: 일반 배너 (띠배너)
      • rolling: 롤링 배너
      String N
      ㄴ type_camp 프로모션 캠페인 타입 (Hive 콘솔에서 캠페인 등록 시 선택 또는 직접 입력)

      • event: 이벤트 타입
      • notice: 공지 타입
      • permit: 검수 배너
      • cross : 크로스 배너
      String N
      ㄴ badge 이벤트 종료 임박 여부와 선물 수령 기간을 알리는 배지 정보입니다. 롤링 배너와 전면 배너는 항상 NULL을 반환합니다. Object N
      ㄴㄴ title 배지 문구 String N
      ㄴㄴ type 노출하는 배지 타입

      • shutdown: 이벤트 종료 임박 배지
      • gift: 선물 수령 기간 알림 배지
      String N
      ㄴㄴ start_date 배지 노출 시작 날짜 (ISO-8601 포맷) String N
      ㄴㄴ end_date 배지 노출 종료 날짜 (ISO-8601 포맷) String N
      ㄴㄴ start_unixtimestamp 배지 노출 시작 시간 (Unix TimeStamp) Integer N
      ㄴㄴ end_unixtimestamp 배지 노출 종료 시간 (Unix TimeStamp) Integer N
    • Result code
      코드 메시지 설명
      200 Success 데이터 전달 성공
    • Response Example (전면 배너 또는 롤링 배너)