こちらがPUSHCODEが利用しているJavasScriptタグ関数です。

PushCode.init()

PushCode.components.openSubscribeDialog()

PushCode.requestPermission()

PushCode.changeUserid(newUserid)

PushCode.isRegistered()

PushCode.permission()

PushCode.isSubscribed()

PushCode.isSupport()

PushCode.addToSegment(segmentId)

PushCode.removeFromSegment(segmentId)

PushCode.init()

ページをロードする時にPUSHCODEを初期化する機能です。

※もしpushcode_sw.jsファイルをドメインルート以外に追加した場合にはこちらのマニュアルを参考にしてください。

PushCode.init({
　　　　domainToken: "domain token",
　　　　userid: "user ID",　
　　　　serviceWorkerPath:　"/pushcode_sw.js", 
　　　　scopePath: "/" 
});

パラメーターの説明は以下になります。

Parameters	Type	Description	Default
domainToken	String	【必須】サイト設定ページで新しいドメインを作成したときに、PUSHCODEによって自動的に生成される一意の文字列です。ドメイントークンの入手方法: 1. 管理画面の「サイト設定ページ」を開きます 2. 「通知許諾タグ表示」のアイコンをクリックするとポップアップが表示されます 3. 記載されているソースコードから "domainToken" を検索してください。
userid	String	誰がWebプッシュ通知を購読しているかを追跡するために定義するIDです。例えば、サービスの会員IDや、データ分析ツールで生成したIDなどが考えられます。 ※ IDは一意である必要はありません。例えば、同一人物が複数のデバイスでWebプッシュ通知を購読している場合などです。
serviceWorkerPath	String	「pushcode_sw.js」サービスワーカーファイルの場所です。	/pushcode_sw.js
scopePath	String	サーバーワーカーが制御するディレクトリとファイルのスコープです。	/

「userid」にユーザーIDを付与すると、PUSHCODEのセグメンテーション機能やOne to One送信機能が利用できるようになります。これらの機能を利用することで、特定のユーザーやオーディエンスに向けてコンテンツを配信することができます。様々なユーザー層に合わせてコンテンツをカスタマイズすることで、より良いユーザー体験を提供し、コンバージョン率を飛躍的に高めることができます。

Return

null

on(eventType, callback)

Parameters	Type	Description
eventType	String	【可能な値】 `subscribe`, `subscriptionchange`, `init_complete`
callback		イベントが発生する時に実行する関数です。

Sample Code

PushCode.on('subscribe', (e) => {
    console.log('permission: ' + e.permission);
})

PushCode.on('subscriptionchange', (e) => {
    console.log('subscriptionState: ' + e.subscriptionState);
})

PushCode.on('init_complete', (e) => {
    console.log('init complete');
})

PushCode.components.openSubscribeDialog()

PUSHCODE許諾枠を表示する機能です。

この関数のパラメータの設定で、柔軟にPUSHCODE許諾枠の内容を改訂することができます。

Parameters	Type	Description	Default
position	String	top-left, top-right, bottom-left, bottom-right, centerの5種類が指定可能です。画面幅が800px未満（スマートフォンサイズを想定）の場合は、centerを選ぶと画面中央、center以外を選ぶと画面下部に表示されます。	top-left
allowHtml	Boolean	「message」と「subMessage」のパラメータにHTMLとCSSの入力を可能にするかしないか。ただし、trueにしてもJavaScriptの入力はできません。	false
message	String	「このサイトから最新のお得な情報を受け取りますか？」の部分の文言変更用。falseと評価される値の時にデフォルト文言になります。	このサイトから最新のお得な情報を受け取りますか？
subMessage	String	「いつでも購読を解除することができます。」の部分の文言変更用。falseと評価される値の時にデフォルト文言になります。	いつでも購読を解除することができます。
label - accept	String	「受け取る」の部分の文言変更用。falseと評価される値の時にデフォルト文言になります。	受け取る「受け取る」をクリックしたらブラウザ上の許諾枠が出ます。
label - deny	String	「後で」の部分の文言変更用。falseと評価される値の時にデフォルト文言になります。	後で「後で」をクリックしたら1週間後再び表示されます。許可を押せず3回以上に表示されたら再び表示しません。
label - acceptBackground	String	許可ボタンの色です。HEX color codes で適切な色を選択することができます。ブランクで記入するとデフォルト色に戻ります。	#4663BE
imageUrl	String	画像をアップロードすることができます。可能なファイルタイプは png、 jpg、jpegです。最大サイズは1MBです。最大ピクセルサイズは 2000 x 2000 px です。
buttons	String	deny-accept、 accept-deny でボタンの順番を変更できます。	deny-accept
grayOut - use	Boolean	グレーアウトの使用するかどうか	false
grayOut - background	String	CSSのbackgroundプロパティと同じです。無指定の場合は適当なデフォルト値が使われます。	rgba(50,50,50,.2)
callbacks - accept		PUSHCODE許諾枠のacceptボタンがクリックされた時に実行する関数です。
callbacks - deny		PUSHCODE許諾枠のdenyボタンがクリックされた時に実行する関数です。
callbacks - grayOutClick		PUSHCODE許諾枠を閉じるgrayOut要素がクリックされた時に実行する関数です。
callbacks - requestPermission		PUSHCODE許諾枠枠のacceptボタンがクリックされた後のブラウザの通知許諾を設定した時に実行する関数です。

Sample Code

PushCode.components.openSubscribeDialog({
   position: "top-left",
   allowHtml:true,
   message: "このサイトからのお知らせを受け取りますか？",
   subMessage: "いつでも購読を解除することができます。",
   label: {accept: "受け取る", deny: "また今度", acceptBackground:"#4663BE"},
   imageUrl:"https://www.pushcode.jp/image.jpg",
   buttons: "deny-accept",
   grayOut: {use: true,background: "rgba(50,50,50,.2)"},
   callbacks: {
       accept: () => {console.log("accept click")},
       deny: () => {console.log("deny click")},
       close: () => {console.log("close click")},
       grayOutClick: () => {console.log("grayOutClick click")},
       requestPermission: (e) => {console.log("requestPermission callback");
           if(e.permission=="granted"){console.log("requestPermission granted");}
           elseif(e.permission=="denied"){console.log("requestPermission denied");}
           elseif(e.permission=="default"){console.log("requestPermission default");}
    }
  }
});

PushCode.requestPermission()

Webプッシュ通知の許可を求める機能です。

Return

bool: true or false

PushCode.changeUserid(newUserid)

ユーザーIDを更新する機能です。

Parameters	Type
newUserid	String

Return

bool: true or false

PushCode.isRegistered()

ブラウザのWebプッシュ通知設定を確認する関数です。

この関数は、ブラウザの設定で自分のドメインからのWebプッシュ通知が許可されていればtrueを返します。ブロックされている場合はfalseを返します。

Return

bool: true or false

PushCode.permission()

ブラウザのWebプッシュ通知状況を確認する関数です。

ブラウザの通知許諾状況に応じて以下の値を返します。

未許可：default
許可済：granted
ブロック：denied

Return

String: default, granted, denied

PushCode.isSubscribed()

ユーザーがWebプッシュ通知に購読しているかどうかを確認する関数です。

この関数は、ユーザーがWebプッシュ通知を購読している場合、trueを返します。ユーザーが購読を解除した場合や、ブラウザのネイティブ設定であなたをブロックしている場合は、falseが返されます。

Return

bool: true or false

PushCode.isSupport()

ユーザーのブラウザーはWebプッシュ通知が対応可能かを確認する機能です。

Return

bool: true or false

PushCode.addToSegment(segmentId)

ユーザーIDをセグメントに追加する機能です。

Parameters	Type	Description
segmentId	integer	PUSHCODE管理画面の「セグメント」リストの画面からセグメントIDをご入力ください。

Return

Promise

Sample Code

PushCode.addToSegment(segmentId).then(function(){
    console.log("ユーザーIDをセグメントに追加しました。");
}).catch(function(err){
    console.log(err);
})

PushCode.removeFromSegment(segmentId)

ユーザーIDをセグメントから削除する機能です。

Parameters	Type	Description
segmentId	integer	PUSHCODE管理画面の「セグメント」リストの画面からセグメントIDをご入力ください。

Return

Promise

Sample Code

PushCode.removeFromSegment(segmentId).then(function(){
    console.log("ユーザーIDをセグメントから削除しました。");
}).catch(function(err){
    console.log(err);
})