サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Content HubContent HubEnterprise
最終更新日: 2025年8月28日
注:開発者プロジェクトの一部としてサーバーレス関数を作成する場合は、開発者プロジェクトのサーバーレス関数のドキュメントを参照してください。以下のドキュメントは、開発者プロジェクトプラットフォーム以外でサーバーレス関数を作成する場合に使用します。
この記事では、サーバーレスの.functionsフォルダー内にあるファイルと、サーバーレス関数で使用できるCLIコマンドについて説明します。 サーバーレス関数の概要については、サーバーレス関数の概要をご確認ください。 JavaScriptのレンダリングされたモジュールとパーシャルのプロジェクトを使用してサーバーレス関数を作成する方法の詳細については、開発者プロジェクトのドキュメントをご覧ください。

serverless.json

.functionsフォルダーserverless.jsonファイルには、サーバーレス関数構成が保存されます。これは必須ファイルであり、これによって関数がエンドポイントにマッピングされます。
// serverless.json
{
  "runtime": "nodejs18.x",
  "version": "1.0",
  "environment": {
    "globalConfigKey": "some-value"
  },
  "secrets": ["secretName"],
  "endpoints": {
    "events": {
      "file": "function1.js",
      "method": "GET"
    },
    "events/update": {
      "method": "POST",
      "file": "action2.js",
      "environment": {
        "CONFIG_KEY": "some-other-value"
      },
      "secrets": ["googleKeyName", "otherkeyname"]
    }
  }
}
キーTypeDescription
runtime文字列ランタイム環境。次のNode.jsバージョンをサポートします。
  • ノード20(nodejs20.x)(推奨)
  • ノード18(nodejs18.x
2024年7月12日以降、HubSpotはノード16をサポートしなくなります
version文字列HubSpotサーバーレス関数スキーマバージョン。(現在のバージョン1.0)
environmentオブジェクト実行環境で、実行される関数に環境変数として渡される設定用変数。環境変数に基づいて、実際のAPIの代わりにテストバージョンを使用するロジックを追加する場合などに使用します。
secrets配列サーバーレス関数が認証に使用するシークレットの名前を含む配列。このファイルにはシークレット値を直接入力しないで、シークレット名の参照にとどめてください。
endpointsオブジェクトエンドポイントでは、functionsフォルダーにおいて、公開されるパスおよび特定のJavaScriptファイルへのマッピングが定義されます。エンドポイントの詳細については、以下で説明しています。
**注:**シークレットと環境変数に同じ名前を割り当てないでください。同じ名前を割り当てると、関数で値が返されるときに競合が発生します。

エンドポイント

各エンドポイントには独自の環境変数とシークレットを設定できます。エンドポイント外で指定した変数は、全ての関数とエンドポイントに適用する設定として使用されます。
"events/update": {
      "method": "POST",
      "file": "action2.js",
      "environment": {
        "configKey": "some-other-value"
      },
      "secrets": ["googleAPIKeyName","otherKeyName"]
    }
エンドポイントにはいくつかの固有のキーがあります。
キーTypeDescription
method文字列または文字列からなる配列このエンドポイントによってサポートされるHTTPメソッド(複数可)。既定ではGETです。
file文字列エンドポイントの実装があるJavaScript関数ファイルへのパス。
サーバーレス関数は、HubSpot CMSアカウントのドメインのパスを通して公開されます。これには、既定の.hs-sites.comサブドメインも含まれます。 これらの関数には、次のURLでアクセスできます。 https://{domainName}/_hcms/api/{endpoint-name/path}?portalid={hubId} 以下では、各URLコンポーネントについて説明します。
ParameterDescription
domainName自分のドメイン名。
/_hcms/api/サーバーレス関数用に予約されたパス。このパスには、全てのエンドポイントが含まれます。
endpoint-name/pathserverless.jsonファイルで指定されているエンドポイント名またはパス。
hubId自分のHub ID。これをリクエストに含めることにより、モジュールおよびテンプレートのプレビュー時に関数をテストできます。

関数ファイル

serverless.json構成ファイルに加え、.functionsフォルダーにも、関数を定義するNode.js JavaScriptファイルが含まれています。requestライブラリーを利用して、HubSpot APIや他のAPIへのHTTPリクエストを行うこともできます。 例として、以下のような場合が挙げられます。
// Require axios library, to make API requests.
const axios = require('axios');
// Environment variables from your serverless.json
// process.env.globalConfigKey

exports.main = (context, sendResponse) => {
  // your code called when the function is executed

  // context.params
  // context.body
  // context.accountId
  // context.limits

  // secrets created using the CLI are available in the environment variables.
  // process.env.secretName

  //sendResponse is what you will send back to services hitting your serverless function.
  sendResponse({ body: { message: 'my response' }, statusCode: 200 });
};

コンテキストオブジェクト

コンテキストオブジェクトには、次のパラメーターに格納された、関数の実行に関するコンテキスト情報が含まれています。
ParameterDescription
accountId関数が含まれているHubSpotアカウントのID。
bodyコンテンツタイプapplication/jsonPOSTリクエストとして送信する場合に入力します。
contactCookieに紐付けられたコンタクトから送信されたリクエストの場合、コンタクトオブジェクトには、基本的なコンタクトプロパティーに加え、次の情報が含められます。
  • vid:コンタクトの訪問者ID。
  • isLoggedIn:CMSのアクセス権設定(メンバーシップ機能)を使用した状態で、コンタクトがドメインにログインしている場合はtrueになります。
  • listMemberships:このコンタクトがメンバーとして含まれる、コンタクトリストIDの配列。
headersエンドポイントに対してクライアントから送信されたヘッダーが含まれます。
paramsクエリー文字列値、およびHTMLフォームによるPOST値が入ります。文字列によるキーと、文字列の配列による値から成るマップとして構成されます。context.params.yourvalue
limitsサーバーレス関数のレート制限にどの程度近づいているかを返します。
  • executionsRemaining:残っている実行数(1分あたり)。
  • timeRemaining:残っている実行可能時間。

ヘッダー

エンドポイントにアクセスしているクライアントのヘッダーを知る必要がある場合は、context.bodyを使用して情報にアクセスする場合と同様に、context.headersを使用してこれらのヘッダーにアクセスできます。 以下で、HubSpotが提供する一般的なヘッダーのいくつかについて確認します。完全なリストについては、MDNのHTTPヘッダーのドキュメントをご覧ください。
ヘッダーDescription
acceptクライアント側で処理できるコンテンツタイプをMIMEタイプとして示します。MDNを参照してください。
accept-encodingクライアント側で処理できるコンテンツエンコーディングを示します。MDNを参照してください。
accept-language使用される言葉とロケールを示します。MDNを参照してください。
cache-controlキャッシュ用のディレクティブを保持します。MDNを参照してください。
connectionネットワーク接続が開いたままかどうかを示します。MDNを参照してください。
cookieクライアントから送信されたCookieが含まれます。MDNを参照してください。
hostリスニングサーバーのドメイン名とTCPポート番号を示します。MDNを参照してください。
true-client-ipエンドユーザーのIPアドレス。Cloudflare true-client-ipを参照してください。
upgrade-insecure-requestsレスポンスの暗号化および認証について、クライアント側の設定を示します。MDNを参照してください。
user-agentアプリケーション、オペレーティングシステム、アプリケーションベンダー、バージョンを識別するためのベンダー定義文字列。MDNを参照してください。
x-forwarded-forプロキシーまたはロードバランサーを通過するクライアントの発信元IPアドレスを識別します。MDNを参照してください。

ヘッダーの送信によるリダイレクト

locationヘッダーとstatusCode 301を含むレスポンスを送信することで、サーバーレス関数からリダイレクトを実行できます。
sendResponse({
  statusCode: 301,
  headers: {
    Location: 'https://www.example.com',
  },
});

エンドポイントからCookieを設定する

サーバーレス関数によって、クライアント(ウェブブラウザー)にCookieを設定するように指示できます。
exports.main = (context, sendResponse) => {
    sendResponse({
      body: { ... },
      'Set-Cookie': 'myCookie1=12345; expires=...; Max-Age=...',
      statusCode: 200
    });
  }

1つのヘッダーに複数の値を設定する

複数の値をサポートするヘッダーには、multiValueHeadersを使用して値を渡すことができます。例えば、ブラウザーに複数のCookieを設定するように指示できます。
exports.main = (context, sendResponse) => {
  sendResponse({
    body: { ... },
    multiValueHeaders: {
      'Set-Cookie': [
        'myCookie1=12345; expires=...; Max-Age=...',
        'myCookie2=56789; expires=...; Max-Age=...'
       ]
    },
    statusCode: 200
  });
}

シークレット

サーバーレス関数リクエストを認証する必要がある場合は、シークレットを使用して、APIキーや非公開アプリのアクセストークンなどの値を保存します。CLIを使用して、それらの値を保存するシークレットをHubSpotアカウントに追加することができます。その後でこれらの値にアクセスするには、環境変数(process.env.secretName)を使用します。シークレットの管理には、HubSpot CLIで以下のコマンドを使用します。 CLIを使用して追加されたシークレットは、そのシークレット名を含むsecrets配列を含めることで、関数で使用できるようになります。これにより、関数コードをバージョン管理に保存し、シークレットを公開せずに使用できるようになります。ただし、コンソールログを使用して、またはレスポンスとして、シークレットの値を返さないでください。そうすると、ログや、サーバーレス関数を呼び出すフロントエンドページで、シークレットが公開される恐れがあります。
**注:**キャッシュ保存のため、更新されたシークレット値が表示されるまでには、1分ほどかかる場合があります。シークレットを更新したばかりで、まだ古い値が表示されている場合は、1分ほどしてからもう一度ご確認ください。

フォーム要素からサーバーレス関数を使用する

サーバーレス関数の送信時には、JavaScriptを使ってフォーム送信を処理し、リクエストに"contentType" : "application/json"ヘッダーを使用します。<form>要素のaction属性は使用しないでください。

CORS

CORS(オリジン間リソース共有)はブラウザーのセキュリティー機能です。ブラウザーでは既定で、JavaScriptによって開始されたクロスオリジンリクエストが制限されます。これにより、異なるドメイン間で有害コードが実行され、貴社のサイトに影響を与えることを防止します。これは同一オリジンポリシーと呼ばれます。他のサーバーとのデータの送受信が必要な場合には、ブラウザーからの情報の読み取りをどのオリジン(発信元)に許可するかを示すHTTPヘッダーが外部サーバーから提供されることがあります。 HubSpot内にホスティングされたページでのサーバーレス関数の呼び出しにおいては、CORSの問題は発生しません。発生する場合、正しいプロトコルを使用していることを確認してください。
次のCORSエラーが発生している場合「発信元[リクエスト元ページ]から[関数URL]へのフェッチ(取得)アクセスが、CORSポリシーによってブロックされました:プリフライトリクエストへのレスポンスが、アクセス制御検査に合格しません:要求されたリソースにはAccess-Control-Allow-Originヘッダーがありません。複雑なレスポンスを使用する場合は、リクエストのモードをno-corsに設定して、CORSが無効化されたリソースを取得してください。」呼び出し元サイトとは異なるオリジンへのリクエストとは?
  • ドメイン名が異なる場合は、該当します。
  • 使用しているプロトコル(http、https)が異なる場合は、該当します。
使用しているプロトコルが異なる場合は、プロトコルを合わせて変更するだけで解決します。現時点では、HubSpotのAccess-Control-Allow-Originヘッダーを変更することはできません。CORSエラーのトラブルシューティングに関する詳細はMDNを参照してください。

GETリクエスト

クライアントによっては、GETリクエストでCORSリクエストを行うことが可能な場合があります。GETリクエストでは書き込みを行わないで、データを返すだけにしてください。

事前に読み込まれるパッケージ

現在、HubSpotのサーバーレス関数には、以下の事前読み込みパッケージがあります。 サポートされる最新バージョンの事前読み込み済みパッケージ、または新たに追加されたパッケージを使用するには、次の手順に従います。
  1. 関数ファイルを複製またはコピーします。
  2. serverless.jsonファイル内の関数のエンドポイントを変更して、新しい関数ファイルを指すようにします。旧バージョンは問題なく削除できます。
事前に読み込まれる一連のパッケージには含まれないパッケージをインクルードするには、webpackを使用してノードモジュールを結合し、バンドルされたファイルを関数ファイルとして使用します。

制限

サーバーレス関数は、高速の特定用途を対象として設計されています。迅速な呼び出しとレスポンスを可能にするために、HubSpotのサーバーレス関数には、次のような制限があります。
  • 1アカウントあたり50件のシークレット。
  • 128MBのメモリー。
  • HubSpotアカウントあたり100件以下のエンドポイント。
  • 関数の呼び出しにはcontentType application/jsonを使用する必要があります。
  • サーバーレス関数ログの保存期間は90日。
  • AWS Lambda呼び出しでのペイロードは6MB。
実行制限
  • 各関数の実行時間は最大10秒に制限されます。
  • 各アカウントでは、1分あたり実行時間が合計600秒に制限されています。
つまり、次のいずれかのような状況での利用が可能です。
  • 10秒で完了する関数を60回実行する。
  • 100ミリ秒で完了する関数を6,000回実行する。
これらの制限を超える関数は、エラーになります。実行数と時間の制限には、429のレスポンスが返されます。各関数の実行時間は、サーバーレス関数ログに記録されます。 上記の制限を回避できるよう、実行中に自動で制限データが関数コンテキストに提供されます。その情報に基づいて、アプリケーションを制限内にとどめるような調整を行うことができます。例えばアプリケーションからエンドポイントへのポーリングが必要な場合、ポーリング頻度を調整するための変数をデータと共に返すことができます。これにより、トラフィックの増大時にも制限に到達しないようにポーリング速度を抑え、トラフィックの減少後に元に戻すことが可能になります。