HubSpot

HubSpotのレコードを作成、取得、更新をするアクション一覧です。

HubSpotSearchRecords

概要

HubSpotを検索してレコードを取得します。

パラメーター

*は、必須パラメーター

名前	型	概要	例
providerId*	文字列	プロバイダーID	hs_1234
objectType*	文字列	取得したいオブジェクトタイプを指定します。	companies
filters*	配列	レコードを検索するときのフィルターをJSONの配列で入力します。詳細はHubSpotの公式ドキュメントを参考にしてください。サンプルはこちら。	[{ "value": "東京", "propertyName": "address", "operator": "EQ" }]
properties	配列	追加で取得したいプロパティを指定します。指定しない場合は、オブジェクトタイプごとに定めたデフォルトプロパティのみを取得します。	['name']
query	文字列	テキスト検索時に利用する文字列。検索対象はオブジェクトに存在するすべてのプロパティ。	gmail
sortKey	文字列	指定したプロパティでレコードを並び替えます。	createdate
order	文字列	昇順（ASCENDING）、降順（DESCENDING）を指定します。デフォルトは昇順です。	ASCENDING
limit	数値	レコードを取得したい数を指定します。全てを取得したい場合は0を指定します。	100

アウトプット

タイプ	型	概要	例
List	配列	取得したレコードオブジェクトの配列	※使用例のアウトプット参照

使用例

+hub_spot_search_records_1:
  action>: HubSpotSearchRecords
  providerId: 'hs_provider_id'
  objectType: companies
  filters: [{ "value": "Tokyo", "propertyName": "name", "operator": "CONTAINS_TOKEN" }]
  properties: [ "name", "state"]
  sortKey: createdate
  order: DESCENDING
  limit: 10

[
  {
    "id": "7663561080",
    "providerId": "hs_provider_id",
    "objectType": "companies",
    "properties": {
      "createdate": "2022-01-13T05:42:21.774Z",
      "hs_lastmodifieddate": "2022-01-13T05:42:28.228Z",
      "hs_object_id": "7663561080",
      "state": "TOKYO",
      "name": "オートロ株式会社"
    },
    "createdAt": "2022-01-13T05:42:21.774Z",
    "updatedAt": "2022-01-13T05:42:28.228Z",
    "archived": false
  },
  {
    "id": "7663561082",
    "providerId": "hs_provider_id",
    "objectType": "companies",
    "properties": {
      "createdate": "2022-01-13T05:42:21.914Z",
      "hs_lastmodifieddate": "2022-01-13T05:42:26.588Z",
      "hs_object_id": "7663561082",
      "state": "Tokyo",
      "name": "株式会社Example"
    },
    "createdAt": "2022-01-13T05:42:21.914Z",
    "updatedAt": "2022-01-13T05:42:26.588Z",
    "archived": false
  }
]

HubSpotUpdateRecord

概要

HubSpotUpdateRecordはHubSpotのレコードを更新するアクションです。

パラメーター

*は、必須パラメーター

名前	型	概要	例
record*	オブジェクト	HubSpotのレコードオブジェクト。HubSpotSearchRecordsやHubSpotCreateRecordアクションで取得したレコードオブジェクトをセットしてください。	{ "id": "7706230675", "providerId": "hs_1234", "objectType": "companies" }
properties*	オブジェクト	更新するプロパティ名と値	{ "name": "新しい名前"}

アウトプット

タイプ	型	概要	例
JSON	オブジェクト	更新したレコードオブジェクト	※使用例のアウトプット参照

使用例

+hub_spot_update_record_1:
  action>: HubSpotUpdateRecord
  record: { "id": "7706230675", "providerId": "hs_1234", "objectType": "companies" }
  properties: { "name": "新しい名前", "address": "Tokyo" }

{
  "id": "7706230675",
  "properties": {
    "createdate": "2022-01-20T01:32:31.552Z",
    "hs_created_by_user_id": "28084919",
    "hs_lastmodifieddate": "2022-01-23T13:49:34.393Z",
    "hs_object_id": "7706230675",
    "hs_updated_by_user_id": "28084919",
    "name": "新しい名前"
  },
  "createdAt": "2022-01-20T01:32:31.552Z",
  "updatedAt": "2022-01-23T13:49:34.393Z",
  "archived": false,
  "providerId": "hs_1234",
  "objectType": "companies"
}

HubSpotCreateRecord

概要

HubSpotUpdateRecordはHubSpotのレコードを作成するアクションです。

パラメーター

*は、必須パラメーター

名前	型	概要	例
providerId*	文字列	プロバイダーID	hs_1234
objectType*	文字列	作成したいオブジェクトタイプを指定します。	companies
properties*	オブジェクト	作成するレコードのプロパティ名と値	{ "name": "新しい名前"}

アウトプット

タイプ	型	概要	例
JSON	オブジェクト	作成したレコードオブジェクト	※使用例のアウトプット参照

使用例

yaml

+hub_spot_create_record_1:
  action>: HubSpotCreateRecord
  providerId: hs_1234
  objectType: companies
  properties:
    name: '株式会社OOO'
    state: '東京'

アウトプット

{
  "id": "7706230675",
  "properties": {
    "createdate": "2022-01-20T01:32:31.552Z",
    "hs_created_by_user_id": "28084919",
    "hs_lastmodifieddate": "2022-01-23T13:49:34.393Z",
    "hs_object_id": "7706230675",
    "hs_updated_by_user_id": "28084919",
    "name": "株式会社OOO"
  },
  "createdAt": "2022-01-20T01:32:31.552Z",
  "updatedAt": "2022-01-23T13:49:34.393Z",
  "archived": false,
  "providerId": "hs_1234",
  "objectType": "companies"
}

　HubSpotに関する説明

オブジェクトタイプ

AUTOROでオブジェクトタイプを指定するときは、HubSpotオブジェクトの内部名をアクションのパラメーターにセットします。

HubSpotオブジェクト	内部名
会社	companies
コンタクト	contacts
取引	deals
商品項目	line-items
製品	products
チケット	tickets
見積もり	quotes

フィルターのサンプル

住所が東京のレコードを取得する

[
  {
    "value": "東京",
    "propertyName": "address",
    "operator": "EQ"
  }
]

従業員数が100人以上かつ住所が東京のレコードを取得する

[
  {
    "value": "東京",
    "propertyName": "address",
    "operator": "EQ"
  },
  {
    "value": 100,
    "propertyName": "numberofemployees",
    "operator": "GT"
  }
]

ある取引(ID:1234)に紐づいたレコードを取得する

[
  {
    "value": "1234",
    "propertyName": "associations.deal",
    "operator": "EQ"
  }
]

デフォルトプロパティ

HubSpotオブジェクト	デフォルトプロパティ
会社	会社名(name), 会社のドメイン名(domain), 作成日(createdate), 前回の変更日(hs_lastmodifieddate), 会社ID(hs_object_id)
コンタクト	名(firstname), 姓(lastname), Eメール(email), 前回の変更日(lastmodifieddate), コンタクトID(hs_object_id), 作成日(createdate)
取引	取引名(dealname), 金額(amount), クローズ日(closedate), パイプライン(pipeline), 取引ステージ(dealstage), 作成日(createdate), 前回の変更日(hs_lastmodifieddate), 取引ID(hs_object_id)
製品	製品名(name), 製品の説明(description), 価格(price), 作成日(createdate), 前回の変更日(hs_lastmodifieddate), 製品ID(hs_object_id)
チケット	チケットの説明(content), パイプライン(hs_pipeline), チケットのステータス(hs_pipeline_stage), カテゴリー(hs_ticket_category), 優先度(hs_ticket_priority), チケット名(subject), 作成日(createdate), 前回の変更日(hs_lastmodifieddate), チケットID(hs_object_id)
商品項目	量(quantity), 金額(amount), 価格(price), 作成日(createdate), hs_lastmodifieddate, hs_object_id
見積もり	期日(hs_expiration_date), 公開URLキー(hs_public_url_key), ステータス(hs_status), タイトル(hs_title), 作成日(hs_createdate),前回の変更日(hs_lastmodifieddate), 見積もりID(hs_object_id)
カスタムオブジェクト	作成日(hs_createdate), 前回の変更日(hs_lastmodifieddate), カスタムオブジェクトID(hs_object_id)

プロパティについて

AUTOROでレコードのプロパティを指定する時はプロパティの内部名を利用します。

以下の手順によってオブジェクトのプロパティ名の内部名を取得できます。

HubSpot

HubSpot

HubSpotSearchRecords

概要

パラメーター

アウトプット

使用例

HubSpotUpdateRecord

概要

パラメーター

アウトプット

使用例

HubSpotCreateRecord

概要

パラメーター

アウトプット

使用例

yaml

アウトプット

HubSpotに関する説明

オブジェクトタイプ

フィルターのサンプル

デフォルトプロパティ

プロパティについて

results matching ""

No results matching ""