HubSpotの会社データを取得する

HubSpotから会社データを取得する方法について

このレシピについて

このレシピは、CRM API | 会社 を参考に記述されています。

HubSpotの「会社データ」とは

HubSpot に登録された、自社とやり取りする組織に関する情報です。 （参考：CRM API | 会社）

HubSpot の CRM API を利用することで、HubSpot に登録された会社データの一覧を取得できます。

HubSpotの「会社データ」の構造

{
  "paging": {
    "next": {
      "link": "?after=NTI1Cg%3D%3D",
      "after": "NTI1Cg%3D%3D"
    }
  },
  "results": [
    {
      "associations": {
        "additionalProp1": {
          "paging": {
            "next": null,
            "prev": {
              "before": "string",
              "link": "string"
            }
          },
          "results": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "additionalProp2": {
          "paging": {
            "next": null,
            "prev": {
              "before": "string",
              "link": "string"
            }
          },
          "results": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        },
        "additionalProp3": {
          "paging": {
            "next": null,
            "prev": {
              "before": "string",
              "link": "string"
            }
          },
          "results": [
            {
              "id": "string",
              "type": "string"
            }
          ]
        }
      },
      "createdAt": "2024-04-15T01:19:55.574Z",
      "archived": true,
      "archivedAt": "2024-04-15T01:19:55.574Z",
      "propertiesWithHistory": {
        "additionalProp1": [
          {
            "sourceId": "string",
            "sourceType": "string",
            "sourceLabel": "string",
            "updatedByUserId": 0,
            "value": "string",
            "timestamp": "2024-04-15T01:19:55.574Z"
          }
        ],
        "additionalProp2": [
          {
            "sourceId": "string",
            "sourceType": "string",
            "sourceLabel": "string",
            "updatedByUserId": 0,
            "value": "string",
            "timestamp": "2024-04-15T01:19:55.574Z"
          }
        ],
        "additionalProp3": [
          {
            "sourceId": "string",
            "sourceType": "string",
            "sourceLabel": "string",
            "updatedByUserId": 0,
            "value": "string",
            "timestamp": "2024-04-15T01:19:55.574Z"
          }
        ]
      },
      "id": "string",
      "properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "updatedAt": "2024-04-15T01:19:55.574Z"
    }
  ]
}

Anyflow Embedで取得する

Anyflow Embed で HubSpot の会社データを取得する手順を紹介します。

HubSpot の会社データをスプレッドシートに一括追加するというシンプルなソリューションを作成し、会社に含まれるデータを把握します。

1.Clickトリガーを設定する

Clickトリガーを設定します。

2.HubSpot コネクタを設定する

HubSpot コネクタを追加します。

3.HubSpot のカスタムアクションを設定する

ソリューションエディタに戻り、freee人事労務コネクタを以下の通りに設定します。

設定項目名	設定値
カスタムアクション名	会社データを取得する
HTTPメソッド	GET
リクエストパス	/crm/v3/objects/companies
リクエストヘッダー	※ 設定不要
リクエストタイプ	※ 設定不要
レスポンスヘッダー定義	※ 設定不要
レスポンスタイプ	json

また、「レスポンスボディ定義」には「JSONを追加」で以下を設定します。

{
  "results": [
    {
      "id": "string",
      "properties": {
        "name": "string",
        "domain": "string"
      },
      "createdAt": "2024-04-15T00:14:10.990Z",
      "updatedAt": "2024-04-15T00:14:10.990Z"
    }
  ]
}

「element」の名前は「company」に変更しておきます。

以下が設定後のイメージです。

4.スプレッドシートの列名を設定する

スプレッドシートコネクタを追加し、以下の通りに設定を行います。

設定項目名	設定値
アクション	1行追加
スプレッドシートID	任意のスプレッドシートID
シートID	任意のシートID

「ヘッダーの列名」は以下の通りに設定します。

id
name
domain
createdAt
updatedAt

「行データ」にも同じ様に設定します。

5.スプレッドシートに一括追記する

スプレッドシートコネクタを追加し、以下の通りに設定を行います。

設定項目名	設定値
アクション	行を一括追加
スプレッドシートID	任意のスプレッドシートID
シートID	任意のシートID

「ヘッダーの列名」は以下の通りに設定します。

id
name
domain
createdAt
updatedAt

「リストソース」は以下の通りに設定します。

「要素フィールド」は以下の通りに設定します。（「i番目のcompany」から項目を選択します。）

6.ウィザードを設定する

必要な認証をウィザードに追加します。

7.テストを行う

テストを行うと、スプレッドシートにデータが追加されていることがわかります。