ブランド向けイベント通知ポストバックを有効にする
イベント通知ポストバック(webhook)は、特定のイベントが発生したときに内部システムへリアルタイムで通知します。送信されるデータはイベントごとに異なりますが、設定手順はすべて同じです。
イベント通知ポストバックにアクセスする
上部のナビゲーションバーから、
[ユーザープロフィール] → [設定].
以下の 技術 セクションで、選択します イベント通知.
グローバル設定項目をすべて入力する
通知ポストバックを設定したいイベントにカーソルを合わせて、
[編集].
配信設定を構成するには、以下の表を使用してください:
URL
データを受信するサーバー上のエンドポイント。
HTTPメソッド
GET: データはクエリ文字列としてURLに追加されます。
POST: データはリクエストボディに送信されます。これには設定可能なさまざまな任意パラメーターが含まれます。
参照先: 通知イベントとペイロード 各イベントとペイロード内容の詳細については、こちらをご覧ください。
HTTPヘッダー
(任意)認証用のカスタムヘッダーを追加します(例: Authorization: Bearer token).
最小遅延
設定する 最小遅延 秒で設定し、トラフィック急増からサーバーを保護します。
最大リクエスト数
設定する 最大リクエスト数 秒あたりのリクエスト数で、トラフィック急増からサーバーを保護します。
成功レスポンス
ポストバックが正しく処理されたときに、サーバーが返す特定のテキスト文字列またはHTTPステータスコード。
エラーレスポンス
失敗を示すテキスト文字列またはステータスコード(例: ERROR または 500).
通知イベントとペイロード
各イベント通知では、設定可能な固有のデータポイントのセットが送信されます(例: {ActionId})。ペイロードから抽出できるデータポイントについては、以下のイベントを参照してください。
アクションライフサイクルイベント
Action Lifecycle Events は、アクションがトラッキング、変更、または取り消しされたときに、指定されたURL(および含まれる任意のパラメーター)へHTTPリクエストを送信します。
// JSON形式のPOST例
{
"CampaignId": 9876, // プログラムID
"ActionTrackerId": 12345, // イベントタイプID
"MediaPartnerId": 555, // パートナーID
"CampaignName": "Spring Global Promotion", // プログラム名
"ActionTrackerName": "Standard Sale Tracker", // イベントタイプ名
"MediaPartnerName": "Top Tier Affiliates", // パートナー名
"ActionId": "ACT-778899", // アクションID
"Status": "MODIFIED", // アクションのステータス
"StatusDetail": "Item return - payout adjusted", // アクションステータスの詳細
"AdId": 44332, // 広告ID
"Payout": 10.50, // パートナーへのアクション支払額(パートナーの通貨)
"DeltaPayout": -5.00, // 支払額の変化
"IntendedPayout": 15.50, // 上限超過アクションに対する想定支払額
"Amount": 100.00, // アカウントの通貨でのアクション金額
"DeltaAmount": -50.00, // 前回のアクションから修正された金額
"IntendedAmount": 150.00, // 上限超過アクションに対する想定売上金額
"Currency": "USD", // アクションの通貨
"OriginalCurrency": "USD", // アクションの元の通貨(つまりカートの通貨)
"OriginalAmount": 100.00, // アクションの元の金額(つまりカート金額)
// "items"コレクション:このアクション内の個別アイテムのデータ
"items": [{join(items, i,
"\{\"sku\":\"{i.sku}\",
\"item_price\":{i.amt},
\"category\":\"{i.cat}\",
\"quantity\":{i.qty},
\"cartamt\":{i.cartamt},
\"rbt\":\"{i.rbt}\",
\"name\":\"{i.name}\"\}")}],
"EventDate": "2026-04-08T09:00:00Z", // コンバージョン日時
"CreationDate": "2026-04-08T09:05:00Z", // システムで作成された日時
"LockingDate": "2026-05-08T00:00:00Z", // アクションがロックされる日時
"ClearedDate": "2026-05-15T00:00:00Z", // クリア予定日時
"ReferringDomain": "blog.partner.com", // 参照元ドメイン
"LandingPageUrl": "https://brand.com/sale", // ランディングページのURL
"RefCustomerArea": "California", // 顧客エリア(IPから推定)
"RefCustomerCity": "San Francisco", // 顧客市区町村(IPから推定)
"RefCustomerRegion": "CA", // 顧客地域(IPから推定)
"RefCustomerCountry": "US", // 顧客国コード(IPから推定)
"RefClickId": "CLK9988776655", // 一意のクリック識別子
"SharedId": "social_post_01", // パートナー共有ID
"PromoCode": "SAVE20", // 一般プロモコード
"CustomerStatus": "EXISTING", // 顧客ステータス
"Oid": "ORD-554433", // 注文ID
"Note": "Partial return processed", // アクションに付随するメモ
"CustomerPostCode": "94105", // 顧客郵便番号
"CustomerCity": "San Francisco", // 顧客市区町村
"CustomerCountry": "US", // 顧客国コード
"CustomerRegion": "CA", // 顧客地域
"CustomerId": "CUST-12345", // 顧客ID
"CustomerEmail": "a665a45920422f9d417...", // ハッシュ化された顧客メールアドレス
"IpAddress": "192.168.1.1", // IPアドレス
"CallerId": null, // 発信者の電話番号
// カスタム補足フィールド
"Text1": "Custom Val 1", // テキスト1
"Date1": "2026-04-08", // 日付1
"Money1": 10.00, // 金額1
"Numeric1": 1, // 数値1
// デバイスとアプリのメタデータ
"appPackage": "com.brand.app", // モバイルアプリのパッケージ
"appName": "BrandStore", // モバイルアプリ名
"appVersion": "4.2.1", // モバイルアプリのバージョン
"deviceOs": "iOS", // デバイスのオペレーティングシステム
"deviceOsVersion": "17.4", // デバイスのOSバージョン
"deviceManuf": "Apple", // デバイスメーカー
"deviceModel": "iPhone 15", // デバイスモデル
"macAddress": "00:1B:44:11:3A:B7", // MACアドレス(大文字)
"macAddressLower": "00:1b:44:11:3a:b7", // MACアドレス(小文字)
"macAddressAlpha": "001B44113AB7", // MACアドレス(コロンなし)
"macAddressSha1": "47a32...", // MAC SHA1
"iosIfa": "EA7583CD-A667-48BC-B806-42ECB2B48606", // iOS広告ID
"iosAdTracking": "1", // iOS広告トラッキング設定
"androidId": null, // Android ID
"deviceId": "D-556677", // デバイスID
"deviceIp": "192.168.1.1" // デバイスIP
}アクション問い合わせイベント
Action Inquiry Events は、アクション問い合わせが作成または解決されたときに、指定されたURL(および含まれる任意のパラメーター)へHTTPリクエストを送信します。
// JSON形式のPOST例
{
"Id": 554433, // システム内のアクション問い合わせの一意識別子
"MediaPartnerId": 555, // パートナーID
"MediaPartnerName": "Top Tier Affiliates", // パートナー名
"CampaignId": 9876, // プログラムID
"CampaignName": "Spring Global Promotion", // プログラム名
"OrderId": "ORD-12345", // 報告されたアクションの注文ID
"TransactionDate": "2026-04-01T14:30:00Z", // アクション問い合わせの発生元イベントの取引日時
"TransactionAmount": 250.00, // アクション問い合わせの発生元イベントの取引金額
"InquiryType": "MISSING_ACTION", // アクション問い合わせの種類
"ExpectedPayout": 25.00, // パートナーが期待する支払額
"ResolutionDeadlineDate": "2026-05-01T00:00:00Z", // 問い合わせを承認または却下しなければならない日付
"TrackingLink": "https://proweb.com/click?cid=1&pid=555", // パートナーが提供したトラッキングリンク
"ActionId": "ACT-999000", // アクションID(既存のアクションに関連付けられている場合)
"AutoApprovalDate": "2026-05-05T00:00:00Z", // システムが自動承認ルールを実行する日付
"ResolutionStatus": "PENDING", // アクション問い合わせの最終解決ステータス
"RejectReason": null, // アクション問い合わせが却下された理由
"FinalPayout": 0.00, // アクション問い合わせに関連付けられた最終支払額
"ResolutionDate": null, // 問い合わせが決定された日付
"CreationDate": "2026-04-08T10:05:00Z", // 問い合わせがシステムに作成された日時
"InquiryNotes": "Customer claims they clicked the link but no credit was shown.", // パートナーが送信した問い合わせメモ
"ResolutionNotes": null, // 問い合わせが決定されたときに送信されたメモ
"Comments": "[{\"user\": \"support_agent\", \"text\": \"Verifying click logs now.\"}, {\"user\": \"partner\", \"text\": \"Customer provided receipt.\"}]" // 問い合わせに追加されたコメント(JSON形式)
}アクションクリアイベント
Action Clearing Events は、アクションがクリアされたときに、指定されたURL(および含まれる任意のパラメーター)へHTTPリクエストを送信します。
// JSON形式のPOST例
{
"ActionTrackerId": 12345, // イベントタイプID
"ActionTrackerName": "Standard Sale Tracker", // イベントタイプ名
"CampaignId": 9876, // プログラムID
"CampaignName": "Spring Global Promotion", // プログラム名
"MediaPartnerId": 555, // パートナーID
"MediaPartnerName": "Top Tier Affiliates", // パートナー名
"OrderIds": "ORD-9921,ORD-9922", // 報告されたアクションの注文ID(カンマ区切り)
"ActionIds": "ACT-101,ACT-102", // アクションID(カンマ区切り)
"ClearedDate": "2026-04-15T12:00:00Z", // アクションがクリア予定の日時(ISO 8601)
"LedgerDate": "2026-04-08T09:54:43Z" // アクションがクリアされた日時(ISO 8601)
}トラッキング値リクエストイベント
Tracking Value Request Events は、トラッキングリクエストが作成されたときに、指定されたURL(および含まれる任意のパラメーター)へHTTPリクエストを送信します。
// JSON形式のPOST例
{
"CampaignId": 9876, // プログラムID
"ActionTrackerId": 12345, // イベントタイプID
"MediaPartnerId": 555, // パートナーID
"ActionId": "ACT-778899", // アクションID
"Amount": 150.00, // アカウントの通貨でのアクション金額
"Currency": "USD", // アクションの通貨
"Oid": "ORD-554433", // 注文ID
// "items"コレクション:アクション内の個別商品の内訳
"items": [{join(items, i, "\{\"sku\":\"{i.sku}\",\"item_price\":{i.amt},\"category\":\"{i.cat}\",\"quantity\":{i.qty},\"cartamt\":{i.cartamt},\"rbt\":\"{i.rbt}\",\"name\":\"{i.name}\"\}")}],
"EventDate": "2026-04-08T09:00:00Z", // コンバージョン日時
"IpAddress": "192.168.1.1", // デバイスのIPアドレス
"RefClickId": "CLK9988776655" // 一意のクリック識別子
}完了ジョブイベント
Completed Job Events は、ジョブが完了すると、指定されたURL(および追加パラメーター)へHTTPリクエストを送信します。 レポートエクスポート または クリックエクスポート.
パブリッシャー申請イベント
注: この機能はベータ版です。CSMまたは当社の サポートチーム この機能を試したい場合はお問い合わせください。
Publisher Application Events は、パートナーが申請を送信したとき、および申請が承認、却下、または撤回されるたびに、指定されたURLへHTTPリクエストを送信します。
もし 保留中 空のデータポイントを含むペイロードが配信された場合、情報が利用可能になるたびに更新をトリガーするようにシステムは設計されています。その後の正常な配信で、以前空だったフィールドに値が入力されるため、レコードは最新の処理済み情報と同期された状態に保たれます。
重要: お持ちの場合は 申請ワークフロー が設定されている場合、webhook が発火する前に実行されます。webhook はその結果として ステータス: 承認済み または 却下 ワークフローが申請を処理した場合、 保留中 ワークフローが適用されなかった場合、または 撤回 パートナーが申請を取り下げた場合。
ペイロードの内容は ステータス。以下の例では 保留中 イベントの例で、他のステータスでどのフィールドが表示されるかをコメントで示しています。
ポストバック再試行メカニズム
ポストバックの送信先URLへのPOSTに失敗した場合、配信は設定されたスケジュールに基づいて自動的に最大15回まで再試行されます。再試行は、一時的なネットワーク障害やサーバーの利用不可に対処するのに役立ちます。
再試行が行われない条件
以下の場合、ポストバックは再試行されません:
送信先URLの形式が不正、または無効です。
送信先URLまたはそのホストが解決できません。たとえばDNSルックアップ失敗などです。
再試行スケジュール
再試行は以下のスケジュールに従います。HTTPレスポンスコードが次の範囲内の場合、再試行1、2、3はスキップされます。 400 を 500.
最終更新
役に立ちましたか?

