トランザクションEメール

トランザクションEメール追加オプション(英語)を利用している場合は、領収書、アカウントの更新、利用規約の変更、その他の重要なビジネス取引についてのEメールを専用IPアドレス経由で送信できます。

トランザクションEメールは、主にコンテンツのプロモーションに使用されるマーケティングEメールと異なり、関係性に基づくやり取りです。

トランザクションEメールの送信方法 

トランザクションEメールを実装するには、次の3つの方法があります。

方法 概要 使用例:
アプリ内トランザクションEメール HubSpotのEメールエディターを使用して、トランザクションEメールを作成します。

スマートコンテンツ、パーソナライズ、テンプレートなど、標準のHubSpot Eメールと同様のメリットがあります。

アプリ内でトランザクションEメールを設定する方法をご確認ください。
新しいポリシーのページへのリンクを記載した、ポリシーの更新に関するEメールを顧客に送信します。これはサービスに関する新情報であってマーケティングEメールではないので、配信設定関連のリンク(CAN-SPAMリンクなど)を含める必要はありません。カスタムプロパティーや外部システムに含まれる情報を使用する必要もありません。
SMTP API
独自のサイトまたはアプリからトランザクションEメールを送信したり、Eメールのパフォーマンスを追跡し、HubSpot内にコンタクト情報を作成したりします。コンタクト情報を作成できるかどうかは、SMTPトークンの作成によって決まります。

後述のSMTP APIセクションにある詳細をご確認ください

別のトランザクションEメールシステムからアカウント登録の確認Eメールを送信します。さらに、Eメールのパフォーマンスを追跡し、HubSpot内にコンタクトを作成します。
1回送信API アプリ内トランザクションEメールとSMTP APIの組み合わせです。

HubSpotのEメールエディターを使用してトランザクションEメールを作成し、API経由でHubSpotに送信できるカスタム外部トークンをEメールに追加します。

後述の1回送信APIにある詳細をご確認ください。
HubSpotを使用して、領収書Eメールを顧客に送信します。このEメールは購入が行われるとトリガーされ、別のシステムからのカスタム値購入品目、合計購入金額などを渡します。さらに、このEメールのパフォーマンスをHubSpotで追跡します。

Please note: any contacts who are CC'd on a transactional email will not be tracked and the email will not appear on the record timeline of the CC'd contact.

SMTP API

SMTP APIを使用して送信するトランザクションEメールは、特定の条件(eコマースウェブサイトで購入が行われた、など)に基づいて自動的にトリガーされます。このAPIはあらゆる内部連携またはサードパーティーシステムとの連携に利用可能で、Eメールのトリガーと、HubSpotの外部に保存されているデータ(配送情報、購入価格など)の取り込みに使用できます。Eメールの送信は貴社のシステムから行われますが、HubSpotトラッキングコードでラッピングされるため、エンゲージメントの追跡と測定が可能です。

SMTP API経由でEメールを送信するには、SMTP APIトークンを使用してHubSpot SMTPサーバーのログイン資格情報を取得する必要があります。サーバーにログインすると、SMTP経由でEメールを送信できます。SMTP APIトークンをまだ作成していない場合は、最初に新しいトークンを生成する必要があります。SMTP APIトークンを作成済みの場合は、API経由でトークンを取得するさまざまな方法をご確認ください。トークンを取得したら、HubSpotのSMTPサーバーにログインする方法をご確認ください。

Eメールの送信元アドレスとして使用するドメインは、Eメール送信ドメインとしてHubSpotに接続する必要があります。SMTP API経由でトランザクションEメールを送信する場合に、貴社のHubSpotアカウントに代わって送信できる権限のないドメインを使用すると、エラーが発生します。

Please note: all methods in the SMTP API require an OAuth token for authentication.

If you prefer, all of the methods below for creating, retrieving, deleting, and resetting passwords for SMTP API tokens can be done within your HubSpot account, rather than the API.

新しいSMTP APIトークンの作成

新しいSMTP APIトークンを作成するには、/marketing/v3/transactional/smtp-tokens/POSTリクエストを送信します。

リクエストの本文として、次のプロパティーから成るJSON形式のオブジェクトが必要です。

  • createContactEメールの受信者に対応するコンタクトを作成するかどうかを示します。
  • campaignNameSMTP APIトークンに関連付けるキャンペーンの名前。

レスポンスに含まれるSmtpApiTokenViewには、次の要素があります。

  • id:HubSpot SMTPサーバーにログインするためのユーザー名。
  • createdBy:トークン作成リクエストを送信したユーザーのEメールアドレス。
  • password:HubSpot SMTPサーバーにログインするためのパスワード。
  • emailCampaignId:キャンペーンに割り当てられたID(トークン作成リクエスト内で提供)。
  • createdAt:トークン作成時に生成されたタイムスタンプ。
  • createContact:Eメールの受信者に対応するコンタクトを作成するかどうかを示します。
  • campaignName:トークンに関連付けられたキャンペーンの名前。

トークンが作成されたら、idpasswordの値を使用して、HubSpotのSMTPサーバーにログインできます。

トークンのパスワードは、作成時にのみ取得できます。パスワードを忘れた場合、または新しいパスワードを設定する場合は、トークンのパスワードをリセットする必要があります。 

SMTP API tokens generated through the public API expire after 12 months. Once expired, they're automatically deleted.

既存のSMTP APIトークンを取得する

以下では、API経由で既存のSMTP APIトークンを取得する方法を示します。

キャンペーン単位でSMTP APIトークンのリストを取得する

キャンペーン名を使ってトークンのリストを取得するか、キャンペーンIDに基づく1つのトークンを取得するには、/marketing/v3/transactional/smtp-tokensGETリクエストを送信します

campaignNameまたはemailCampaignIdのパラメーターもリクエストに含める必要があります。この記事の上部の「エンドポイント」タブには、リクエストに関する詳細があります。

レスポンスの詳細

レスポンスには、最上位のフィールドとしてresultspagingが含まれます。

  • results:以下の要素を含むSmtpApiTokenViewのコレクション。
    • id:HubSpot SMTPサーバーにログインするためのユーザー名。
    • createdBy:トークン作成リクエストを送信したユーザーのEメールアドレス。
    • emailCampaignId:キャンペーンに割り当てられたID(トークン作成リクエスト内で提供)。
    • createdAt:トークン作成時に生成されたタイムスタンプ。
    • createContact:Eメールの受信者に対応するコンタクトを作成するかどうかを示します。
    • campaignName:トークンに関連付けられたキャンペーンの名前。
  • paging:さらに結果をリクエストするためのnext.afterフィールドがあります。

単一のSMTP APIトークンの照会

IDに基づいて単一のSMTP APIトークンを照会するには、/marketing/v3/transactional/smtp-tokens/{tokenId}GETリクエストを送信します。

レスポンスの詳細

レスポンスに含まれるSmtpApiTokenViewには、次の要素があります。

  • id:HubSpot SMTPサーバーにログインするためのユーザー名。
  • createdBy:トークン作成リクエストを送信したユーザーのEメールアドレス。
  • emailCampaignId:キャンペーンに割り当てられたID(トークン作成リクエスト内で提供)。
  • createdAt:トークン作成時に生成されたタイムスタンプ。
  • createContact:Eメールの受信者に対応するコンタクトを作成するかどうかを示します。
  • campaignName:トークンに関連付けられたキャンペーンの名前。

既存のトークンを管理する

トークンの作成後に、API経由でパスワードをリセットしたり、トークンを削除したりすることができます。

パスワードをリセットする

トークンのパスワードをリセットするには、/marketing/v3/transactional/smtp-tokens/{tokenId}/password-resetにPOSTリクエストを送信します。

レスポンスに含まれるSmtpApiTokenViewには、次の要素があります。

  • id:HubSpot SMTPサーバーにログインするためのユーザー名。
  • createdBy:トークン作成リクエストを送信したユーザーのEメールアドレス。
  • emailCampaignId:キャンペーンに割り当てられたID(トークン作成リクエスト内で提供)。
  • createdAt:トークン作成時に生成されたタイムスタンプ。
  • createContact:Eメールの受信者に対応するコンタクトを作成するかどうかを示します。
  • campaignName:トークンに関連付けられたキャンペーンの名前。

トークンを削除する

単一のSMTP APIトークンを削除するには、/marketing/v3/transactional/smtp-tokens/{tokenId}にDELETEリクエストを送信します。

レスポンスに含まれるコンテンツはありません。

HubSpotのSMTPサーバーにログインする

トークンのユーザー名(id)とパスワードを使用してHubSpotのSMTPサーバーにログインする方法を、以下に示します。

  • SMTPホスト名:
    • EUを拠点にしていない場合は、ホスト名としてsmtp.hubapi.comを使用します。
    • EUを拠点にしている場合は、ホスト名としてsmtp-eu1.hubapi.comを使用します。
  • SMTPポート:
    • EUを拠点にしていない場合は、ポート587(STARTTLSの場合)またはポート465(TLSの場合)を使用します。
    • EUを拠点にしている場合は、ポート587またはポート25(STARTTLSの場合)を使用します。
  • SMTPユーザー名:idフィールドに提供されます。
  • SMTPパスワード:passwordフィールドに提供されます。

1回送信API

1回送信APIでは、JSON形式のPOSTリクエストを使用して、HubSpotのEメールツールで作成したテンプレートEメールを送信できます。このAPI経由で送信するEメールは、Eメールアドレスに基づいて自動的にコンタクトレコードに関連付けられます。Eメールアドレスに一致するコンタクトがない場合、そのEメールアドレスのコンタクトが新たに作成されます。Eメールを送信する際にコンタクトを作成しない場合は、SMTP APIを使用してください。

まず、HubSpot上でEメールを設定します。Eメールが公開されたら、APIリクエストの本文で受信者の詳細(Eメールテンプレートに設定済みのコンタクトやカスタムプロパティーを含む)を設定できます。この時点で、Eメールの詳細ページから、リクエストに必要なEメールIDをコピーしておくこともできます。

Screen Shot 2020-04-15 at 1.00.37 PM

HubSpot does not save the HTML/JSON sent through this API. You can review the email template from the recipient contact's timeline, but if you want to keep a record of the email's contents, it's recommended to add a BCC to the email.

1回送信APIを使ってEメールを送信するには、/marketing/v3/transactional/single-email/sendPOSTリクエストを送信します。

レスポンスには、次のフィールドが含まれます。

    • requestedAt:送信がリクエストされた時刻のタイムスタンプ。
  • status:送信リクエストのステータス。PENDINGPROCESSINGCANCELEDCOMPLETEがあります。

リクエストのプロパティー

リクエストの本文として、次のプロパティーから成るJSON形式のオブジェクトが必要です。

  • emailId
  • message
  • contactProperties
  • customProperties

emailId

emailIdフィールドには、トランザクションEメールのコンテンツIDを指定します。このIDは、HubSpotのEメールツールで確認できます。

message

messageは、明示的に変更する項目から成るJSONオブジェクトです。少なくともtoフィールドを含める必要があります。

messageオブジェクトには、次のフィールドがあります。

  • to:Eメールの受信者。
  • from:Eメールの「From」ヘッダー。from名は、次の形式で定義できます。"from":"送信者名 <sender@hubspot.com>"
  • sendId:特定の送信のID。所定のsendIdが割り当てられたEメールは、アカウントごとに1回だけ送信されます。このフィールドは、Eメールの重複送信を防止する目的で含めることができます。
  • replyTo:Eメールの「Reply-To」ヘッダーの値のJSONリスト。
  • cc:CCとして送信するEメールアドレスのJSONリスト。
  • bcc:BCCとして送信するEメールアドレスのJSONリスト。

contactProperties

contactPropertiesフィールドは、コンタクトのプロパティー値のJSONマップです。各コンタクトのプロパティー値には、namevalueがあります。各プロパティーはコンタクトレコード上に設定され、テンプレートの{{ contact.Name }}に表示されます。これらのプロパティーは、Eメールの送信時にコンタクトのプロパティーを設定する場合に使用します。例えば、領収書の送信時にlast_paid_dateプロパティーを設定すると、前回の支払いに関する情報を提供できます。

コンタクトプロパティーの書式の例を次に示します。

{

  “property_name_1”: “property_value_1”,

  “property_name_2”: “property_value_2”

}

customProperties

customPropertiesフィールドは、プロパティー値のJSONマップです。一般的に、これらのプロパティーはEメールを受信するコンタクトではなくEメール自体と関連付けられています。ウェブページ形式のEメールにも、コンタクトのタイムライン上のEメールビューにも表示されません。このようなプロパティーはHubSpot上にも保存されません。送信Eメールにのみ含められます。

各プロパティーの値にはnameおよびvalueのプロパティーがあり、テンプレートの{{custom.NAME}}に表示されます。

例:

{

  “property_name_1”: “property_value_1”,

  “property_name_2”: “property_value_2”

}

カスタムプロパティーをプログラマブルEメールコンテンツに使用した場合は、配列のみがサポートされます。tableまたは<ul>を使用してHTMLリストを作成し、そのリストをカスタムプロパティーとして指定することもできます。

Eメール送信のステータスを問い合わせる

Eメール送信のステータスを調べるには、https://api.hubapi.com/marketing/v3/email/send-statuses/{statusId}GETリクエストを送信します。 

レスポンスには、次のフィールドが含まれます。

    • sendResult:SendResultの値。値については後述します。
    • requestedAt:送信がリクエストされた時刻のタイムスタンプ。
  • startedAt:送信の処理が開始された時刻のタイムスタンプ。
  • completedAt:送信が完了した時刻のタイムスタンプ。
  • statusId:送信のステータスを問い合わせる際に使用できる識別子。
  • status:送信リクエストのステータス。PENDINGPROCESSINGCANCELEDCOMPLETEがあります。
  • eventId:送信された場合、送信イベントのIDと送信時に生成されたタイムスタンプ。

SendResult

SendResultは、Eメールの送信に対して想定される結果の列挙値です。

  • SENT:Eメールが正常に送信されました。
  • QUEUED:Eメールがキューに追加され、キューによる送信処理を待機中です。
  • PORTAL_SUSPENDED利用規定に対する違反により、このHubSpotユーザー企業のEメールが停止されています。
  • INVALID_TO_ADDRESS:受信者のアドレスが無効です。
  • BLOCKED_DOMAIN:現時点では、ドメインがHubSpotからのEメールを受信できません。
  • PREVIOUSLY_BOUNCED:前回この受信者にバウンスが発生したため、送信ロジックに基づき送信が行われませんでした。
  • PREVIOUS_SPAM:この受信者が前回、同様のEメールをスパム扱いにしました。
  • INVALID_FROM_ADDRESS:送信元アドレスが無効です。
  • MISSING_CONTENTemailIdが無効か、emailIdが1回送信用として設定されていないEメールと一致します。
  • MISSING_TEMPLATE_PROPERTIES:リクエストとして送信したcustomPropertiesに含まれていないカスタムプロパティーが、テンプレートに含まれています。

参考になりましたか?
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。