PlatioNotification - Platioのユーザーへのプッシュ通知
Platioのユーザーにプッシュ通知を送ります。Platioビルダーを使って、Platioのユーザーを選択します。詳細については下記トピック「Platioビルダーの使い方」を参照してください。
※プッシュ通知を送るには、Platioのアプリケーションの設定でプッシュ通知を有効にする必要があります。
■ストリーム情報
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 無制限 | |
| 説明 | 入力ストリームは使用せず、すべて無視します。 | |
| 出力 | フォーマット | すべて |
| 説明 | 入力ストリームをそのまま出力します。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| コネクションを使用 | boolean | - |
接続先に以下のコネクション名 を使用するかどうか選択します。
|
||||||||||||
| コネクション名 | connection | - | コネクションを使用 が「はい」の場合に、Platioアプリケーションへの接続用コネクションを指定します。 コネクションペインまたは管理コンソールにて作成した接続名を選択します。 |
||||||||||||
| コネクション情報 | group | - | コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。 | ||||||||||||
| アプリケーションベースURL | string | 入力＆出力 |
PlatioのアプリケーションベースURLを指定します。 指定するURLは「 https://api.plat.io/v1/[アプリケーションのID] 」の形式で指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| トークンID | string | 入力＆出力 |
Platioの開発者向け情報ページから取得したAPIトークンのトークンIDを指定します。 詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| 秘密トークン | password | 入力＆出力 |
Platioの開発者向け情報ページから取得したAPIトークンの秘密トークンを指定します。 詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| タイムアウト | int | 入力＆出力 |
Platioアプリケーションへの接続時のタイムアウト値を指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||
| プロキシ設定を使用 | boolean | - |
管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
|
||||||||||||
| ユーザー | choice | 入力＆出力 |
アプリケーションに登録されている全てのユーザーへプッシュ通知を送る場合は「全ユーザー」を選択し、
個別のユーザーへ送る場合はプッシュ通知を送るユーザー名もしくはユーザーIDを入力します。
|
||||||||||||
| 通知のタイトル | string | 入力＆出力 |
プッシュ通知のタイトルを指定します。(128文字以下) |
||||||||||||
| 通知の本文 | string | 入力＆出力 |
プッシュ通知の本文を指定します。(512文字以下) |
||||||||||||
| 通知時の音 | choice | 入力＆出力 |
プッシュ通知時に音を鳴らすかどうかを指定します。
|
||||||||||||
| タップ時の動作 | choice | 入力＆出力 |
プッシュ通知をタップしたときの動作を指定します。
|
||||||||||||
| データポケット名 | string | 入力＆出力 |
プッシュ通知をユーザーがタップした時に開くデータポケットの名前を指定します。 タップ時の動作 が「データポケットを開く」、「レコードを開く」の場合に使用されます。 |
||||||||||||
| コレクションID | string | 入力＆出力 |
プッシュ通知をユーザーがタップした時に開くコレクションのIDを指定します。
タップ時の動作 が「レコードを開く」の場合に使用されます。 データポケット名にレコードを開くデータポケットを指定する必要があります。 |
||||||||||||
| レコードID | string | 入力＆出力 |
プッシュ通知をユーザーがタップした時に開くレコードのIDを指定します。
タップ時の動作 が「レコードを開く」の場合に使用されます。 データポケット名にレコードを開くデータポケット、コレクションIDにレコードを保持するコレクションを指定する必要があります。 |
||||||||||||
| URL | string | 入力＆出力 |
プッシュ通知をユーザーがタップした時に開くURL指定します。(256文字以下) タップ時の動作 が「URLを開く」の場合に使用されます。 |
||||||||||||
| パラメーター | category | 入力＆出力 |
Platioアプリケーションへの接続時などに使用されるパラメーターを指定します。本プロパティは将来の拡張用のために存在し、基本的に使用することはありません。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
■エラー処理
| タイプ | パラメーター | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| APIエラー | 「APIエラーのパラメーター
」
を参照してください。 | コンポーネントの入力ストリーム | 1 |
Platio APIがエラーを返した場合
|
| 接続エラー | なし | コンポーネントの入力ストリーム | 2 | Platioとの通信中にエラーが発生した場合 |
| 3 | Platioとの通信中、もしくは通信前処理でエラーが発生した場合 | |||
| 汎用 | なし | コンポーネントの入力ストリーム | 5 | コネクション名 に指定したコネクションが見つからない場合 |
| 9 | Platioに関連するその他のエラーが発生した場合 |
■「APIエラー」のパラメーター
| No. | 名前 | 説明 |
|---|---|---|
| 1 | ErrorCode | Platio APIのエラーコードが返されます。 |
| 2 | StatusCode | HTTPのステータスコードが返されます。 |
| 3 | ErrorResponse | エラーレスポンスのJSONが返されます。 |
■APIトークンの取得方法
Platio APIを使用するためにはAPIトークンを生成する必要があり、PlatioNotificationコンポーネントは生成したAPIトークンを指定する必要があります。
APIトークンには「トークンID」と「秘密トークン」がありPlatioの「開発者向け情報」ページで生成することができます。
「トークンID」はAPIトークンを生成後、Platioの「開発者向け情報」ページよりいつでも確認することができますが、「秘密トークン」はAPIトークン生成時のみ表示され、その後、値を確認することはできません。
「秘密トークン」はAPIトークン生成時に「クリップボードにコピー」アイコンをクリックしてコピーし保存してください。
■Platio APIリクエスト回数
PlatioNotificationコンポーネントのPlatio APIリスエスト回数は以下のようになります。
| API | 説明 | |
|---|---|---|
| レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得 |
「ユーザーリスト」を１回実行します。 「プッシュ通知」はプッシュ通知を送るユーザーの人数分だけ実行します。 |
|
「レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得」：21回
※Platio APIは、Platioビルダー使用時にも使用されます。
■Platioビルダーの使い方
Platioビルダーは、コネクション名 で接続できるPlatioアプリケーションのユーザー一覧からユーザーを選択する専用ツールです。
●Platioビルダーを起動する
以下のいずれかの操作でPlatioビルダーを起動します。
- PlatioGetコンポーネントをダブルクリック
- PlatioGetコンポーネントを右クリックして表示されるメニューから「Platioビルダー」をクリック
●コネクションの選択
コネクションを使用 で「はい」を設定し、コネクション名 が設定されていない場合、Platioビルダー起動時にコネクションダイアログが表示されます。
新規にコネクションを作成する場合は「新規コネクション」を選択してください。
既存のコネクションを使用する場合は「名前」のプルダウンリストより使用するコネクション名を選択してください。選択したコネクションを使用してPlatioアプリケーションへ接続します。
●新規コネクションの作成
「新規コネクション」を選択した場合「コネクションの作成」ダイアログが表示されますので、作成するコネクション名を入力し「OK」ボタンをクリックしてください。
コネクションのプロパティ入力するダイアログが表示されますので、コネクションの各プロパティを設定し「保存」ボタンをクリックしてください。
注意
この時点で新規コネクションが保存されます。作成したコネクションでPlatioアプリケーションへ接続します。
Platioアプリケーションへの接続が成功すると以下のようなダイアログが表示されます。
- (1)画面上部：アプリケーションへの接続情報を表示する領域
- (2)画面中央：ユーザー一覧を表示する領域
●プッシュ通知を送るユーザーを選択する
(2)のユーザー一覧からユーザーを選択します。
※ユーザーは１人だけ選ぶことができます。
※アプリケーションに登録されている全てのユーザーへプッシュ通知を送る場合は「全ユーザー」を選択します。