セグメント

セグメントの登録

利用者の属性などをセグメントとして登録すると、宛先を絞り込んでプッシュ通知を配信することができるようになります。

セグメントは任意の名前と値を登録できます。

利用できないセグメント名

次の単語はセグメント名に利用できません。
"device_id", "endpoint", "customer_id", "service_id", "subscription_arn", "created_at", "updated_at", "domain", "p256dh", "disabled", "ABtestReferenceValue"

// RichFlyerクラス
registerSegments(segments: any): Promise<any>

パラメータ	内容
segments	key/valueで格納したセグメントの情報。 valueで扱える方は、string/number/boolean/Dateのみ。

実装例

Example

const richflyer = new RichFlyer();

const segments = {
  hobby: 'sports',
  installedDate: new Date(),
  age: 20,
  member: true,
};

richflyer.registerSegments(segments).then((result) => {
    console.log(`register segments:${result}`);
});    

登録済みセグメントの取得

過去に登録したセグメントの情報を取得します。

取得するセグメントは、登録時に端末で記憶したものです。アプリがアンインストールされると端末内に記憶した情報は削除されます。

// RichFlyerクラス
getSegments(): Promise<any>

実装例

Example

const richflyer = new RichFlyer();

// セグメントを取得する
richflyer.getSegments().then((segmtns: any) => {
  for (const [name, value] of Object.entries(segmtns)) {
    console.log(`${name}: ${value}`);
  }
});