インストール
@converlay/sdkパッケージをインストールして、ヘッドレスストアフロント（Hydrogen、Next.js、Remix、Nuxt、プレーンHTML）にサーバーサイドイベントトラッキングを追加します。
パッケージのインストール
npm
npm install @converlay/sdkpnpm
pnpm add @converlay/sdkyarn
yarn add @converlay/sdkパッケージの詳細
依存関係ゼロ、gzip圧縮後約2 KB。ESM + CJSデュアルビルド、ES2020ターゲット。
設定オプション
| オプション | 型 | デフォルト | 説明 |
|---|---|---|---|
shopDomain | string | — | 必須。.myshopify.comドメイン |
endpoint | string | https://converlay.app/api/events/collect | 収集APIエンドポイント |
autoPageView | boolean | false | 初期化時に自動的にpage_viewを送信 |
debug | boolean | false | イベントをブラウザコンソールに出力 |
consent | ConsentInput | {analytics: true, marketing: true} | 初期同意状態 |
エントリーポイント
| インポート | 内容 |
|---|---|
@converlay/sdk | createConverlayファクトリ関数 |
@converlay/sdk/react | ConverlayProvider + useConverlayフック（ピア依存: react >= 18） |