Targeting Push API

타겟팅 푸시는 게임 서버에서 Hive의 vid 나 did를 이용하여 게임 유저에게 예약된 푸시를 보낼 수 있도록 제공된 기능이다.

게임 알림으로써 푸시 설정 UI에 게임 알림 On/Off를 구현하여 게임에서 컨트롤 하여야한다. 

통신 방식
HTTP Method POST
Content-Type text/html
Data Format JSON
서버 URL
Staging http://test-push.qpyou.cn/api/
Production https://push.qpyou.cn/api/
Sandbox https://sandbox-push.qpyou.cn/api/

 

 

* 기본 정보 입력 / tp_reg_start.php

 

 – Request
Key Type Description   Remarks
company String – 회사 구분
– com2us: 컴투스, gamevil: 컴투스홀딩스		 Required
os String – Android/iOS 구분
– A: Android, I: iOS		 Required
description String – 캠페인 설명 Required
reserved_time String – 발송예약시간 (YYYY-MM-DD HH:mm, 한국시간 기준)
– ex. 2015-02-25 12:00		 Required
is_batch Number – 일괄발송 사용 여부
– 0: 미사용 (기본)
=> 한국시간
(등록시간 + 한국 GMT OFFSET – 대상 타임존 GMT OFFSET)에
발송이 시작
– 1: 사용
=>  한국시간 기준으로 등록된 시간에 모든 국가로 발송		 Optional
app_list Array – 발송 게임 (AppID 리스트)
– ex. [“com.com2us.mi.push1′, ‘com.com2us.mi.push2”]		 Required
country_list Array – 발송 국가 (ISO ALPHA-2 Code)
– country_list 필드가 존재하지 않을 경우는 전체 국가 발송
– ex. [“kr”, “jp”, “cn”]		 Optional
option_list Object – 푸시 옵션
sound: 푸시 알림 사운드 / String / Android, iOS
vibration: 푸시 진동 / Number(0: 미사용, 1: 사용(기본))
/ Android
icon: 푸시 아이콘 / String / Android
– ex.
*Android
{“sound”:”SoundResourceName”,”vibration”:1,
“icon”:”IconResoureNameOrImageUrl”}
*iOS
{“sound”:”SoundFileNameWithFileExtension”}		 Optional
message_list Object – 푸시 메세지
title: 푸시 타이틀 / String / Android
message_short: 푸시 단문 메세지 / String / Android, iOS
message_long: 푸시 장문 메세지 / String / Android
ticker: 푸시 티커 / String / Android
image_url: 푸시 이미지 URL / String / Android
link_type: 푸시 메세지 클릭시의 Action
(app: 앱으로 이동 (기본),
web: link_url에 입력된 URL로 웹 이동) / String / Android
link_url: 푸시 클릭시 이동할 URL (link_type이 web일 경우에만
사용) / String / Android- Android일 경우 title과 message_short,
iOS일 경우엔 message_short을 반드시 입력해야 함
– 지원 언어 (16가지)
KO: 한국어, ZH-HANS: 중문 간체, ZH-HANT: 중문 번체,
EN: 영어, JA: 일본어, FR: 프랑스어, DE: 독일어, ES: 스페인어,
PT: 포르투갈어, TH: 태국어, IT: 이탈리아어, RU: 러시아어,
ID: 인도네시아어, VI: 베트남어, TR: 터키어

– 언어코드별 리스트 형태로 입력

– ex.
*Android
{
“default”:{
“title”:”알림“,
“message_short”:”알림이 도착했습니다.“,
},
“ko”:{
“title”:”공지사항“,
“message_short”:”알림이 도착했습니다.“,
“message_long”:”게임 관련 중요한 알림이 도착했습니다.“,
“image_url”:”http://image.com2us.com/image/push.png”,
“ticker”:”알림”,
“link_type”:”web”,
“link_url”:”http://www.com2us.com/push/notice.php”
}
}

*iOS
{“default”:{“message_short”:”알림이 도착했습니다.”},
“ko”:{“message_short”:”알림이 도착했습니다.”}}

– default key의 메세지 데이터는 반드시 입력 (단말 언어 설정과 동일한 언어코드의 메세지가 등록되지 않았을 경우 기본으로 발송하는 메세지

 Required

 

 – Response
Key Type Description
errno Number – 오류 코드
0: Success
1: Transmission Error (전송된 데이터에 문제가 있을 경우)
2: Database Error (DB 작업에 문제가 있을 경우)
3: Data Error (데이터 가공 과정에서 문제가 발생한 경우)
9: Server Error (기타 서버 오류)- 2,3,9번의 경우에는 플랫폼클라이언트팀(platform-live@gamevilcom2us.com)에게 문의
error String – 오류 메세지
campaign_id Number – 캠페인 ID
session_key String – 세션키
max_count Number – 한번에 입력 받을 DID 숫자 제한

 

 

* 발송대상(DID) 정보 입력 / tp_reg_data.php

 

 – Request
Key Type Description Remarks
campaign_id Number – 기본정보 입력 과정에서 리턴된 캠페인 아이디 Required
session_key String – 기본정보 입력 과정에서 리턴된 세션키 Required
did_list Array – 발송 대상 did 리스트
– 기본정보 입력 과정에서 리턴된 max_count 수만큼씩 전송
– ex. [12345, 2011001, 59693, 102034956]		 Required

 

 – Response
Key Type Description
errno Number – 위와 동일
error String – 위와 동일

 

 

* 작업 완료 / tp_reg_end.php

 

 – Request
Key Type Description  Remarks
campaign_id Number – 위와 동일 Required
session_key String – 위와 동일 Required
completed Number – 프로세스 완료 여부
– 1: 정상 완료, 0: 중단 (기본 정보 및 발송대상 정보 삭제)		 Required

 

 – Response
Key Type Description
errno Number – 위와 동일
error String – 위와 동일

 

 

VID Targeting Push API

 

통신 방식
HTTP Method POST
Content-Type text/html
Data Format JSON
서버 URL
Staging http://test-push.qpyou.cn/api/
Production http://push.qpyou.cn/api/
Sandbox http://sandbox-push.qpyou.cn/api/

 

 

* 기본 정보 입력 / vtp_reg_start.php

 

 – Request
Key Type Description Remarks
company String – 회사 구분
– com2us: 컴투스, gamevil: 컴투스홀딩스		 Required
description String – 캠페인 설명 Required
reserved_time String – 발송예약시간 (YYYY-MM-DD HH:mm, 한국시간 기준)
– ex. 2015-02-25 12:00		 Required
is_batch Number – 일괄발송 사용 여부
– 0: 미사용 (기본)
=> 한국시간
(등록시간 + 한국 GMT OFFSET – 대상 타임존 GMT OFFSET)에
발송이 시작
– 1: 사용
=>  한국시간 기준으로 등록된 시간에 모든 국가로 발송		 Optional
country_list Array – 발송 국가 (ISO ALPHA-2 Code)
– country_list 필드가 존재하지 않을 경우는 전체 국가 발송
– ex. [“kr”, “jp”, “cn”]		 Optional
option_list Object – 푸시 옵션
sound: 푸시 알림음 / String / Android
sound_ios: 푸시 알림음 / String / iOS
vibration: 푸시 진동 / Number(0: 미사용, 1: 사용(기본))
/ Android
icon: 푸시 아이콘 / String / Android- ex.
{“sound”:”SoundResourceName”,
“sound_ios”:”SoundFileNameWithFileExtension”,
“vibration”:1,”icon”:”IconResoureNameOrImageUrl”}		 Optional
message_list Object – 푸시 메세지
title: 푸시 타이틀 / String / Android
message_short: 푸시 단문 메세지 / String / Android
message_short_ios: 푸시 단문 메세지 / String / iOS
message_long: 푸시 장문 메세지 / String / Android
ticker: 푸시 티커 / String / Android
image_url: 푸시 이미지 URL / String / Android
link_type: 푸시 메세지 클릭시의 Action
(app: 앱으로 이동 (기본),
web: link_url에 입력된 URL로 웹 이동) / String / Android
link_url: 푸시 클릭시 이동할 URL
(link_type이 웹일 경우에만 사용) / String / Android- title, message_short, message_short_ios는 반드시 입력해야 함
– 지원 언어 (16가지)
KO: 한국어, ZH-HANS: 중문 간체, ZH-HANT: 중문 번체,
EN: 영어, JA: 일본어, FR: 프랑스어, DE: 독일어, ES: 스페인어,
PT: 포르투갈어, TH: 태국어, IT: 이탈리아어, RU: 러시아어,
ID: 인도네시아어, VI: 베트남어, TR: 터키어

– 언어코드별 리스트 형태로 입력

– ex.
{
“default”:{
“title”:”알림“,
“message_short”:”알림이 도착했습니다.“,
},
“ko”:{
“title”:”공지사항“,
“message_short”:”알림이 도착했습니다.“,
“message_short_ios”:”알림이 도착했습니다.”,
“message_long”:”게임 관련 중요한 알림이 도착했습니다.“,
“image_url”:”http://image.com2us.com/image/push.png“,
“ticker”:”알림”,
“link_type”:”web”,
“link_url”:”http://www.com2us.com/push/notice.php”
}
}

– default key의 메세지 데이터는 반드시 입력 (단말 언어 설정과 동일한 언어코드의 메세지가 등록되지 않았을 경우 기본으로 발송하는 메세지)

 Required

 

 – Response
Key Type Description
errno Number – 오류 코드
0: Success
1: Transmission Error (전송된 데이터에 문제가 있을 경우)
2: Database Error (DB 작업에 문제가 있을 경우)
3: Data Error (데이터 가공 과정에서 문제가 발생한 경우)
9: Server Error (기타 서버 오류)- 2,3,9번의 경우에는플랫폼클라이언트팀(platform-live@gamevilcom2us.com)에게 문의
error String – 오류 메세지
campaign_id Number – 캠페인 ID
session_key String – Session Key
max_count Number – 한번에 입력받을 VID 숫자 제한

 

 

* 발송대상(VID) 정보 입력 / vtp_reg_data.php

 

 – Request
Key Type Description  Remarks
campaign_id Number – 기본정보 입력 과정에서 리턴된 캠페인 아이디 Required
session_key String – 기본정보 입력 과정에서 리턴된 세션키 Required
vid_list Array – 발송 대상 vid 리스트
– 기본정보 입력 과정에서 리턴된 max_count 수만큼씩 전송
– ex. [12345, 2011001, 59693, 102034956]		 Required

 

 – Response
Key Type Description
errno Number – 위와 동일
error String – 위와 동일

 

 

* 작업 완료 / vtp_reg_end.php

 

 – Request
Key Type Description Remarks
campaign_id Number – 위와 동일 Required
session_key String – 위와 동일 Required
completed Number – 프로세스 완료 여부
– 1: 정상 완료, 0: 중단 (기본 정보 및 발송대상 정보 삭제)		 Required

 

 – Response
Key Type Description
errno Number – 위와 동일
error String – 위와 동일