SDK リファレンス

スクリプト 1 つ、呼び出し 5 つ。Cookie も識別子も使わず、広告が失敗してもページは止まりません。

読み込み

広告を置く場所にコンテナを置き、スクリプトを一度読み込みます。コンテナの id は adjoin- と枠 ID です。

<!-- one script per page; data-placement renders that slot automatically -->
<div id="adjoin-plc_ab12" data-format="card"></div>
<script async src="https://cdn.adjoin.dev/v1.js" data-placement="plc_ab12"></script>

data-placement: ページの準備ができたらこの枠をすぐ描画します。
data-format: コンテナに: banner, card, inline_native, sidebar, newsletter。既定は card。
data-tenant: パートナー経由の場合はパートナーの slug（パートナー連携を参照）。
data-analytics="off": 無料のページビュー分析を止めます。

サイズ: banner 728×90 · card 320×250 · inline_native 600×120 · sidebar 300×250 · newsletter 600×200

adjoin.render(options)

枠をコンテナに描画します。高さを先に確保するのでレイアウトがずれず、広告は Shadow DOM 内にあるため CSS が混ざりません。合う広告がなければ高さ 0 に畳みます。

adjoin.render({
  placement: 'plc_cd34',        // required — the id from your dashboard
  format: 'sidebar',            // banner | card | inline_native | sidebar | newsletter
  onEmpty: () => showMyOwnPromo()  // optional — called when the slot collapses
});

adjoin.trigger(moment, options?)

アプリの瞬間を記録します — signup_complete、empty_state、quota_hit など。枠がなくても記録されるので、広告を止めてもファネルは残ります。

// record a moment; with a placement it also renders an ad there
adjoin.trigger('signup_complete', { placement: 'plc_ab12' });

adjoin.pageview(path?)

無料の分析。パスは先頭 2 階層だけ送り、その中の ID は :id に置き換えます。

// sent automatically on load; call it yourself on client-side route changes
adjoin.pageview('/pricing');

<!-- or turn analytics off -->
<script async src="https://cdn.adjoin.dev/v1.js" data-analytics="off"></script>

adjoin.segment(label, on?)

オーディエンスラベル。現在のセッションを表す単語（プラン・役割・段階）を付けます。広告主はラベルで配信先を絞り込んだり除外したりできるので、ラベル付きの枠は高く売れます。ラベルはこのタブ（sessionStorage）だけにあり、このサイトの広告リクエストとページビューにだけ乗ります — 別サイトへ訪問者を追いかけません。保存されるのはラベルごとのページビュー合計だけです。形式: 小文字・数字・_ : -、32 文字以内、6 桁以上の連続数字は不可。セッションあたり最大 5 個。ネットワーク全体で 7 日間 100 ページビューに達するとターゲティングできます。

// label this visitor's session — plain words, never ids or emails
adjoin.segment('plan:free');
adjoin.segment('role:developer');
adjoin.segment('plan:free', false);   // remove one
adjoin.segment(null);                 // remove all

// suggested labels: plan:free · plan:paid · plan:trial · role:developer · role:designer
//                   role:founder · stage:onboarding · stage:active · intent:upgrade

adjoin.convert(valueUsd?, orderId?)

CPA・アフィリエイトの広告主向け。購入後に自分のサイトで呼びます。クリックトークンはこのタブ（sessionStorage）だけに保存するので、同じ訪問内のコンバージョンをつなぎます。注文 ID を渡すと同じ注文は二重課金されず、その ID で返金できます。数日後のコンバージョンはサーバー間（REST API）で送ってください。

// on your own site, after checkout
adjoin.convert(29.00, 'order_1234');   // value in USD, your order id

プライバシー

Cookie、localStorage、フィンガープリントは使いません。訪問者は毎日変わるハッシュで数えるため、同じ人を日をまたいで結び付けることはできません。

お問い合わせ: [email protected]