カスタムイベントの定義

​

イベント定義を作成する

{
  "label": "My event label",
  "name": "unique_event_name",
  "description": "An event description that helps users understand what the event tracks.",
  "primaryObject": "COMPANY",
  "propertyDefinitions": [
    {
      "name": "choice-property",
      "label": "Choice property",
      "type": "enumeration",
      "options": [
        {
          "label": "Option 1",
          "value": "1"
        },
        {
          "label": "Option 2",
          "value": "2"
        }
      ]
    },
    {
      "name": "string-property",
      "label": "String property",
      "type": "string"
    }
  ],
  "includeDefaultProperties": true
}

{
  "label": "My event label",
  "name": "unique_event_name",
  "description": "An event description that helps users understand what the event tracks.",
  "primaryObject": "COMPANY",
  "propertyDefinitions": [
    {
      "name": "string-property",
      "label": "String property",
      "type": "string"
    }
  ],
  "customMatchingId": {
    "primaryObjectRule": {
      "targetObjectPropertyName": "unique_object_property",
      "eventPropertyName": "event_property"
    }
  }
}

​

イベントプロパティー

• bool：ブール値を受け取るプロパティー。値はtrueまたはfalseとして表す必要があります。
• date：特定の年月日を表す日付を受け取るプロパティー。値はUTC時間で表す必要があります。値の形式として、ISO 8601文字列またはミリ秒単位のエポック時間タイムスタンプ（UTC深夜0時）を使用できます。
• datetime：タイムスタンプを表すエポックミリ秒またはISO8601の値を受け取るプロパティー。
• enumeration：定義済みのオプションを使用するプロパティー。このタイプのプロパティーを作成する際は、使用可能な値を設定するためにoptions配列を含めます。
• number：小数第1位までの数値を受け取るプロパティー。
• string：プレーンテキスト文字列を受け取るプロパティー。プロパティー名にurl、referrer、またはlinkという単語が含まれる場合、プロパティー値は最大1,024文字にすることができます。それ以外の場合、プロパティー値は最大256文字に制限されます。

​

HubSpotのデフォルトのイベントプロパティー

• hs_asset_description
• hs_asset_type
• hs_browser
• hs_campaign_id
• hs_city
• hs_country
• hs_device_name
• hs_device_type
• hs_element_class
• hs_element_id
• hs_element_text
• hs_language
• hs_link_href
• hs_operating_system
• hs_operating_version
• hs_page_content_type
• hs_page_id
• hs_page_title
• hs_page_url
• hs_parent_module_id
• hs_referrer
• hs_region
• hs_screen_height
• hs_screen_width
• hs_touchpoint_source
• hs_tracking_name
• hs_user_agent
• hs_utm_campaign
• hs_utm_content
• hs_utm_medium
• hs_utm_source
• hs_utm_term

​

新しいプロパティーを定義する

{
  "name": "property-name",
  "label": "Property name",
  "type": "enumeration",
  "options": [
    {
      "label": "label",
      "value": "value"
    }
  ]
}

• プロパティーを作成した後に、プロパティーの名前を変更することはできません。
• 名前に使用できるのは、小文字の英字、数字、アンダースコア、ハイフンのみです。
• プロパティー名の最初の文字は英字でなければなりません。
• プロパティーの名前とラベルは、それぞれ最大50文字に制限されています。
• プロパティー名が指定されていない場合、プロパティーのラベルを使用してプロパティー名が自動生成されます。
• HubSpotのUIの特定の部分では、文字数の多いラベルが切り詰められる場合があります。

​

既存のカスタムプロパティーを更新する

​

プロパティーを削除する

​

イベントを更新する

{
  "label": "Event label",
  "description": "A description of the event"
}

​

イベントを削除する

​

既存のイベント定義を取得する

• searchString：指定した文字列がnameフィールドに含まれているイベントを検索します。あいまい検索ではなく、単純に「含まれているかどうか」で検索されます。
• after：ページ処理されたレスポンスに表示される、検索結果の次のページを表示するためのハッシュ化された文字列。
• limit：取得する結果の最大数。
• includeProperties：返される結果にイベントプロパティーを含めるかどうかを指定するブール値。