Widget API とは

Widget とは HTML / JS / CSS で構成される Web ブラウザとネイティブアプリ向けの KARTE のアクションのことです。

Widget API は、その Widget 内のスコープで利用できる API の事で、Widget を自由にカスタマイズすることが可能です。主に Javascript API と HTML ディレクティブの2種類で構成されます。Javascript API には主に3種類の API (widget / chat / collection) が含まれています。

HTML ディレクティブと Javascript API の一部は vue.js を拡張して利用しています。このドキュメントに載せていないものはサポート外ですが、参考にして下さい。

📘

Action API との違い

Action は Widget を含む Karte で配信されるパーソナライズ部品のすべてを示します。Widget は Web ブラウザとネイティブアプリのアクションです。 (ブラウザ通知やネイティブプッシュ通知は含みません。)

Action API はサーバーサイドで処理が行われますが、Widget API はデバイス側で実行されます。そのため、デバイス側で Javascript が実行できない場合には利用できません。