【SendGrid】もっとメールを活用するためのAPIガイド

もっとメールを活用するための APIガイド

Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved 2

このガイドの目的 SendGridの特徴として、高い配信到達性、スケーラビリティ、リアルタイム分析、そして柔軟なAPIが挙げられます。このガイドでは、SendGridの多種多様なAPIのご紹介だけではなく、メールの運用効率を上げ、顧客にメールを確実に届けるためのAPI活用術も紹介いたします。

コンテンツ ≫ 各APIの概要 ≫ 使用事例・ベストプラクティス ≫ API活用のポイントやオンライン上の詳細情報 ≫ 役に立つリソースやツール

アイコンの凡例


Tipアイコン APIをより便利にご活用いただくためのコツをご紹介します。

Infoアイコン詳しい情報を見ていただける、オンラインドキュメントなどをご紹介します。

事例アイコン SendGridのお客様のAPI活用例をご紹介します。

▲各プランのアイコン SendGirdのプランを表すアイコンです。各APIをご利用になれるプランをご紹介する際などに表示されます。左より、Free（無料）、Lite、Bronze、Silver、Gold、Platinumプランを表します。

SMTPリレー | SMTP API | Web API たった数分で始めるメール配信 SendGridなら、メール配信を今すぐ開始できます。オプションはSMTPリレー、Web API、そしてSMTP APIの3つです。

SMTPリレー •  　(正確にはAPIではありませんが）幅広いWebアプリケーションでサポートされており、

もっとも手早くメール配信を立ち上げることができます。 •  SendGridでは下記のように多数のフレームワーク、言語、そしてアプリケーション

をサポートしており、お客様のシステムとのシームレスな統合を実現します


メールを送信する。

* Lite のWeb APIご利用には、一部制限があります。

*

Web API •  SMTPリレーを利用できない場合(*)にご利用ください。 *SMTPリレーが利用できない原因として、SMTPポートがブロックされている可能性が挙げられます。Web APIはHTTP経由でSMTPを送信するので、ブロックをバイパスしてメールを届けることができるようになります。

SMTP API •  メールのヘッダに挿入されるX-SMTPAPIにより、メール送信をカスタマイズします。 ≫  ヘッダはJSONでエンコードされます。

•  SMTP APIをご利用いただくことで、次のようなことを実現できます。 ≫  メールをタグ付けして、各タグごとに統計処理する。 ≫  メールマージ機能を利用して、ユーザごとに異なるメールを単一のリクエストで送信する。

≫  メールごとにアプリの設定を細かく変更する。 ≫  動的コンテンツをメールで配信する。 ≫  フィルタリング設定をカスタマイズし、各メール配信から取得するログの量や内容を調整する。


メールを送信する。

SMTPリレー | SMTP API | Web API * Lite のWeb APIご利用には、一部制限があります。

*

Parse Webhook メールから情報を引き出します。 •  受信したメールをパースし、指定したURLにポストすることが可能です。 •  例として、以下のようなことを実施できます。

≫  メールを通してブログに記事を投稿。 ≫  メールの自動返信や、メーリングリスト、データベースのアップデート。 ≫  写真やプロフィールをメールでアップロード。 ≫  カスタマイズコードでデータの更新をリアルタイム把握。


メールの受信・コンテンツのアップ

Parse Webhookの仕組み

SendGridで定義したアドレスへ、ユーザがメールを送信

SendGridは受信したメールを各パーツ（ヘッダ、本文、添付ファイル...）に分解

各パーツを指定したURLにポスト

１２３

Event Webhook メールに対する反応を、リアルタイムで把握するために。 •  SendGridのEvent Webhookなら、様々なパラメータを指標にして、リアルタイム通知・処理

を実行することができます。下記はその一例です。 ≫  配信停止手続きをした人を自動的に宛先リストから削除する。 ≫  特定のメール配信での迷惑メール報告とユーザを照らし合わせる。 ≫  ユーザが確認メールをクリックした際にリアルタイムで通知を受ける。 ≫  特定のリンクをユーザがクリックした際に通知を受ける。 ≫  ユーザがメールを開封（HTMLメッセージを閲覧）した際に通知を受ける。 ≫  特定のMTAレスポンスを把握する。


リアルタイム通知を設定する。

様々なイベントをトレースできます。 SendGridでは、下記のイベントをトレース指標として設定しています。 •  Proceed (受付済)

≫  メールはSendGirdに受領され、配信待ちとなっている状態です。 •  Dropped (ドロップ)

≫  メール受信者が、バウンス、迷惑メール報告者、配信停止、いずれかに属していることを指します。 •  Delivered (配信済)

≫  メールが受信サーバに受理されたことを意味します。※送付先へ届いたことを保証するものではありません。

•  Deferred (遅延) ≫  配信先の受信サーバが、一時的にメール受信を拒否したことを意味します。

•  Bounce (バウンス) ≫  受信サーバがメールを受理できない、あるいはしないことを意味します。

•  Open (メール開封) ≫  メール受信者が、HTMLメッセージを開封したことを意味します。

•  Click (クリック) ≫  メール受信者が、メール中のリンクをクリックしたことを意味します。

•  Spam report (迷惑メール報告) ≫  メール受信者が、メールを迷惑メールとしてフラグ立てしたことを意味します。

•  Unsubscribe (配信停止) ≫  メール受信者が配信停止リンクをクリックしたことを意味します。


Event Webhook リアルタイム通知を設定する。


Event Webhook リアルタイム通知を設定する。

Event Webhookについて、さらに詳しくは SendGridのオンラインドキュメントをご覧ください。

Event Webhookでレポート作成お客様側のシステム自動化により、処理・分析したデータを、チャートやグラフとして表示することもできます。SendGridの統計画面では表示されないデータをお客様のシステム上で表示させることも可能です。

ログ管理をEvent Webhookで SendGirdでは、過去7日分のメールアクティビティのデータが保存されます。保存期間が足りない場合は、Event Webhookを利用して外部へ保存してください。メールの配信数が多い場合は、それに応じた容量になるのでご注意ください。また、メールの統計をカテゴリ別でなく、特定のメールで実施されたい場合にも、Event Webhookをご活用ください。

Web API メールの管理をもっとお手軽に。 •  Web APIをお使いいただければ、ダッシュボードサイトへのログインなしで多様な

メール管理を実施できます。 •  例えば、以下の目的・用途にご利用いただけます。 ≫  設定や集計、レポートの自社システムへの反映 ≫  送信ポートがブロックされたり、ライブラリを一から開発する際のメール送信 ≫  OEMセットアップのためのサブユーザのアカウントを作成・管理 ≫  自社プラットフォームとの連携強化のための、独自インターフェースの構築


メールからのコンテンツ抽出に。


*

Web APIのエンドポイントは下記の11種類です。 •  Bounce (バウンス)

≫  バウンスされたメールのアドレスを読み出し、削除します。 •  Blocks (ブロック)

≫  ISPにブロックされたメールのアドレスを読み出し、削除します。 •  Email Parse (パース)

≫  パース設定を追加、編集、削除します。 •  Event Notification URL (イベント通知用URL)

≫  任意のURLにイベント通知をアップ、更新したり、削除したりします。 •  Filters (フィルタ)

≫  利用可能なアプリケーションの確認、設定変更、有効／無効の切り替えを実施します。 •  Invalid Emails (無効アドレス)

≫  無効なアドレスに配信したメールを読み出し、削除します。 •  Profile (プロフィール)

≫  認証情報、メールアドレスといったプロフィール情報を読み出し、更新します。 •  Spam Report (迷惑メール報告)

≫  迷惑メール報告を出した受信者のアドレスを削除します。 •  Statistics (統計)

≫  リクエスト、バウンス、迷惑メール報告、カテゴリーなど、様々なマトリクスの統計情報を読み出します。 •  Unsubscribes (配信停止)

≫  配信停止をしたアドレスを追加、読み出し、そして削除します。


Web API メールからのコンテンツ抽出に。


*


Web API メールからのコンテンツ抽出に。

さらに活用していただくために "Filter Settings Page"では、Web APIで使用できるアプリケーションやパラメータの一覧をウェブサイトでご覧いただけます。また、モジュールとアクションの一覧も、オンラインで提供しています。

サブユーザのアカウント管理サブユーザが、お客様のウェブサイトを通して自身のアカウントを管理できるようにすることもできます。（SendGridへのiframeを利用します。）Web APIにコンタクトして、URLを取得し、取得したURLにアクセスしてください。


*

Subuser API サブユーザアカウントの作成と、権限の設定に。 •  サブユーザアカウントは、親アカウントとクレジット（メール配信上限）を共有しているもの

の、SMTP権限、設定、統計、そしてサイトへのログインは親アカウントから独立しています。組織全体を親アカウント、各部署をサブユーザアカウント、といった設定も可能です。

•  サブユーザアカウントはSendGridのサブユーザ管理ページで作成、管理いただけます。 •  以下は、親アカウントがサブユーザアカウントに対して実行できることの一例です。

≫  サブユーザがSendGridへのログインなしで利用できるよう、カスタムインターフェースをセットアップ。

≫  SendGridプラットフォームをサブユーザに拡張。例）サブユーザが特定のアナリティクス（配送×レスポンスのマトリクスなど）へアクセスできるようにする。

≫  クライアントごとにカスタムレポートを作成し、それぞれから特定の宛先や特定の日時にメールを配信する。

≫  サブユーザがマーケティングメールを使用できるようにする。 ≫  バウンス、配信停止、迷惑メール報告、そして無効の宛先の管理。 ≫  メール配信の上限に達することがないように、サブユーザのメール配信を管理する。 ≫  サブユーザが迷惑メールを送っていないか確かめるために、レコードを監視したり、サンプルメッセージを取得する。

≫  ログイン権限や、イベント通知、パース設定、アプリケーションといったAPIの設定を管理する。


メールからのコンテンツ抽出に。

Marketing Email API マーケティングメールをもっと簡単に管理・配信。 Marketing Email APIを使えば、プログラミングの知識がない人でも簡単にマーケティングメールを配信できる仕組みを構築できます。どなたでも、下記のようなことを実行できます。 •  宛先リストのアップロード編集。 •  リスト中の特定のグループへのメール配信。

例)　前回のマーケティングメールを開封した人にのみメールを送る。 •  リストごとにメールの配信を設定、複数テンプレートの管理。 •  宛先リストに対するバッチメッセージの設定。

Marketing Email APIのモジュールは、次の6つです。 •  Marketing Email (マーケティングメール)：マーケティングメールの管理、作成、配信に利用し

ます。 •  Marketing Email - Lists (リスト)：マーケティングメールの記事に関連づけて配信先のリスト

を管理・作成します。 •  Marketing Email - Lists - Email (リスト - メール)：配信先リストへの入力を管理します。 •  Marketing Email - Identity (アイデンティティ)：マーケティングメールの記事に関連づけてア

イデンティティを管理・作成します。 •  Marketing Email - Recipients (配信先)：配信先リストへの入力を管理します。 •  Marketing Email - Schedule (スケジュール)：マーケティングメールの配信スケジュールを追

加、閲覧、削除します。


マーケティングメールの配信に。


Marketing Email API マーケティングメールの配信に。

便利機能：配信テストの実施 Marketing Email APIを使用して、配信テストを実行できます。前回のマーケティングメールを開封した人に絞ってメールを送信したり、リストの一部の人に、2通りの文面の送信して、より反応がよかった文面をリストの残りの人に配信する、といったことが行えます。

マーケティングメールダッシュボードの活用ダッシュボードでは、全マーケティングメールの統計やよく利用するモジュールへのリンク、ブログやツイッターからの最新エントリーが表示されます。一点、配信停止は全体でなく、リストごとの表示になることをご留意ください。データを統合すれば一括して配信停止処理をすることもできます。

さらに活用していただくためにオンラインのドキュメントで、Marketing Email APIとマーケティングメールについて、さらに詳しく解説しています。

各APIについて、さらに詳しくは

SendGridホームページへお越し下さい！

sendgrid.kke.co.jp


【お願い】この資料およびその内容を、弊社に無断で使用、複写、破壊、改竄すること、ならびに第三者へ開示すること、漏洩すること、あるいは使用させることは、固くお断り申し上げます。

Technology

【SendGrid】もっとメールを活用するためのAPIガイド