For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
コンテンツへスキップ

ブランド向けにイベント通知ポストバックを有効にする

イベント通知ポストバック(Webhook)は、特定のイベントが発生したときに内部システムにリアルタイムで通知します。送信されるデータはイベントによって異なりますが、設定手順はすべて同じです。

1

イベント通知ポストバックにアクセスする

  1. 上部のナビゲーションバーで、 [ユーザープロフィール] → 設定.

  2. 「 テクニカル 」セクションで「 イベント通知」を選択します。.

2

共通設定項目を入力する

  1. 通知ポストバックを設定するイベントにカーソルを合わせ、 [編集]を選択します。.

  2. 以下の表を参照して配信設定を行います。

項目
説明

URL

データを受信するサーバー上のエンドポイントです。

HTTPメソッド

GET:データはクエリ文字列としてURLに追加されます。

POST:データはリクエスト本文で送信されます。本文には、設定可能なさまざまなオプションパラメータが含まれます。 各イベントとペイロードの内容について詳しくは、 通知イベントとペイロード を参照してください。

HTTPヘッダー

(オプション)認証用のカスタムヘッダーを追加します(例: Authorization: Bearer token).

最小遅延

「 最小遅延 」を秒単位で設定し、急激なトラフィックの増加からサーバーを保護します。

最大リクエスト数

1秒あたりの「 最大リクエスト数 」を設定し、急激なトラフィックの増加からサーバーを保護します。

成功レスポンス

ポストバックが正常に処理されたときにサーバーが返す、特定の文字列またはHTTPステータスコードです。

エラーレスポンス

失敗を示す文字列またはステータスコードです(例: ERROR または 500).

通知イベントとペイロード

各イベント通知は、設定可能な固有のデータ項目セット(例: {ActionId})を送信します。ペイロードから抽出できるデータ項目については、以下のイベントを参照してください。

アクションライフサイクルイベント

アクションライフサイクルイベントは、アクションがトラッキング、変更、または取り消されたときに、指定された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アドレス
}
アクション照会イベント

アクション照会イベントでは、アクション照会が作成または解決されたときに、指定された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形式)
}
アクションクリアイベント

アクションクリアイベントでは、アクションがクリアされたときに、指定された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)
}
トラッキング値リクエストイベント

トラッキング値リクエストイベントでは、トラッキングリクエストが作成されたときに、指定された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" // 一意のクリック識別子
}
ジョブ完了イベント

ジョブ完了イベントは、ジョブが完了すると、指定したURL(および追加パラメーター)にHTTPリクエストを送信します。対象となるのは、次のいずれかのジョブです。 レポートのエクスポート または [エクスポート]をクリックします.

パブリッシャー申請イベント

パブリッシャー申請イベントは、パートナーが申請を送信したとき、および申請が承認、却下、撤回されるたびに、指定したURLにHTTPリクエストを送信します。

パブリッシャー申請イベントは、契約イベントのポストバック、申請処理Webhook、または申請Webhookとも呼ばれます。

PENDING PENDING ペイロードがデータポイントなしで配信された場合、システムは情報が利用可能になり次第、更新をトリガーするように設計されています。その後の配信が成功すると、以前は空だったフィールドに値が入力され、レコードが最新の処理済み情報と同期された状態に保たれます。

このWebhookとRecruitment Agentがどのように連携するかについては、 Recruitment Agent.

ペイロードの内容は ステータスによって異なります。以下の例は PENDING イベントを示しています。コメントには、他のステータスの場合に表示されるフィールドが記載されています。

ポストバックの再試行メカニズム

宛先URLへの送信時にポストバックが失敗すると、設定されたスケジュールに基づいて最大15回、自動的に再試行されます。一時的なネットワークの問題やサーバーの利用不能に対処するため、再試行が行われます。

再試行が行われない条件

次の場合、ポストバックは再試行されません。

  • 宛先URLの形式が正しくないか、無効です。

  • 宛先URLまたはそのホストを名前解決できません。たとえば、DNS検索に失敗した場合です。

再試行スケジュール

再試行は以下のスケジュールに従って行われます。HTTPレスポンスコードが次の範囲内の場合、再試行1、2、3はスキップされます。 400 から 500.

再試行スケジュールの参照
再試行回数
再試行までの遅延時間

再試行 1

+15秒

再試行 2

+15秒

再試行 3

+15秒

再試行 4

+3分

再試行 5

+3分

再試行 6

+15分

再試行 7

+15分

再試行 8

+15分

再試行 9

+2時間

再試行 10

+2時間

再試行 11

+2時間

再試行 12

+6時間

再試行 13

+6時間

再試行 14

+6時間

再試行 15

+6時間

最終更新

役に立ちましたか?