Message API

1.概要

Message API は、SAP側からユーザーへのメッセージの送信、及び取得を行う為のAPIです。
ゲーム運用者からユーザーを限定したお知らせ(特定条件を満たしたユーザーへのインセンティブ付与の通知など)を送るなどの利用が想定されます。

※PCタイトルは非対応です。

2.オブジェクトフィールド

Message APIで利用できる情報について説明します。

2.1 Message

パラメータ 内容 型
title タイトル string
body メッセージ string
recipients 送信先のユーザーsapkey string[ ]
urls メッセージのリンク先URL string[MessageUrl]
deviceCustomUrls デバイス固有のURL string[MessageDeviceCustomUrl]
deviceCustomLink デバイス固有のURLを設定する文字列 string

2.2 MessageUrl

パラメータ 内容 型
value URL string

2.3 MessageDeviceCustomUrl

パラメータ 内容 型
type デバイスタイプ string
url 対象デバイス用URL string

3.リクエスト

3.1 エンドポイント

http://gpf-api.[対象ドメイン]/social/message/

3.2 HTTPメソッド

HTTPメソッド 機能
GET –
PUT –
POST Messageオブジェクトの生成
DELETE –

3.3 認証

HTTPヘッダーに以下の値を設定してください。全て必須項目です。

キー 値
GAME_CODE 利用ゲームのGAME_CODE

4.レスポンス

HTTPメソッド レスポンスコード 内容
POST 201 データ登録正常終了
POST 400 リクエスト不正
POST 401 認証失敗
GET/PUT/DELETE 403 許可されていないメソッド
POST 500 プラットフォームエラー

X.サンプル

X.1 ゲームのお知らせを複数のユーザーに送信する

リクエスト /social/message
JSON {
“title”:”メッセージのタイトル”,
“body”:”メッセージの本文”,
“recipients”:[
“1151252574052a11639d0e8810fcdbcc0a8bef98c6dfefa623340f7be3153c1b”,
“11512525744aeb252d5d3c476a68f626ae7533eebec9a96713962fa98e979ca1”,
“115125257480cb66b539f996e56ddba915cb3d7e478ac66c0f970ecca86f1dc9”
],
“urls”:[{“value”:”http://example.com/message/123456″}],
“deviceCustomUrls”:[
{
“type”:”iOS”,
“url”:”http://example.com/message/iOS/123″
},
{
“type”:”Android”,
“url”:”http://example.com/message/Android/123″
}
],
“deviceCustomLink”:”ダウンロードはこちらから”
}
備考 HTTPヘッダーの「GAME_CODE」で指定されたゲームが送信元となります。
recipients,urls,deviceCustomUlrsには対象が一つの場合でも配列で登録してください。