RAD サーバー インストール リソース
RAD サーバー管理用 API への移動
EMS データベースには、EMS プッシュ通知アプリケーションの登録デバイスに関するデータが格納されています。登録されているインストール リソースを使って、この情報にアクセスすることができます。
EMS 管理コンソール アプリケーションを使用することにより、EMS インストール(登録デバイス)に EMS プッシュ通知を送信できます。
- メモ: TEMSClientAPI コンポーネントと TCustomPushEvents コンポーネントを使用すると、新しいデバイス(EMS インストール)の登録と EMS インストール リソースからのデータの取得を行えます。
目次
インストール リソース エンドポイント
インストール リソースでは、次の EMS リソース エンドポイントを公開しています。
エンドポイント メソッド名 | リソース サフィックス | HTTP 要求の種類 | 用途 |
---|---|---|---|
GetInstallations |
-- |
HTTP GET |
インストール リソースからすべてのデータを取得すること。 |
GetChannels |
channels |
HTTP GET |
デバイスのサブスクライブ先となっている使用可能なチャネルを取得すること。 |
GetInstallationFields |
fields |
HTTP GET |
すべての EMS インストールのフィールド名を取得すること。 |
GetInstallation |
|
HTTP GET |
特定のインストール(登録デバイス)のすべてのデータを取得すること。 |
AddInstallation |
-- |
HTTP POST |
EMS データベースに新しい EMS インストールを追加すること。 |
UpdateInstallation |
|
HTTP PUT |
EMS データベース内の EMS インストールのフィールドを更新すること。 |
DeleteInstallation |
|
HTTP DELETE |
EMS データベースからインストールを削除すること。 |
GetInstallations エンドポイント
EMS インストール データのリストを返します。
QueryInstallations メソッドを使用すると、EMS インストールのリストを取得できます。
正常終了した場合は、各 EMS インストールの次のような詳細情報をすべてのインストールについて記述したリストが EMS サーバーからの応答になります。
- _id
- deviceToken
- deviceType
- _meta(creator、created、updated の各フィールド)
- channels
- カスタム フィールド(省略可能)
応答の例
次は応答の例です。
[
{
"_id":"384234D0-7CEC-4C29-8363-2CED46ACAD39",
"deviceToken":"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W_NThA1HOZeZY9AmMkziY-Ri-REh1m-Qa8Dw2paBDTwXXZNrY1qa8nAFQGjXYaiS_5hiJ3cZDL7OB1zkcya4JoJCpUccmvm49yXHmcqBKC32rk23PKib8ZYyBmX_wgZhwM_vBozhKJ821wXDI",
"deviceType":"android",
"_meta":{
"creator":"00000000-0000-0000-0000-000000000000",
"created":"2015-02-06T10:05:01.000Z",
"updated":"2015-02-06T10:06:34.000Z"
},
"description":"Nexus 7 device.",
"channels":[
"News"
]
},
{
"_id":"92690E39-889C-4CC1-9B54-404ABB0604A3",
"deviceToken":"APA91bG5a4a4HMACivEP2hH-x_7PUIW8GT4lvdHQWGfnh0KB7lRTwDMyS-2cHqw4gJGj_kSTXHt6DRiuA5Zr_26d1la83nlUfBuPUPXfq_8IAuQBH7thf22_X9RWCJbbcj27OEkUx0u5ylno-RTOFR1rTicxkBai6sYqPLzmvJeySwyDdyQnk9o",
"deviceType":"android",
"_meta":{
"creator":"00000000-0000-0000-0000-000000000000",
"created":"2015-02-06T10:55:03.000Z"
},
"channels":[
]
}
]
GetChannels エンドポイント
デバイスのサブスクライブ先となっている使用可能なチャネルのリストを返します。
RetrieveInstallationsChannelNames メソッドを使用すると、使用可能なチャネルのリストを取得できます。
正常終了した場合は、使用可能なチャネルのリストが EMS サーバーからの応答になります。
応答の例
次は応答の例です。
[
"News",
"Weather"
]
GetFields エンドポイント
EMS データベースからすべての EMS インストールのフィールド名を取得します。
RetrieveInstallationsFields メソッドを使用すると、すべての EMS インストールのフィールド名を取得できます。
正常終了した場合は、EMS インストールのすべてのフィールド名を並べたリストが EMS サーバーからの応答になります。
- _id
- deviceToken
- deviceType
- _meta(creator、created、updated の各フィールド)
- channels
- カスタム フィールド(省略可能)
応答の例
次は応答の例です。
[
{
"name":"_id"
},
{
"name":"deviceToken"
},
{
"name":"deviceType"
},
{
"name":"_meta",
"fields":[
{
"name":"creator"
},
{
"name":"created"
},
{
"name":"updated"
}
]
},
{
"name":"channels"
},
{
"name":"description",
"custom":true
}
]
GetInstallation エンドポイント
(id
で識別された)指定の EMS インストールの全データを取得します。
要求には、少なくとも次のフィールドを指定する必要があります。
- _id
RetrieveInstallations メソッドを使用すると、特定の EMS インストールのフィールドを取得できます。
正常終了した場合は、EMS インストールのすべてのフィールド名を並べたリストが EMS サーバーからの応答になります。
- _id
- deviceToken
- deviceType
- _meta(creator、created、updated の各フィールド)
- channels
- カスタム フィールド(省略可能)
応答の例
これは、_id が "384234D0-7CEC-4C29-8363-2CED46ACAD39" となっている EMS インストールの場合の応答例です。
{
"_id":"384234D0-7CEC-4C29-8363-2CED46ACAD39",
"deviceToken":"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W_NThA1HOZeZY9AmMkziY-Ri-REh1m-Qa8Dw2paBDTwXXZNrY1qa8nAFQGjXYaiS_5hiJ3cZDL7OB1zkcya4JoJCpUccmvm49yXHmcqBKC32rk23PKib8ZYyBmX_wgZhwM_vBozhKJ821wXDI",
"deviceType":"android",
"_meta":{
"creator":"00000000-0000-0000-0000-000000000000",
"created":"2015-02-06T10:05:01.000Z",
"updated":"2015-02-06T11:58:57.000Z"
},
"description":"Nexus 7 device",
"channels":[
"News",
"Weather"
]
}
AddInstallation エンドポイント
EMS データベースに新規の EMS インストール(登録デバイス)を追加します。
RegisterDevice メソッドを使用すると、新規の EMS インストールを登録できます。
UpdateInstallation エンドポイント
EMS データベースに格納されている既存の EMS インストールのデータを更新します。
要求には、少なくとも次のフィールドを指定する必要があります。
- _id
UpdateInstallation メソッドを使用すると、既存の EMS インストールのデータを更新できます。
DeleteInstallation エンドポイント
EMS データベースから既存の EMS インストールを削除します。
要求には、次のフィールドを指定する必要があります。
- _id
DeleteInstallation メソッドを使用すると、既存の EMS インストールを削除できます。
EMS インストールのフィールド
EMS 要求および応答におけるインストール リソースには、次のフィールドの任意の組み合わせが含まれる可能性があります。
項目 | 例 | 説明 |
---|---|---|
"_id"
|
"384234D0-7CEC-4C29-8363-2CED46ACAD39"
|
EMS データベースでの EMS インストールの一意識別子。 |
"deviceToken"
|
"APA91bEIMc7Q8mhbGW8hJM44y5oOU3x-zAlJ37W[...]vBozhKJ821wXDI"
|
EMS データベースでの EMS インストールの一意識別子。 |
"deviceType"
|
"android"
|
デバイスの種類(ios、android、winrt、winphone、dotnet のいずれか)。 |
"_meta"
|
{
"creator":"00000000-0000-0000-0000-000000000000",
"created":"2015-02-06T10:05:01.000Z",
"updated":"2015-02-06T10:06:34.000Z"
}
|
|
"channels"
|
[
"News",
"Weather"
]
|
デバイスのサブスクライブ先となっている使用可能なチャネルのリスト。 |
カスタム フィールド |
"myCustomField": "My Custom Field description"
|
EMS インストールに関して格納されている追加情報。 |