← ドキュメント
REST API
ダッシュボードでできることを、API キーで HTTPS から。
認証
設定 → API keys でキーを作り、Bearer トークンとして送ります。キーは一度だけ表示されます。
curl https://api.adjoin.dev/v1/me \
-H "Authorization: Bearer adj_live_…"- read
- GET リクエスト。
- write
- キャンペーン・サイト・枠の作成と変更。
- conversions
- サーバー間コンバージョンのエンドポイントのみ。
キーは管理者になれず、キーの発行や出金はできません — ログインした本人だけができます。
金額は常に micros の整数です: 1 USD = 1,000,000。
エンドポイント
- GET /v1/me
- キーの持ち主。
- GET /v1/campaigns
- キャンペーンと状態・入札・予算・消化。
- POST /v1/campaigns
- キャンペーン作成。審査から始まり、予算はプリペイド残高から確保されます。
- POST /v1/campaigns/plan
- 予算を決める前の開始入札・到達予測・予約額。
- GET /v1/refunds?campaign_id=cmp_…
- フィルタして課金しなかったクリックと理由。
- POST /v1/conversions/s2s
- サーバーからコンバージョンを確認。
- POST /v1/conversions/s2s/refund
- 返品期間内の注文を取り消し。
- GET /v1/sites · POST /v1/sites
- サイト一覧、ドメイン登録。
- POST /v1/sites/{site_id}/verify
- ドメイン所有の確認(DNS TXT・ファイル・メタタグ)。
- GET /v1/placements?site_id= · POST /v1/placements
- サイトの枠、枠の作成。
- GET /v1/placements/{placement_id}/live
- 直近 24 時間に枠へリクエストがあったか。
- GET /v1/boost · POST /v1/boost
- Launch Day Boost の状態、キャンペーンに適用。
- GET /v1/credits
- クロスプロモのクレジット残高と最近の動き。
- GET /v1/segments
- パブリッシャーが付けたオーディエンスラベルと 7 日間のページビュー(100 以上のみ)。キャンペーン作成時の target_segments / exclude_segments に使います。
キャンペーンを作る
pricing_model は cpc, cpm, cpa, affiliate, guaranteed, cross_promo(クレジット払い、現金予算なし)のいずれか。402 は利用可能残高の不足です。
curl -X POST https://api.adjoin.dev/v1/campaigns \
-H "Authorization: Bearer adj_live_…" -H "Content-Type: application/json" \
-d '{
"name": "Launch",
"pricing_model": "cpc",
"bid_micros": 300000,
"total_budget_micros": 50000000,
"daily_cap_micros": 5000000,
"target_categories": ["devtools"],
"creatives": [{ "headline": "Ship faster", "body": "…", "cta": "Try it",
"landing_url": "https://myapp.dev", "format": "card" }]
}'サーバー間コンバージョン
キャンペーンのコンバージョン元を s2s にし、conversions スコープのキーでサーバーから注文を確認します。そのキャンペーンはピクセルで課金されないため、1 つの注文が二経路で課金されることはありません。クリック後 7 日まで確認できます。
# the ad click lands on https://myapp.dev/?aj_t=… — keep aj_t with the order
curl -X POST https://api.adjoin.dev/v1/conversions/s2s \
-H "Authorization: Bearer adj_live_…" -H "Content-Type: application/json" \
-d '{ "click_token": "<aj_t>", "order_id": "order_1234", "value_micros": 29000000 }'
# a return or cancellation, inside the return window
curl -X POST https://api.adjoin.dev/v1/conversions/s2s/refund \
-H "Authorization: Bearer adj_live_…" -H "Content-Type: application/json" \
-d '{ "campaign_id": "cmp_…", "order_id": "order_1234" }'エラー
エラーは detail を持つ JSON です。401: キーなし・不正。403: スコープ不足。他アカウントのオブジェクトにも 404 を返し、存在を明かしません。
お問い合わせ: [email protected]