Last updated 2023年9月12日

Webhook イベントのペイロード

導入

Webhook イベントの JSON ペイロードのルートレベルには、eventId、eventType、eventDetails の 3 つのフィールドが含まれています。

[eventDetails] の値は、関連するイベントタイプに基づいた特定のオブジェクトで埋められます。

以下は、イベントオブジェクトを構成する詳細です:

パラメータ	タイプ	説明
eventId (常に存在)	UUID/GUID	ユニークなイベントを表す値です。
eventType (常に存在)	文字列	発生したイベントのタイプを表す値です。現在サポートされている値は、Subscribe、Unsubscribe、SubscriptionDetailsUpdated、SubscriptionEventAdded、SubscriptionEventUpdated、SubscriptionEventRemoved、SubscriptionEventDeleted、Test です。
eventDetails (常に存在)	オブジェクト	発生したイベントに関する詳細です。各イベントタイプについて送信される内容については、以下を参照してください。

サポートされているイベントの種類

購読時

購読時のウェブフックイベントペイロード

ウェブフックイベントは、新しい購読エンドポイントに対して行われたAPI呼び出し時にトリガーされます。

以下は、ウェブフックイベントのペイロードの詳細です：

パラメーター	タイプ	説明
eventId (常に存在)	UUID/GUID	一意のイベントを表す値です。
eventType (常に存在)	文字列	発生したイベントの種類を表す値です。Subscribe
eventDetails (常に存在)	イベントの詳細 - 購読	購読イベントに送信される情報の詳細については、以下を参照してください。

購読時のペイロード

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
  "eventType": "Subscribe",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscription": {
      "calendarSubscriptionId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
      "calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
      "calendarTitle": "My Sports Calendar",
      "calendarCode": "my-sports-calendar",
      "subscriptionMethod": "Google",
      "calendarTags": [
        {
          "tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
          "tagText": "Team G"
        }
      ],
      "timeZoneTag": {
        "windowsName": "Eastern Standard Time"
      },
      "createdDateTimeUtc": "2017-03-15 03:48:24.822495",
      "emailAddress": "john.smith@gmail.com",
      "additionalOptIn": false,
      "isMarketingAllowed": true,
      "remoteIpAddress": "150.101.114.215",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3)     AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
      "referer": "http://google.com/",
      "enteredPostCode": "90210",
      "cableProvider": "DIRECTV",
      "cableProviderLocation": "New York",
      "countryCode": "US",
      "geoCountry": "United States",
      "deviceName": "Desktop",
      "utmSource": "Facebook",
      "utmMedium": "Display",
      "utmCampaign": "2017",
      "utmContent": "Mobile_320x50",
      "source": "youraccount.roktcalendar.com"
    }
  }
 }

イベントの詳細 - 購読

以下は、イベントの詳細 - 購読のオブジェクトの詳細です。

パラメーター	タイプ	説明
actionType（常に存在）	文字列	発生した購読解除イベントのタイプを表す値。サポートされる値：SubscriptionViaOneClickLink、SubscriptionViaSms、SubscriptionViaShowsPage、SubscriptionViaCalendarPage、SubscriptionViaWebApi、SubscriptionWithEventsViaWebApi、SubscriptionViaCalReplyNotificationPage
calendarSubscriptionId（常に存在）	UUID/GUID	ユニークなRoktカレンダーの購読を表す識別子。
accountId（常に存在）	UUID/GUID	ユニークなRoktカレンダーアカウントを表す識別子。
accountName（常に存在）	文字列	購読が所属するRoktカレンダーアカウントの名前。
accountCode（常に存在）	文字列	購読が所属するアカウントを一意に識別するURL安全なコード。
subscription（常に存在）	購読の詳細	作成された購読の詳細のオブジェクト。

退会について

退会時のWebhookイベントペイロード

Webhookイベントは、既存のサブスクリプションを無効にするために行われたAPI呼び出し時にトリガーされます。

以下は、Webhookイベントのペイロードの詳細です：

パラメータ	タイプ	説明
eventId（常に存在）	UUID/GUID	ユニークなイベントを表す識別子です。
eventType（常に存在）	文字列	発生したイベントのタイプを表します。 退会。
eventDetails（常に存在）	イベントの詳細 - 退会	送信される退会イベントの詳細については、以下を参照してください。

退会時のペイロード

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
  "eventType": "Unsubscribe",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscription": {
      "removedDateTimeUtc": "2020-05-06 01:18:49.755190",
      "unsubscribeReasonText": "The event has come to an end",
      "remoteIpAddress": "54.241.167.141",
      "countryCode": "US",
      "geoCountry": "United States",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36",
      "deviceName": "Desktop",
      "calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
      "calendarId": "f9ddd95e-676d-ea11-aa56-067315f8d3af",
      "calendarTitle": "Your calendar",
      "calendarCode": "your-calendar",
      "subscriptionMethod": "Google"
    }
  }
 }

イベントの詳細 - 解除

以下は、イベントの詳細 - 解除のオブジェクトの詳細です。

パラメータ	タイプ	説明
actionType (常に存在)	文字列	発生した解除イベントのタイプを表す値です。
calendarSubscriptionId (常に存在)	UUID/GUID	ユニークなRoktカレンダーのサブスクリプションを表す識別子です。
accountId (常に存在)	UUID/GUID	ユニークなRoktカレンダーアカウントを表す識別子です。
accountName (常に存在)	文字列	サブスクリプションが所属するRoktカレンダーアカウントの名前です。
accountCode (常に存在)	文字列	サブスクリプションが所属するアカウントを一意に識別するURL安全なコードです。
subscription (常に存在)	削除されたサブスクリプションオブジェクト	削除されたサブスクリプションのオブジェクトです。

サブスクリプションの詳細が更新された場合

サブスクリプションの詳細が更新された場合のWebhooksペイロード

このWebhookイベントは、サブスクリプションの設定に変更があった場合にトリガーされます。

以下はWebhookイベントのペイロードの詳細です:

パラメータ	タイプ	説明
eventId (常に存在)	UUID/GUID	ユニークなイベントを表す識別子です。
eventType (常に存在)	文字列	発生したイベントのタイプを表す値です。 SubscriptionDetailsUpdated
eventDetails (常に存在)	イベントの詳細 - サブスクリプションの詳細	サブスクリプションの詳細が更新されたイベントについての詳細情報は以下を参照してください。

サブスクリプションの詳細が更新された場合のペイロード

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
  "eventType": "SubscriptionDetailsUpdate",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscription": {
      "calendarSubscriptionId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
      "calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
      "calendarTitle": "My Sports Calendar",
      "calendarCode": "my-sports-calendar",
      "subscriptionMethod": "Google",
      "calendarTags": [
        {
          "tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
          "tagText": "Team G"
        }
      ],
      "timeZoneTag": {
        "windowsName": "Eastern Standard Time"
      },
      "createdDateTimeUtc": "2017-03-15 03:48:24.822495",
      "emailAddress": "john.smith@gmail.com",
      "additionalOptIn": false,
      "isMarketingAllowed": true,
      "remoteIpAddress": "150.101.114.215",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3)     AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
      "referer": "http://google.com/",
      "enteredPostCode": "90210",
      "cableProvider": "DIRECTV",
      "cableProviderLocation": "New York",
      "countryCode": "US",
      "geoCountry": "United States",
      "deviceName": "Desktop",
      "utmSource": "Facebook",
      "utmMedium": "Display",
      "utmCampaign": "2017",
      "utmContent": "Mobile_320x50",
      "source": "youraccount.roktcalendar.com"
    }
  }
 }

イベントの詳細 - サブスクリプションの詳細が更新されました

以下は、イベントの詳細 - サブスクリプションの詳細が更新されました のオブジェクトの詳細です。

パラメータ	タイプ	説明
actionType (常に存在)	文字列	発生したアンサブスクライブイベントのタイプを表す値です。
calendarSubscriptionId (常に存在)	UUID/GUID	ユニークなRoktカレンダーサブスクリプションを表す識別子です。
accountId (常に存在)	UUID/GUID	ユニークなRoktカレンダーアカウントを表す識別子です。
accountName (常に存在)	文字列	サブスクリプションが所属するRoktカレンダーアカウントの名前です。
accountCode (常に存在)	文字列	サブスクリプションが所属するアカウントを一意に識別するURL安全なコードです。
subscription (常に存在)	サブスクリプションの詳細	更新されたサブスクリプションの詳細を表す値です。

サブスクリプションイベントが追加された場合

サブスクリプションイベントが追加されたときのWebhooksペイロード

このWebhookイベントは、既存のサブスクリプションにサブスクライバーが新しいイベントを追加した場合にトリガーされます。

以下は、Webhookイベントのペイロードの詳細です:

パラメータ	タイプ	説明
eventId (常に存在)	UUID/GUID	ユニークなイベントを表す識別子です。
eventType (常に存在)	文字列	発生したイベントのタイプを表す値です。SubscriptionEventAdded
eventDetails (常に存在)	イベントの詳細 - サブスクリプションイベントが追加されました	送信されるSubscriptionEventAddedイベントに関する詳細情報については、以下を参照してください。

サブスクリプションイベントが追加された場合のペイロード

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
  "eventType": "SubscriptionEventAdded",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscription": {
      "calendarSubscriptionId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
      "calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
      "calendarTitle": "My Sports Calendar",
      "calendarCode": "my-sports-calendar",
      "subscriptionMethod": "Google",
    },
    "subscriptionEvent": {
      "title": "Coheed and Cambria CHON",
      "location": "The Bomb Factory 2713 Canton Street, Dallas, TX 75226",
      "description": "AEG presents Coheed and Cambria CHON live at the The Bomb Factory",
      "timezoneBclId": "Central Standard Time",
      "timezoneIanaId": "America/Chicago",
      "startDateTime": "2020-05-09 20:00:00.000000",
      "startDateTimeUtc": "2020-05-10 01:00:00.000000",
      "endDateTime": "2020-05-09 21:30:00.000000",
      "reminderMinutes": 2880,
      "createdDateTimeUtc": "2020-05-05 00:40:51.787000",
      "lastUpdatedDateTimeUtc": "2020-05-05 00:40:51.787000",
      "eventId": "391756"
    },
  }
 }

イベントの詳細 サブスクリプションイベントが追加されました

以下は、イベントの詳細 - サブスクリプションイベントが追加されましたのオブジェクトの詳細です:

パラメータ	タイプ	説明
actionType (常に存在)	文字列	発生したアンサブスクライブイベントのタイプを表す値です。
calendarSubscriptionId (常に存在)	UUID/GUID	ユニークなRoktカレンダーサブスクリプションを表す識別子です。
accountId (常に存在)	UUID/GUID	ユニークなRoktカレンダーアカウントを表す識別子です。
accountName (常に存在)	文字列	サブスクリプションが所属するRoktカレンダーアカウントの名前です。
accountCode (常に存在)	文字列	サブスクリプションが所属するアカウントを一意に識別するURL安全なコードです。
subscription (常に存在)	サブスクリプション基本	サブスクリプション基本のオブジェクトです。
subscriptionEvent (常に存在)	サブスクリプションイベントの詳細	サブスクリプションイベントの詳細のオブジェクトです。

サブスクリプションイベントが削除された場合

サブスクリプションイベント削除時のWebhooksペイロード

このWebhookイベントは、購読者がカレンダーからイベントを解除した場合にトリガーされます。

以下はWebhookイベントのペイロードの詳細です：

パラメータ	タイプ	説明
eventId (常に存在)	UUID/GUID	ユニークなイベントを表す識別子です。
eventType (常に存在)	文字列	発生したイベントのタイプを表す値です。SubscriptionEventRemoved
eventDetails (常に存在)	イベントの詳細 - サブスクリプションイベント削除	発生したイベントに関する詳細情報です。SubscriptionEventRemovedイベントに送信される内容については、以下を参照してください。

サブスクリプションイベント削除のペイロード

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
  "eventType": "SubscriptionEventRemoved",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscription": {
      "calendarSubscriptionId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
      "calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
      "calendarTitle": "My Sports Calendar",
      "calendarCode": "my-sports-calendar",
      "subscriptionMethod": "Google",
    },
    "subscriptionEvent": {
      "eventId": "391756"
    },
  }
 }

イベントの詳細 - サブスクリプションイベントが削除されました

以下は、イベントの詳細 - サブスクリプションイベントが削除されました のオブジェクトの詳細です：

パラメータ	タイプ	説明
actionType (常に存在)	文字列	発生したサブスクリプションイベントの更新タイプを表す値です。
calendarSubscriptionId (常に存在)	UUID/GUID	ユニークなRoktカレンダーサブスクリプションを表す識別子です。
accountId (常に存在)	UUID/GUID	ユニークなRoktカレンダーアカウントを表す識別子です。
accountName (常に存在)	文字列	サブスクリプションが所属するRoktカレンダーアカウントの名前です。
accountCode (常に存在)	文字列	サブスクリプションが所属するアカウントを一意に識別するURL安全なコードです。
subscription (常に存在)	サブスクリプション基本	サブスクリプションの基本オブジェクトを表す値です。
subscriptionEvent (常に存在)	サブスクリプションイベント基本	サブスクリプションイベントの基本オブジェクトを表す値です。

サブスクリプションイベントの更新時

サブスクリプションイベントの更新時のWebhooksペイロード

このWebhookイベントは、サブスクリプションイベントのエンドポイントへのAPI呼び出し時にトリガーされます。

以下は、Webhookイベントのペイロードの詳細です：

パラメーター	タイプ	説明
eventId (常に存在)	UUID/GUID	ユニークなイベントを表す識別子です。
eventType (常に存在)	文字列	発生したイベントのタイプを表す値です。SubscriptionEventUpdated
eventDetails (常に存在)	イベントの詳細 - サブスクリプションイベントの更新	発生したイベントに関する詳細情報です。SubscriptionEventUpdatedイベントに送信される内容については、以下を参照してください。

サブスクリプションイベントの更新時のペイロード

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
  "eventType": "SubscriptionEventUpdated",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscriptionEvent": {
      "title": "Coheed and Cambria CHON",
      "location": "The Bomb Factory 2713 Canton Street, Dallas, TX 75226",
      "description": "AEG presents Coheed and Cambria CHON live at the The Bomb Factory",
      "timezoneBclId": "Central Standard Time",
      "timezoneIanaId": "America/Chicago",
      "startDateTime": "2020-05-09 20:00:00.000000",
      "startDateTimeUtc": "2020-05-10 01:00:00.000000",
      "endDateTime": "2020-05-09 21:30:00.000000",
      "reminderMinutes": 2880,
      "createdDateTimeUtc": "2020-05-05 00:40:51.787000",
      "lastUpdatedDateTimeUtc": "2020-05-05 00:40:51.787000",
      "eventId": "391756"
    },
  }
 }

イベントの詳細 - サブスクリプションイベントが更新されました

以下は、イベントの詳細 - サブスクリプションイベントが更新されました のオブジェクトの詳細です：

パラメーター	タイプ	説明
actionType（常に存在）	文字列	発生した購読解除イベントのタイプを表す値です。
calendarSubscriptionId（常に存在）	UUID/GUID	ユニークなRoktカレンダーサブスクリプションを表す識別子です。
accountId（常に存在）	UUID/GUID	ユニークなRoktカレンダーアカウントを表す識別子です。
accountName（常に存在）	文字列	サブスクリプションが所属するRoktカレンダーアカウントの名前です。
AccountCode（常に存在）	文字列	サブスクリプションが所属するアカウントを一意に識別するURL安全なコードです。
subscriptionEvent（常に存在）	サブスクリプションイベントの詳細	サブスクリプションイベントの詳細オブジェクトです。

サブスクリプションイベントが削除された場合

サブスクリプションイベントの更新時のWebhookペイロード

このWebhookイベントは、Delete Subscription Eventエンドポイントに対して行われたAPI呼び出し時にトリガーされます。

以下は、Webhookイベントのペイロードの詳細です：

パラメーター	タイプ	説明
eventId (常に存在)	UUID/GUID	一意のイベントを表す識別子
eventType (常に存在)	文字列	発生したイベントのタイプを表す値。SubscriptionEventDeleted
eventDetails (常に存在)	イベントの詳細 - サブスクリプションイベントが削除されました	発生したイベントに関する詳細情報。SubscriptionEventDeletedイベントに送信される内容については、以下を参照してください。

サブスクリプションイベントの更新ペイロード

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
  "eventType": "SubscriptionEventRemoved",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscriptionEvent": {
      "eventId": "391756"
    },
  }
 }

イベントの詳細 - サブスクリプションイベントが削除されました

以下は、イベントの詳細 - サブスクリプションイベントが削除されました のオブジェクトの詳細です：

パラメータ	タイプ	説明
actionType（常に存在）	文字列	発生したサブスクリプションイベントの更新タイプを表す値です。
calendarSubscriptionId（常に存在）	UUID/GUID	ユニークなRoktカレンダーサブスクリプションを表す識別子です。
accountId（常に存在）	UUID/GUID	ユニークなRoktカレンダーアカウントを表す識別子です。
accountName（常に存在）	文字列	サブスクリプションが所属するRoktカレンダーアカウントの名前です。
accountCode（常に存在）	文字列	サブスクリプションが所属するアカウントを一意に識別するURLセーフコードです。
subscriptionEvent（常に存在）	サブスクリプションイベントの基本オブジェクト	基本的なサブスクリプションイベントのオブジェクトです。

共有オブジェクト

サブスクリプション基本情報

基本情報を持つサブスクリプションオブジェクトです。以下は、サブスクリプション基本オブジェクトの詳細です。

パラメータ	タイプ	説明
calendarSubscriptionId (常に存在)	UUID/GUID	カレンダーにサブスクライブしている一意のユーザーを表す識別子です。
calendarId (常に存在)	UUID/GUID	サブスクリプションが対象としているカレンダーを表す識別子です。
calendarTitle (常に存在)	文字列	ユーザーがサブスクライブしているカレンダーの名前です。
calendarCode (常に存在)	文字列	ユーザーがサブスクライブしているカレンダーを一意に識別するURL安全なコードです。
subscriptionMethod (時々存在)	文字列	作成されたサブスクリプションのタイプを表す値です。現在サポートされている値: Webcal、Google、Microsoft

サブスクリプション基本オブジェクト

{
      "calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
      "calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
      "calendarTitle": "My Sports Calendar",
      "calendarCode": "my-sports-calendar",
      "subscriptionMethod": "Google",
}

サブスクリプションの詳細

詳細な情報を持つサブスクリプションオブジェクトです。以下はサブスクリプションの詳細オブジェクトの詳細です。

パラメータ	タイプ	説明
calendarSubscriptionId (常に存在)	UUID/GUID	カレンダーにサブスクライブした一意のユーザーを表す識別子です。
calendarId (常に存在)	UUID/GUID	サブスクリプションが対象としたカレンダーを表す識別子です。
calendarTitle (常に存在)	文字列	ユーザーがサブスクライブしたカレンダーの名前です。
calendarCode (常に存在)	文字列	ユーザーがサブスクライブしたカレンダーを一意に識別するURL安全なコードです。
subscriptionMethod (時々存在)	文字列	作成されたサブスクリプションのタイプを表す値です。現在サポートされている値: Webcal、Google、Microsoft
calendarTags (時々存在)	CalendarTags[]	イベントをフィルタリングするためのカレンダータグの配列です。タグは類似したイベントをグループ化するために使用されます。たとえば、同じスポーツチームに属するすべてのイベントにはチーム名のタグが付けられます。タグIDが使用される場合、サブスクリプションには選択したタグでタグ付けされたイベントのみが含まれます。
timeZoneTag (時々存在)	TimeZoneTag	イベントをフィルタリングするためのタイムゾーンです。使用される場合、サブスクリプションにはこのタイムゾーンでタグ付けされたイベントとタイムゾーンがタグ付けされていないイベントが含まれます。
subscriberExternalId (時々存在)	文字列	アカウントのサブスクライバーを表す識別子です。第三者のシステムから受け取ったものです。例: メールアドレス、デバイスID、匿名ID。
emailAddress (時々存在)	文字列	サブスクリプションにリンクされたメールアドレス。Rokt Calendarでは、後日サブスクライバーにマーケティングを行うために、サブスクライバーのメールアドレスを取得することができます。
additionalOptIn (オプション)	ブール値	追加のオプトインは、サブスクライバーがチェックボックスに関連付けられたコピーで定義された質問/ステートメントにオプトインするかどうかを指定することができます。
isMarketingAllowed (時々存在)	ブール値	マーケティングのオプトインは、サブスクライバーが自分のメールアドレスがマーケティング目的で使用されることに許可を与えるかどうかを指定することができます。
enteredPostCode (時々存在)	文字列	チャンネルIDを利用するカレンダーのためのオプションのフィールドです。これは米国の郵便番号またはカナダの郵便番号です。
cableProvider (時々存在)	文字列	サブスクリプションプロセス中にエンドユーザーが選択したテレビプロバイダーの名前です。指定された郵便番号で利用可能なプロバイダに基づいています。
cableProviderLocation (時々存在)	文字列	サブスクリプションプロセス中にエンドユーザーが選択したテレビプロバイダーの場所です。
remoteIpAddress (時々存在)	文字列	ユーザーのIPアドレス。監視およびログ記録の目的で使用されます。
userAgent (常に存在)	文字列	ユーザーのユーザーエージェント。これはWebCalまたはGoogleのサブスクリプションであるかどうかを判断するために必要です。APIリクエストのHTTPヘッダから抽出されたユーザーエージェント文字列です。これはユーザーのオペレーティングシステム、デバイス、およびその他の重要なパラメータを識別するために使用されます。
referrer (時々存在)	文字列	ユーザーのURLリファラー。Dashboard Analyticsに使用されます。サブスクライバーがカレンダーページに移動した場所、例えばFacebookなどです。
countryCode (時々存在)	文字列	サブスクリプションが開始された国を示す国コードです。形式: ISO Alpha-2。
geoCountry (時々存在)	文字列	サブスクリプションが開始された国を示します。
source (時々存在)	文字列	ドメインレベルでグループ化されたサブスクリプションリファラーの総合ビューです。
deviceName (常に存在)	文字列	サブスクリプションが開始されたデバイスのタイプです。
utmSource (時々存在)	文字列	リファラーサブスクライバーソースを識別するために使用される値です。これはDashboard AnalyticsでのUTMソースとして使用されます。例: Newsletter-December。
utmMedium (時々存在)	文字列	リファラーサブスクライバーメディアを識別するために使用される値です。これはDashboard AnalyticsでのUTMソースとして使用されます。例: Email。
utmCampaign (時々存在)	文字列	リファラーサブスクライバーキャンペーンを識別するために使用される値です。Dashboard Analyticsで使用されます。例: Summer Campaign。
utmContent (時々存在)	文字列	リファラーサブスクライバーコンテンツを識別するために使用される値です。Dashboard Analyticsで使用されます。例: 400x300 banner。
createdDateTimeUtc (常に存在)	日時	サブスクリプションが作成されたUTCの日時です。
confirmationDateTimeUtc (常に存在)	日時	サブスクリプションが確認されたUTCの日時です。

サブスクリプションの詳細オブジェクト

{
      "calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
      "calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
      "calendarTitle": "My Sports Calendar",
      "calendarCode": "my-sports-calendar",
      "subscriptionMethod": "Google",
      "calendarTags": [
            {
                  "tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
                  "tagText": "Team G"
            }
      ],
      "timeZoneTag": {
            "windowsName": "Eastern Standard Time"
      },
      "createdDateTimeUtc": "2017-03-15 03:48:24.822495",
      "emailAddress": "john.smith@gmail.com",
      "additionalOptIn": false,
      "isMarketingAllowed": true,
      "remoteIpAddress": "150.101.114.215",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3)     AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
      "Referer": "http://google.com/",
      "enteredPostCode": "90210",
      "cableProvider": "DIRECTV",
      "cableProviderLocation": "New York",
      "countryCode": "US",
      "geoCountry": "United States",
      "deviceName": "Desktop",
      "utmSource": "Facebook",
      "utmMedium": "Display",
      "utmCampaign": "2017",
      "utmContent": "Mobile_320x50",
      "source": "youraccount.roktcalendar.com"
}

サブスクリプションが削除されました

基本情報と無効化情報を持つサブスクリプションオブジェクトです。以下に、サブスクリプションが削除されたオブジェクトの詳細を示します。

パラメータ	タイプ	説明
calendarSubscriptionId (常に存在)	UUID/GUID	カレンダーにサブスクライブした一意のユーザーを表す識別子です。
calendarId (常に存在)	UUID/GUID	サブスクリプションが対象となるカレンダーを表す識別子です。
calendarTitle (常に存在)	文字列	ユーザーがサブスクライブしたカレンダーの名前です。
calendarCode (常に存在)	文字列	ユーザーがサブスクライブしたカレンダーを一意に識別するURL安全なコードです。
subscriptionMethod (時々存在)	文字列	作成されたサブスクリプションのタイプを表す値です。現在サポートされている値: Webcal、Google、Microsoft
remoteIpAddress (時々存在)	文字列	ユーザーのIPアドレスです。監視およびログ記録の目的で使用されます。
userAgent (常に存在)	文字列	ユーザーのユーザーエージェントです。これは、WebCalまたはGoogleのサブスクリプションであるかどうかを判断するために必要です。APIリクエストのHTTPヘッダから抽出されたユーザーエージェント文字列です。これは、ユーザーのオペレーティングシステム、デバイス、およびその他の重要なパラメータを識別するために使用されます。
countryCode (時々存在)	文字列	サブスクリプションが開始された国を示す国コードです。形式: ISO Alpha-2。
geoCountry (時々存在)	文字列	サブスクリプションが開始された国を示します。
deviceName (常に存在)	文字列	サブスクリプションが開始されたデバイスの種類です。
removedDateTimeUtc (常に存在)	日時	サブスクリプションが解除された日時（UTC）です。
unsubscribeReasonText (時々存在)	文字列	解除の理由を表すテキストです。

サブスクリプションの削除オブジェクト

{
      "removedDateTimeUtc": "2020-05-06 01:18:49.755190",
      "unsubscribeReasonText": "イベントが終了しました",
      "remoteIpAddress": "54.241.167.141",
      "countryCode": "US",
      "geoCountry": "アメリカ合衆国",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36",
      "deviceName": "デスクトップ",
      "calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
      "calendarId": "f9ddd95e-676d-ea11-aa56-067315f8d3af",
      "calendarTitle": "ドメイン",
      "calendarCode": "ドメイン",
      "subscriptionMethod": "Microsoft"
    }

サブスクリプションイベントの基本情報

Idのみを持つサブスクリプションイベントオブジェクトです。以下は、サブスクリプションイベントの基本オブジェクトの詳細です。

パラメータ	タイプ	説明
eventId (常に存在)	文字列	外部プロバイダからの一意のイベントを表す識別子です。

サブスクリプションイベントの基本オブジェクト

{
  "eventId": "391756"
}

サブスクリプションイベントの詳細

詳細を持つサブスクリプションイベントオブジェクトです。以下は、サブスクリプションイベントの詳細オブジェクトの詳細です。

パラメータ	タイプ	説明
eventId (常に存在)	文字列	外部プロバイダからの一意のイベントを表す識別子です。
title (常に存在)	文字列	イベントのタイトルを表すテキストです。
description (常に存在)	文字列	イベントの説明を表すテキストです。
location (常に存在)	文字列	イベントの場所を表すテキストです。
reminderMinutes (時々存在)	整数	イベント開始時刻の前にリマインダープロンプトが表示される分数を表します。値が存在しない場合、リマインダープロンプトは表示されません。
timezoneBclId (常に存在)	文字列	Windowsのタイムゾーン名に一致する値です。
timezoneIanaId (常に存在)	文字列	IANAのタイムゾーン名に一致する値です。
StartDateTimeUtc (常に存在)	日時	イベントの開始日時（UTC）です。
startDateTime (常に存在)	日時	イベントの開始日時（ローカルタイムゾーン）です。
endDateTime (常に存在)	日時	イベントの終了日時（ローカルタイムゾーン）です。
createdDateTimeUtc (常に存在)	日時	イベントが作成された日時（UTC）です。
lastUpdateDateTimeUtc (時々存在)	日時	イベントが最後に更新された日時（UTC）です。

サブスクリプションイベントの詳細オブジェクト

{
  "title": "Coheed and Cambria CHON",
  "location": "The Bomb Factory 2713 Canton Street, Dallas, TX 75226",
  "description": "AEG presents Coheed and Cambria CHON live at the The Bomb Factory",
  "timezoneBclId": "Central Standard Time",
  "timezoneIanaId": "America/Chicago",
  "startDateTime": "2020-05-09 20:00:00.000000",
  "startDateTimeUtc": "2020-05-10 01:00:00.000000",
  "endDateTime": "2020-05-09 21:30:00.000000",
  "reminderMinutes": 2880,
  "createdDateTimeUtc": "2020-05-05 00:40:51.787000",
  "lastUpdatedDateTimeUtc": "2020-05-05 00:40:51.787000",
  "eventId": "391756"
}

カレンダータグ

以下は、カレンダータグオブジェクトの詳細です。

パラメーター	タイプ	説明
tagId (常に存在)	UUID/GUID	カレンダーのために作成された一意のタグを表す識別子です。
tagText (常に存在)	文字列	タグを表すテキストです。タグが作成されると、カスタムテキストが与えられます。カスタムテキストが変更された場合、ウェブフックのペイロードに更新されたテキストが反映されるまで30分待ってください。

カレンダータグオブジェクト

{
  "tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
  "tagText": "TeamG"
}

タイムゾーンタグ

以下は、タイムゾーンタグオブジェクトの詳細です。

パラメータ	タイプ	説明
windowsName (常に存在)	文字列	値はWindowsのタイムゾーン名に一致します。

タイムゾーンタグオブジェクト

{
  "windowsName": "Eastern Standard Time"
}