イベント駆動型プッシュ¶

利用者の操作などアプリ内で発生したイベントをきっかけとして利用者にプッシュ通知を配信することができます。

利用できるプラン

イベント駆動型プッシュは有料プランでご利用可能です。

イベント駆動型プッシュできること¶

イベント発生から指定の時間経過後(30日以内)にプッシュ通知を配信
変数を使ってメッセージのパーソナライズ

変数の利用

管理サイトでメッセージを作成する際に変数を適用したい箇所に"${}"を使います。
例: 「${name}さまへお得な情報をお届け!!」

アプリから、変数名と値の組み合わせを指定すると変換されてメッセージが配信されます。

例:
アプリから「変数名:name 値:鈴木一郎」を指定して配信をリクエスト
配信されるメッセージ: 「鈴木一郎さまへお得な情報をお届け!!」

配信までの流れ¶

(管理サイトで行うこと)
1. 任意のイベントを作成
2. 配信するメッセージを作成して、作成したイベントを紐づける
3. 作成したメッセージを承認する

(アプリ側で行うこと)
1. SDKを使用して配信をリクエスト（後述）

メッセージ配信のリクエスト¶

// RichFlyerクラス
postMessage(
    events: Array<string>,
    variables: any,
    standbyTime: number
): Promise<any>

パラメータ	内容
events	管理サイトで作成したメッセージに紐づいたイベントの配列。
variables	変数。変数名とその値の連想配列。
standbyTime	イベント発生からプッシュ通知配信までの待機時間(分)。最大43200分(30日間)まで指定可能。※管理サイトで設定した値を適用する場合は0未満の数値を指定してください。

イベント投稿IDについて

リクエストに成功すると イベント投稿ID を取得できます。
リクエスト後、待機時間内であればイベント投稿IDを使用してリクエストをキャンセルできます。
イベントに紐づいたメッセージが複数ある場合は、その数の分だけ応答されます。
待機時間を0にした場合は、同IDは応答されません。

実装例¶

Example

const richflyer = new RichFlyer();

const events = ["reserved"];
const variables = {
    name: "鈴木一郎",
    shop: "◯△商店"
};
const standbyTime = 10;

// イベント駆動型プッシュ通知の登録
richflyer
  .postMessage(events, variables, standbyTime)
  .then((eventPostId) => {
    console.log(eventPostId);
  })
  .catch((error) => {
    console.log(error);
  });

配信のキャンセル¶

// RichFlyerクラス
cancelPosting(
    eventPostId: string
): Promise<any>

実装例¶

Example

const richflyer = new RichFlyer();

const eventPostId = "90793c40-9b20-4526-a898-4bc4d5cd5612";

// 通知リクエストをキャンセルする
richflyer
    .cancelPosting(eventPostId)
    .then((result) => {
      console.log(result);
    })
    .catch((error) => {
      console.log(error);
    });