PUSH ONE SDK for JavaScript Reference(1.0.12版) #

JavaScript SDK は、クライアントサイドからの API 呼び出しを実施して、JavaScript コードから COINs のサービスにアクセスできます。

1. ブラウザプッシュ #

1.1. COINsID 取得 #

➢ getcoinsid(function(coinsid))

ブラウザプッシュ COINs ユーザー ID を取得できます。デバイスがCOINs に正常に登録されると、ハンドラが呼び出されます。 coins2b オブジェクトで取得します。オプトイン前は取得できません。

Parameters：

Name	Type	Description
function(coinsid)	Function	COINsId を受け取る関数を渡します。coinsid で返される値は、COINs のブラウザプッシュ用 userId です（ブラウザごとに固有のものになります。）

Examples：

JavaScript

coins2b.getcoinsid(function(coinsid) {
  console.log("getcoinsid:" + coinsid);
});

1.2. カスタムキー登録 #

➢ setsegment(str1: String)

ブラウザプッシュ用にCOINsユーザーIDにカスタム属性情報を登録します。 coins2bオブジェクトで呼び出します。呼び出しごとにカスタム属性は上書きされます。

Parameters：

Name	Type	Description
str1	String	ユーザー属性（カスタム値）を指定します。上限は 1024文字です。

Examples：

JavaScript

coins2b.setsegment("任意の値");

2. ユニークキー連携 #

2.1. ユニークキー設定 #

➢ setUniqueKey(callback: Function)

ブラウザのCOINsIDに対してユニークキーを関連付けます。

ユニークキーはwindow.WEBPUSH_UNIQUE_KEYに設定されている値が使用されます。この関連付けにより、同一ユニークキーを持つ複数の端末に一括でプッシュ通知を送信できるようになります。

登録されたユニークキーを用いてユニークキー連携メッセージ配信APIでメッセージを配信できます。

Parameters：

Name	Type	Description
callback	Function	API呼び出し結果を受け取るコールバック関数。省略可能です。

Examples：

JavaScript

// ユニークキーを設定
window.WEBPUSH_UNIQUE_KEY = "unique_key_123456";

// ユニークキー連携を設定
coinsUniqueKey.setUniqueKey(function(result) {
  console.log("ユニークキー設定結果:", result);
});

2.2. ユニークキー解除 #

➢ clearUniqueKey(callback: Function)

ブラウザのCOINsIDに関連付けられたユニークキー連携を解除します。

ユニークキーはwindow.WEBPUSH_UNIQUE_KEYに設定されている値が使用されます。ユーザーがログアウトした際などに呼び出します。

Parameters：

Name	Type	Description
callback	Function	API呼び出し結果を受け取るコールバック関数。省略可能です。

Examples：

JavaScript

// ユニークキーを設定
window.WEBPUSH_UNIQUE_KEY = "unique_key_123456";

// ユニークキー連携を解除
coinsUniqueKey.clearUniqueKey(function(result) {
  console.log("ユニークキー解除結果:", result);
});

3. リマインダー配信 #

リマインダー配信は、ユーザーの行動に基づいて条件付きプッシュ通知の配信予約・解除を行う機能です。

3.1. リマインダー予約 #

➢ setReminder(reminderId: String, option: Object, callback: Function)

指定したリマインダーIDの配信予約をします。

ボタンクリック時など任意のタイミングで配信予約したい場合に呼び出します。

以下の場合は予約されません。

予約後に、まだ管理画面で設定した「解除するページ」にアクセスされていない（または解除スクリプトが呼ばれていない）場合
既に管理画面で設定した「除外するページ」にアクセスしている場合
現在のURLが管理画面で設定した「解除するページ」にもマッチしてしまう場合
指定したリマインダーIDの配信状況が「配信中」でない場合

Parameters：

Name	Type	Description
reminderId	String	リマインダーを識別する一意の文字列を指定します。空文字列は指定できません。
option	Object \| null \| undefined	リマインダー配信時のオプション。省略可能です。
callback	Function \| null \| undefined	API 呼び出し結果を受け取るコールバック関数。結果はBoolean型で返却されます。省略可能です。

Option プロパティ：

Name	Type	Description
placeholderText	Object	通知内のプレースホルダーに差し込むテキストをキー・バリュー形式で指定します。省略可能です。
placeholderLargeImageUrl	String \| null	通知内に表示する大きい画像の URL を指定します。CMSで「差し込み大型画像URLを使用する」が設定されている場合に指定可能です。`null` を指定した場合は、CMSで設定された画像がそのまま配信されます。省略可能です。

Examples：

JavaScript

オプションなしの場合

// 基本的なリマインダー予約
window.coins2b.setReminder("sample-reminder");

// コールバック付きでリマインダーを予約
window.coins2b.setReminder("sample-reminder", null, function(result) {
  console.log("リマインダー予約結果:", result);
});

オプション付きの場合

// オプション付きリマインダー予約
window.coins2b.setReminder("sample-reminder", {
  placeholderText: {
    item_name: "商品A",
    price: "1,980円"
  },
  placeholderLargeImageUrl: "https://example.com/images/product.png"
});

// 大型画像をCMSで設定された画像のままにする場合は null を指定
window.coins2b.setReminder("sample-reminder", {
  placeholderText: {
    item_name: "商品A"
  },
  placeholderLargeImageUrl: null
});

// コールバック付きでオプション付きリマインダー予約
window.coins2b.setReminder("sample-reminder", {
  placeholderText: {
    item_name: "商品A",
    price: "1,980円"
  },
  placeholderLargeImageUrl: "https://example.com/images/product.png"
}, function(result) {
  console.log("リマインダー予約結果:", result);
});

3.2. リマインダー解除 #

➢ unsetReminder(reminderId: String, callback: Function)

指定したリマインダーIDの配信予約を解除します。

ボタンクリック時など任意のタイミングで配信予約を解除したい場合に呼び出します。

以下の場合は解除されません。

指定したリマインダーIDの配信状況が「配信中」でない場合

Parameters：

Name	Type	Description
reminderId	String	解除対象のリマインダーID を指定します。空文字列は指定できません。
callback	Function \| null \| undefined	API 呼び出し結果を受け取るコールバック関数。結果はBoolean型で返却されます。省略可能です。

Examples：

JavaScript

// リマインダーを解除
window.coins2b.unsetReminder("sample-reminder");

// コールバック付きでリマインダーを解除
window.coins2b.unsetReminder("sample-reminder", function(result) {
  console.log("リマインダー解除結果:", result);
});

3.3. リマインダークリア #

➢ clearReminder(reminderId: String, callback: Function)

指定したリマインダーIDの配信のデータをクリアします。

予約中の場合は解除を送信後、除外履歴も含めて初期化されます。

主に動作確認時にブラウザのconsoleからの呼び出します。

Parameters：

Name	Type	Description
reminderId	String	クリア対象のリマインダーID を指定します。空文字列は指定できません。
callback	Function \| null \| undefined	API 呼び出し結果を受け取るコールバック関数。結果はBoolean型で返却されます。省略可能です。

Examples：

JavaScript

// リマインダーをクリア
window.coins2b.clearReminder("sample-reminder");

// コールバック付きでリマインダーを解除
window.coins2b.clearReminder("sample-reminder", function(result) {
  console.log("リマインダークリア結果:", result);
});