ショップからLinkHarborへ売上を報告する方法(クリックID、コールバックシークレット、売上コールバック)と、応援の支払いがコンバージョンになる仕組み。
コンバージョンとは、LinkHarborがページ上のクリックに紐づけられる売上や応援の支払いのことです。リンクが何回クリックされたかだけでなく、その結果どうなったかも分かります。この記事は、自分のショップを持つクリエイターと、ショップを接続する開発者向けです。コンバージョンの分析とコールバックシークレットの作成はCreator Pro以上で利用できます。
コンバージョンの発生元
- ショップやサーバーが売上コールバックで報告する売上
- Stripe経由の応援の支払い。返金されるとコンバージョンも取り消されます。Stripeによる応援の支払いをご覧ください
各コンバージョンは、対応するクリックのデータ(ページ、リンク、国、デバイス、リファラー、UTMパラメータ)を引き継ぎます。そのため、統計ではクリックの発生元とまったく同じ場所に表示されます。
紐づけの仕組み
- 訪問者がページのリンクをクリックします
- LinkHarborはクリックを数え、転送時にリンク先URLへ一意のクリックIDを含むlt_click_idパラメータを付加します
- リンク先のページ(ショップなど)はアドレスからlt_click_idを読み取り、購入まで保持します
- 購入後、サーバーがこのクリックIDを付けた売上コールバックをLinkHarborに送信します
- コンバージョンがダッシュボードとページの統計に表示されます
クリックIDは、http://またはhttps://で始まるリンク先にのみ付加されます。mailto:やtel:へのリンクには付きません。パラメータが件名や電話番号を壊してしまうためです。ボットによるクリックにもクリックIDは付きません。
コールバックシークレットを作成する
売上コールバックは、コールバックシークレットで自身を証明する必要があります。オーナーと管理者は、Creator Pro以上でメニューのアカウント欄にある「コールバック&API」からシークレットを管理できます。
- 「コールバック&API」を開きます
- 「コールバックシークレット」カードで「+ 新しいシークレットを作成」をクリックします
- 必要に応じて名前を入力します(例:「ショップのコールバック」)
- 「シークレットを作成」をクリックします
- シークレットはすぐにコピーしてください。表示されるのは一度だけです
- 「編集」
- 名前とステータス(有効または無効)を変更します。無効なシークレットは拒否されます。
- 「↺ ローテーション」
- 新しいシークレットを作成します。古いシークレットはすぐに使えなくなるので、新しいものをすぐにショップに設定してください。
- 「削除」
- 確認の後、シークレットを削除します。
- 「最終コールバック:」
- シークレットが最後に使われた日時を表示します。未使用の場合は「まだ使用されていません」と表示されます。
コールバックシークレットは、ワークスペースごとに最大5つまで作成できます。
売上コールバックを送信する
サーバーからLinkHarbor APIにPOSTリクエストを送信します。シークレットはX-Callback-Secretヘッダーに入れます。
curl -X POST https://dock.at-harbor.com/v1/callbacks/sale \
-H "Content-Type: application/json" \
-H "X-Callback-Secret: YOUR_CALLBACK_SECRET" \
-d '{
"click_id": "3f2b8c1e-5d4a-4b7e-9a10-2c6d8e0f1a23",
"order_id": "B-10042",
"amount": "49.90",
"currency": "EUR"
}' - click_id
- 必須。lt_click_idのクリックID(10〜36文字)です。
- order_id
- 必須。注文番号(1〜128文字)です。1つの注文番号につきコンバージョンは1件しか数えられないため、コールバックを繰り返しても2件目は作成されません。
- amount
- 必須。金額を小数で指定します。
- currency
- 必須。3文字の通貨コードです(例:EUR)。
- occurred_at, meta
- 任意。購入日時と、追加情報用の最大50個の独自キー(各1〜64文字)です。値は最大500文字のテキスト、数値、true/false、nullのいずれかで、ネストしたオブジェクトはAPIに拒否されます。
レスポンス
| ステータス | 意味 |
|---|---|
| 200 | コンバージョンを保存しました。レスポンスにconversion_idが含まれます |
| 403 | シークレットが間違っているか無効です。workspace_idを送信しない場合は、クリックIDが不明なときもこのステータスになります |
| 404 | クリックIDが不明です(workspace_idを送信した場合のみ) |
| 413 | 本文が1 MBを超えています(request_too_large) |
| 422 | 必須項目がないか形式が正しくありません(metaの値が長すぎる、ネストしているなど) |
| 429 | 同じIPアドレスから1分あたり120件を超えるコールバック |
開発者向けのすべての項目とエラーコードは売上と独自データの送信にあります。
コンバージョンを分析する
- ダッシュボード:「コンバージョン」と「CVR」のタイル、UTMソースとメディア別の「コンバージョン」カード
- ページの統計:「CVR合計」「CVRユニーク」「内訳」を含む「コンバージョン」カード
- CVR合計=コンバージョン数÷クリック数、CVRユニーク=コンバージョン数÷ユニーククリック数
こちらもおすすめ
答えが見つかりませんか?
お困りのことをお知らせください。サポートチームが個別にお手伝いします。