メインコンテンツまでスキップ

セッションイベントAPI仕様 (S2S)

このドキュメントは、セッションAPI (v2) を使用してRoktにイベントを送信するために必要なエンドポイントを概説しています。

必要な認証情報を取得するには、Roktのアカウントチームと連携してください。エンドツーエンドの統合手順については、セッションAPI統合 (S2S) を参照してください。

エンドポイントエンドポイント への直接リンク

環境アクションURL
本番POSThttps://api.rokt.com/v2/sessions/events
注記

別のサンドボックスURLはありません。本番公開前に検証するには、同じエンドポイントで rokt-test-session: true ヘッダーを送信してください。テストセッションはタグ付けされ、本番メトリクスから除外されます。このヘッダーは報告のみを示し、オファーの提供を強制するものではありません。公開するにはヘッダーを削除してください。

リクエストリクエスト への直接リンク

認証ヘッダー認証ヘッダー への直接リンク

ヘッダー説明タイプ注記
Authorization基本認証情報stringBasic base64(rpub:rsec) — オファーコールで使用するのと同じ公開/秘密APIキーのペアです。
rokt-account-idあなたのRoktアカウントIDstringすべてのコールで必須です。

必須ヘッダー必須ヘッダー への直接リンク

ヘッダー説明タイプ例
Content-Typeメディアタイプstringapplication/json

ルート/ボディルート/ボディ への直接リンク

プロパティ必須タイプ説明
channelはいobject"type": "s2s" を含める必要があります。
single_sessionはいbooleantrue に設定します。リクエスト内のすべてのイベントを各イベントの session_id で識別されるセッションにリンクします。
eventsはいEvent[]Roktに送信するイベントのコレクションです。

イベントイベント への直接リンク

プロパティ必須タイプ説明
event_typeはいstringイベントの種類です。イベントタイプを参照してください。
instance_idはいstring (UUID)このイベントを識別するクライアント生成のUUIDで、重複排除に使用されます。
session_idはいstringオファーコールで返されるトップレベルの session_id です。
timestampはいnumberイベントが発生したUnixエポックミリ秒です。
dataはいobjectイベントデータを参照してください。

イベントデータイベントデータ への直接リンク

プロパティ必須タイプ説明
parent_idはいstringこのイベントに関連する要素のinstance_guid。オファーのレスポンスから取得（例：インプレッションの場合はクリエイティブのinstance_guid、レスポンスの場合はレスポンスオプションのinstance_guid）。セッションツリーを構築します。オファーのレスポンスからの値をそのままエコーしてください。タイププレフィックスを含む場合があります（例：ad:<uuid>）。返された通りに送信してください。
page_instance_guidはいstringオファーのレスポンスからのpage_instance_guid。
tokenはいstringオファーのレスポンスからのその要素のイベントトークン。
capture_methodいいえstringイベントがどのようにキャプチャされたか（例：ClientProvided）。
注記

オファーコールと同じBasic rpub:rsec 認証情報で認証し、single_session: true とイベントごとのsession_id（オファーのレスポンスからのトップレベルのsession_id）でセッションを識別してください。

イベントタイプイベントタイプ への直接リンク

イベントevent_type説明
インプレッションimpression配置、スロット、またはクリエイティブがレンダリングされ、顧客に表示されるときに発生します。表示の遅延がある場合は、ビューが非表示から表示されたときに発生します。レンダリングされる各要素に必須です。
表示済みviewed配置がビューポート内で連続して1秒以上50%以上表示されるときに発生します。IAB のビューアビリティ定義に一致し、ボット/無効なトラフィックを除外する必要があります。表示可能になる各クリエイティブに必須です。
レスポンスsignal_response顧客がレスポンスオプションにエンゲージしたときに発生します。各レスポンスオプションのインタラクションに必須です。
解消dismissal顧客がオファーを解消したときに発生します。
コンバージョンconversion_signalコンバージョンが発生したときに発生します。
購入purchase購入が完了したときに発生します。

リクエスト例リクエスト例 への直接リンク

POST https://api.rokt.com/v2/sessions/events
Authorization: Basic base64(rpub:rsec)
rokt-account-id: <your Rokt account ID>
Content-Type: application/json
{
  "channel": { "type": "s2s" },
  "single_session": true,
  "events": [
    {
      "event_type": "impression",
      "instance_id": "018f1234-5678-7abc-8def-0123456789ab",
      "session_id": "018f2a1b-2222-7abc-8def-session00001",
      "timestamp": 1751234567000,
      "data": {
        "parent_id": "018f2a1b-3333-7abc-8def-creative001",
        "page_instance_guid": "018f2a1b-0000-7abc-8def-page00000001",
        "token": "<event-token>",
        "capture_method": "ClientProvided"
      }
    },
    {
      "event_type": "viewed",
      "instance_id": "018f1234-5678-7abc-8def-0123456789ac",
      "session_id": "018f2a1b-2222-7abc-8def-session00001",
      "timestamp": 1751234568000,
      "data": {
        "parent_id": "018f2a1b-3333-7abc-8def-creative001",
        "page_instance_guid": "018f2a1b-0000-7abc-8def-page00000001",
        "token": "<event-token>"
      }
    },
    {
      "event_type": "signal_response",
      "instance_id": "018f1234-5678-7abc-8def-0123456789ad",
      "session_id": "018f2a1b-2222-7abc-8def-session00001",
      "timestamp": 1751234572000,
      "data": {
        "parent_id": "018f2a1b-4444-7abc-8def-responseoption01",
        "page_instance_guid": "018f2a1b-0000-7abc-8def-page00000001",
        "token": "<event-token>"
      }
    }
  ]
}

レスポンスレスポンス への直接リンク

成功レスポンス (202 Accepted)成功レスポンス (202 Accepted) への直接リンク

成功した呼び出しは、後続の呼び出しで使用するための更新されたセッショントークンと、イベントごとの結果を伴って、202 Accepted を返します。

プロパティタイプ説明
session_tokenobject次の呼び出しのための更新されたセッショントークン (session_token.token)。
event_idsstring[]リクエスト順に受け入れられたイベントに割り当てられたID。
errorsobject[]イベントごとのエラー。各エラーは index、code、および message を含みます。すべてのイベントが受け入れられた場合は空です。
warningsobject[]イベントごとの警告。index/code/message 形式。警告がない場合は空です。

すべてのイベントが受け入れられた場合、errors と warnings は空であり、event_ids には送信されたイベントごとに1つのエントリがあります。

{
  "session_token": {
    "token": "<session_token>"
  },
  "event_ids": [
    "018f9c40-1a2b-7abc-8def-eventimpression",
    "018f9c40-1a2b-7abc-8def-eventviewed0001",
    "018f9c40-1a2b-7abc-8def-eventresponse01"
  ],
  "errors": [],
  "warnings": []
}

部分的な失敗の場合でも、呼び出しは 202 を返し、受け入れられたイベントは event_ids に表示され、拒否された各イベントはリクエスト配列内の index によって errors に報告されます。

{
  "session_token": {
    "token": "<session_token>"
  },
  "event_ids": [
    "018f9c40-1a2b-7abc-8def-eventimpression",
    "018f9c40-1a2b-7abc-8def-eventviewed0001"
  ],
  "errors": [
    {
      "index": 2,
      "code": "invalid_token",
      "message": "token does not match the element identified by parent_id"
    }
  ],
  "warnings": []
}

エラーレスポンス (4xx / 5xx)エラーレスポンス (4xx / 5xx) への直接リンク

エラーは、構造化されたボディを持つセマンティックなHTTPステータスを返します。

{
  "error": "<code>",
  "message": "<detail>"
}

共通のエラーコード共通のエラーコード への直接リンク

HTTPステータス意味
400不正なリクエストボディ。
401Authorization ヘッダーが欠落しているか無効です。
422リクエストの検証に失敗しました。
429レート制限されています。自動的に再試行しないでください。429が続く場合は、Roktの担当者に連絡してください。
5xx予期しないサーバーエラー。短い遅延（1〜2秒）後に再試行してください。問題が続く場合は、support@rokt.com に連絡してください。
この記事は役に立ちましたか？
Last updated Aug 4, 2026