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

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

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

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

IntegrationIntegration への直接リンク

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

PartnerEventPartnerEvent への直接リンク

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

NameValuePairNameValuePair への直接リンク

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

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

イベントタイプ説明
SignalImpressionレイアウト、スロット、またはクリエイティブがレンダリングされ、顧客に表示されたときに発生します。表示遅延がある場合は、ビューが表示されるときに発生します。これはOne Platformダッシュボードのレイアウトインプレッションメトリックに関連します。
SignalViewedレイアウトがビューポート内で50%以上連続して1秒以上表示されると発生します。これはInteractive Advertising Bureau (IAB)によって設定された可視性の定義に一致し、非人間（ボット）トラフィック、不正なインプレッション、または無効な活動を除外する必要があります。
SignalResponse消費者がクリエイティブの応答オプションに関与したときに発生します。
SignalGatedResponse消費者がクリエイティブの「後でリマインド」応答オプションに関与したときに発生します。
SignalInitializeライブラリがレイアウトを表示しようとしたときに発生します。
SignalDismissal顧客がレイアウトを閉じるまたは却下したときにトリガーされます。
SignalActivation顧客がレイアウトと対話したときにトリガーされます。
SignalSdkDiagnosticRoktレイアウト内またはレンダリングプロセス中にエラーが発生したときにトリガーされます。パートナーはこのイベントをリッスンして例外を処理できます。

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

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

クリックして展開
{
    "integration": { ... Standard integration payload ... },
    "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": "Event type is invalid"
                },
                {
                    "code": "SessionIdMissing",
                    "message": "SessionId is missing or invalid"
                },
                {
                    "code": "ParentGuidIsMissing",
                    "message": "ParentGuid is null or empty"
                },
                {
                    "code": "EventTimeIsMissing",
                    "message": "EventTime is null or default"
                }
            ],
            "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@rokt.com)にお問い合わせください。

この記事は役に立ちましたか？
Last updated Aug 4, 2026