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

V2 パートナーイベント API 仕様

このドキュメントは、Rokt の API と連携して イベント を Rokt に送信するために必要な関連エンドポイントを概説しています。

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

環境アクションURL
本番環境POSThttps://server-api.rokt.com/v2/partner/events
テスト環境POSThttps://server-api-demo.rokt.com/v2/partner/events

テストのベストプラクティステストのベストプラクティス への直接リンク

テストエンドポイント https://server-api-demo.rokt.com/v2/partner/events は、テスト専用に設計されており、本番データやパフォーマンスに影響を与えることなく統合を検証するために使用する必要があります。API ドキュメントで指定されている適切なヘッダーとリクエスト形式を使用して、本番環境に近いシナリオを効果的にエミュレートしてください。

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

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

このエンドポイントとやり取りするために必要な資格情報を取得するには、アカウントマネージャーと連携してください

ヘッダーキー必須説明型備考
rokt-pub-idはい提供されたクライアントのパブリックIDを含むstringこれはRoktによって提供されます。
rokt-secretはい提供されたクライアントのパブリックシークレットを含み、パブリックIDと一致する必要がありますstringこれはRoktによって提供されます。

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

ヘッダーキー必須説明型例
content-typeはいメディアタイプstring“application/json”
acceptはいレスポンスの期待されるメディアタイプstring“application/json”
rokt-tag-idはいRokt タグIDstring1234567890

Root/BodyRoot/Body への直接リンク

プロパティ名必須データ型説明
EventsはいPartnerEvent[]Roktに送信されるイベントのコレクション
IntegrationはいIntegrationリクエストを行う統合に関するデータ。これはAndroid、iOS、Web用のUXHelperライブラリから取得可能です

IntegrationIntegration への直接リンク

プロパティ名必須データ型説明
Nameはいstringリクエストを行う統合の一般名を示します
Versionはいstringリクエストを行う統合のバージョン
Frameworkはいstring使用されている統合フレームワーク（例: Flutter, React Native）
Platformはいstring/enumオファーをリクエストするパートナープラットフォーム（例: Web, Mobile, iOS）
LayoutSchemaVersionはいstring統合のための最高互換スキーマバージョン
DeviceLocaleはいstringユーザーのデバイスからのロケール設定
DeviceModelはいstringiOSのデバイスモデルまたはAndroidのビルドモデル
DeviceTypeはいstringデバイス/フォームファクタのタイプ（例: Phone, Tablet）
OperatingSystemはいstringユーザーのデバイスのオペレーティングシステム
OperatingSystemVersionはいstringユーザーのデバイスのOSバージョン
PackageNameはいstringホストアプリケーションのパッケージ名またはバンドル識別子
PackageVersionYesstringホストアプリケーションのパッケージバージョンまたはバンドルバージョン
MetadataNoMap<string, string>インテグレーションまたはデバイスに関連する追加データ

PartnerEventPartnerEvent への直接リンク

Property NameRequiredDataTypeDescription
EventTypeYesstring発行されるイベントの名前。Event Types セクションの eventType に一致します。
EventTimeYesstringイベントが作成された時間を DateTimeOffset (GMT+0 の ISO 文字列) で表します。例: 2022-04-20T00:11:47.529Z
SessionIdYesstringイベントに関連付けられたセッションの ID。/experiences レスポンスから取得されます。SuccessBody を参照してください。
ParentGuidYesstringリンクされた親のインスタンス GUID。このフィールドのソースについては Event Types - Parent GUID Source を参照してください。
PageInstanceGuidYesstringオファーが取得されたページ/ビューの一意の識別子。/experiences レスポンスから取得されます。PageContext を参照してください。
ClientUniqueIdNostringRokt セッションとパートナーセッションをトラブルシューティングのためにリンクするための識別子 (例: Uber Session ID)。
EventDataNostringイベントに必要な追加データ。
メタデータ必須NameValuePair[]イベントに関連する追加のメタデータのコレクション。

NameValuePairNameValuePair への直接リンク

プロパティ名必須データ型説明
Nameはいstring提供されるプロパティの名前/識別子
Valueはいstring提供された名前に関連するデータ
注記
  • エンドポイントは一度に最大25のイベントしか処理できません
  • 同じリクエストに属するすべてのイベントは同じセッション識別子 sessionId を共有する必要があります
  • 各イベントのEventTimeは以下の条件を満たす必要があります:
    • 未来の日付でないこと（5分の猶予あり）
    • 過去3日以上前でないこと

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

イベントタイプ説明
SignalImpressionレイアウト、スロット、またはクリエイティブがレンダリングされ、顧客に表示されるたびに発生します。表示の遅延がある場合は、ビューが表示される際に発生します。これはOne Platformダッシュボードのレイアウトインプレッションメトリクスに関連しています。
SignalViewedレイアウトがビューポート内で50%以上可視で、少なくとも1秒間表示されているときに発生します。
SignalResponse消費者がクリエイティブの応答オプションにエンゲージしたときに発生します。
SignalGatedResponse消費者がクリエイティブの「後で通知する」応答オプションにエンゲージしたときに発生します。
SignalInitializeライブラリがレイアウトを表示しようとする際に発生します
SignalDismissal顧客がレイアウトを閉じるか却下したときにトリガーされます。
SignalActivation顧客がレイアウトと対話したときにトリガーされます。
SignalSdkDiagnosticRoktレイアウト内またはレンダリングプロセス中にエラーが発生したときにトリガーされます。パートナーはこのイベントをリッスンして例外を処理できます。

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

JSON リクエストボディ/ペイロード

クリックして展開
{
    "integration": { ... 標準のインテグレーションペイロード ... },
    "events": [
        {
            "eventType": "SignalImpression",
            "eventTime": "2022-06-28T07:11:01.710Z",
            "parentGuid": "8ed27738-fec8-49e4-9436-d44faa6eaf0f",
            "sessionId": "aec20024-8d23-46be-95f3-9be5d86292a9",
            "clientUniqueId": "10f7d87b-e879-47b2-9638-a667e63beae2"
            "pageInstanceGuid": "8ed27738-fec8-49e4-9436-d44faa6eaf0f"
        },
        {
            "eventType": "SignalImpression",
            "eventTime": "2022-06-28T07:11:01.711Z",
            "parentGuid": "58bcbaa0-e13c-4a3d-84cd-2803ccc35394",
            "sessionId": "aec20024-8d23-46be-95f3-9be5d86292a9",
            "clientUniqueId": "10f7d87b-e879-47b2-9638-a667e63beae2",
            "pageInstanceGuid": "8ed27738-fec8-49e4-9436-d44faa6eaf0f",
            "metadata": [
                {
                    "name": "AdditionalData",
                    "value": "ImpressionSlot"
                }
            ]
        },
        {
            "eventType": "SignalImpression",
            "eventTime": "2022-06-28T07:11:01.711Z",
            "parentGuid": "b3a1d523-5490-49f0-a379-7a67628a4cdd",
            "sessionId": "aec20024-8d23-46be-95f3-9be5d86292a9",
            "clientUniqueId": "10f7d87b-e879-47b2-9638-a667e63beae2",
            "pageInstanceGuid": "8ed27738-fec8-49e4-9436-d44faa6eaf0f",
            "metadata": [
                {
                    "name": "AdditionalData",
                    "value": "ImpressionCreative"
                }
            ]
        },
        {
            "eventType": "SignalResponse",
            "eventTime": "2022-06-28T07:11:01.711Z",
            "parentGuid": "6bea8e29-b3cd-4717-bd82-59ccbca0d863",
            "sessionId": "aec20024-8d23-46be-95f3-9be5d86292a9",
            "clientUniqueId": "10f7d87b-e879-47b2-9638-a667e63beae2",
            "pageInstanceGuid": "8ed27738-fec8-49e4-9436-d44faa6eaf0f",
            "metadata": [
                {
                    "name": "experienceId",
                    "value": "RedButton"
                }
            ]
        }
    ]
}

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

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

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

プロパティ名データ型説明
successbooleanイベントがRoktによって正常に受信されたかどうかを示します
processedEventsCountnumber/intRoktによって正常に受け入れられたイベントの数を示します
unprocessedEventsUnprocessedEvent[]受け入れられなかったイベントのコレクションと、各イベントごとのエラー説明を含みます

UnprocessedEventUnprocessedEvent への直接リンク

プロパティ名データ型説明
eventPartnerEventイベントがRoktによって正常に受信されたかどうかを示します
errorsError[]Roktによって正常に受け入れられたイベントの数を示します

例例 への直接リンク

{
    "processedEventsCount": 5,
    "unprocessedEvents": [],
    "success": true }

部分成功レスポンス (207)部分成功レスポンス (207) への直接リンク

有効なイベントと無効なイベントが送信された場合、Roktは有効なイベントの処理を試み、受け入れられた数を示し、処理されなかったイベントを提供する混合レスポンス (HTTP 207) ステータスを返します。

クリックして展開
{
    "processedEventsCount": 5,
    "unprocessedEvents": [
        {
            "errors": [
                {
                    "code": "InvalidEventType",
                    "message": "イベントタイプが無効です"
                },
                {
                    "code": "SessionIdMissing",
                    "message": "SessionIdが欠落しているか無効です"
                },
                {
                    "code": "ParentGuidIsMissing",
                    "message": "ParentGuidがnullまたは空です"
                },
                {
                    "code": "EventTimeIsMissing",
                    "message": "EventTimeがnullまたはデフォルトです"
                }
            ],
            "event": {
                "eventType": "Unknown",
                "sessionId": "",
                "eventTime": "0001-01-01T00:00:00+00:00",
                "parentGuid": "",
                "clientUniqueId": "265d3a90-4c84-4c17-99af-e09b862b925c"
            }
        }
    ],
    "success": false
}

リクエストエラー応答 (4XX)リクエストエラー応答 (4XX) への直接リンク

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

プロパティ名データ型説明
titlestringトップレベルの失敗理由
statusnumberHTTP ステータスコード
successbooleanリクエストが成功したかどうかを示します
errorsError[]発生したバリデーションエラーのコレクション

バリデーションエラーバリデーションエラー への直接リンク

{
    "title": "Validation failed",
    "status": 422,
    "success": false,
    "errors": [
        {
            "code": "TooManyEvents",
            "message": "The number of events provided exceeds the limit 25"
        },
        {
            "code": "IntegrationNotProvided",
            "message": "Integration is required"
        }
    ]
}

空のイベントリクエスト空のイベントリクエスト への直接リンク

{
    "title": "Validation failed",
    "status": 422,
    "success": false,
    "errors": [
        {
            "code": "NoEventsProvided",
            "message": "Events cannot be null or empty"
        }
    ]
}

空のボディリクエスト空のボディリクエスト への直接リンク

{
    "title": "BadRequest",
    "status": 400,
    "success": false,
    "errors": [
        {
            "code": "InvalidRequestPayload",
            "message": "Request body format is not valid"
        }
    ]
}

エラーエラー への直接リンク

プロパティ名データ型説明
codestring対応するエラーコード
messagestringエラーを説明するメッセージ

内部サーバーエラー (HTTP 5xx)内部サーバーエラー (HTTP 5xx) への直接リンク

まれに、システムが予期せずリクエストを完了できない場合があります。この場合、標準のHTTPレスポンスコードに準拠した適切なステータスコードでボディのないリクエストを返します。このレスポンスが発生した場合は、短い遅延（1〜2秒）の後にリクエストを再試行することをお勧めします。問題が持続するか一貫して発生する場合は、問題の特定と修正を支援するためにsupport(support@rokt.com)までご連絡ください。

この記事は役に立ちましたか？
Last updated Oct 29, 2025