このページでは、Zoho Campaigns Email APIの概要について説明します。
Zoho Campaigns Email APIとは、Zoho Campaignsのアプリのひとつです。このアプリを利用することで、APIを通じてメール配信関連の処理を実行することができます。また、Zoho Campaigns Email APIアプリでは、APIの実行状況やメール配信に関する各種情報を確認することも可能です。
以下では、Zoho Campaigns Email APIアプリの設定方法や、アプリのダッシュボードで確認できる内容について詳しく説明します。
Zoho Campaigns Email APIに関する詳細については、こちらをご参照ください。 Zoho Campaigns Email APIの登録
Zoho Campaigns Email APIに登録するにあたって、はじめにZohoアカウントを作成する必要があります。
Zohoの日本のデータセンターでアカウントを作成する場合は、https://accounts.zoho.jpに移動し、必須情報を入力してください。Zohoアカウントのパスワードを設定する際には、8文字以上入力してください。大文字/小文字のアルファベット、数字、特殊文字を一文字以上ずつ使用し、強力なパスワードを設定してください。また、アカウントのセキュリティを強化するにあたって、多要素認証を設定することを強くお勧めします。Zohoアカウントの作成に関する詳細については、こちらをご参照ください。
この機能は現在、早期アクセスの形式で提供されています。そのため、申請に基づき、一部のユーザーのみが利用可能です。Zoho Campaigns Email APIアプリを利用するには、Zohoアカウントの作成後(またはアカウントをすでに作成している場合)にZoho Campaignsアカウントを作成し、support@zohocampaigns.comにご連絡ください。確認後、サポート窓口側で機能を有効にします。現在、Zoho Campaigns Email APIアプリに直接登録できるように対応中です。
Zoho Campaigns Email APIを利用する場合、同じ組織/ポータルでZoho Campaignsを利用することはできなくなります。1件の組織/ポータルでZoho Campaigns Email APIとZoho Campaignsの両方を利用することはできません。Zoho Campaigns Email APIと同じメールアドレスをZoho Campaignsでも利用するには、新しい組織/ポータルを作成する必要があります。また、Zoho Campaigns Email APIの利用を開始すると、途中でZoho Campaignsに切り替えることはできなくなりますのでご注意ください。
利用料金
現在、Zoho Campaigns Email APIの料金プランは、プリペイドプランの1種類のみです。プリペイドプランでは、サービスを利用するにあたってAPIの実行回数に応じたクレジットを事前に購入します。
クレジットの購入後、APIを実行できるようになります。また、このプランに登録すると、クレジットの残数がアプリ内に表示されます。たとえば、1,000クレジットを購入して初回の1クレジットを使用すると、クレジットの残数は999クレジットであることを知らせる旨のメッセージが、アプリの画面右上に表示されます。
Zoho Campaigns Email APIの設定
Zoho Campaigns Email APIの設定を行うには、Zoho Campaigns内でアプリの登録を行います。登録にあたっては、個人設定と組織情報を追加します。具体的には、以下の手順を実施します。
画面右上の[設定]アイコンをクリックします。
[一般]のセクションで、以下の項目にアクセスします。
個人設定:名前、メールアドレス、住所など、個人の詳細情報を追加します。
組織情報:組織名、メールアドレス、WebサイトのURL、電話番号、ブランドのロゴなど、組織の詳細情報を追加します。
ダッシュボード
Zoho Campaigns Email APIにアクセスすると、ダッシュボードの画面が表示されます。
初回にアクセスした際には、APIに関するデータは表示されません。APIの実行を開始すると、データが表示されるようになります。ダッシュボードに表示される主な内容は、以下のとおりです。
メニュー欄
プランの詳細
通知
プロフィール
その他の操作
メール配信に関する統計情報
不達に関する統計情報
迷惑メールに関する統計情報
APIの実行失敗に関する統計情報
概要のグラフ
ダッシュボードの各種の表やグラフに関する詳細については、こちらをご参照ください。
ドメイン
[ドメイン]タブでは、APIによるメール配信で使用するドメインを管理できます。新しいドメインの追加、標準で使用するドメインの設定、ドメインの認証、トラッキング用ドメインの認証など、さまざまな操作を行うことが可能です。
Zoho Campaigns Email APIを設定するにあたって、ドメインの認証は必須です。認証後、APIを通じてメールを配信できるようになります。そのため、ドメインの認証手続きをはじめに行うことをお勧めします。
手動で追加したドメインは、APIを通じて認証したり、Zoho Campaigns Email APIの[ドメイン]タブから認証したりできます。
[ドメイン]タブには、[メールのドメイン]と[トラッキング用ドメイン]の2つのセクションがあります。[メールのドメイン]タブでは配信元ドメインと不達用ドメイン、[トラッキング用ドメイン]ではトラッキングURLのドメインを管理できます。なお、この2つのセクションで同じドメインを登録する場合、各セクションで登録操作を個別に行う必要がありますのでご注意ください。
[ドメイン]タブに関する詳細については、こちらをご参照ください。 配信元API
配信元APIとは、認証方法を利用してZoho Campaigns Email APIと外部アプリを連携し、APIを通じてメールを配信するための連携の仕組みです。連携方法として、REST APIとSMTP APIの両方に対応しています。Zoho Campaigns Email APIでは、認証方法としてOAuth 2.0が使用されます。
OAuth 2.0とは、外部アプリ間でユーザーの認証情報を直接共有することなく、アプリ内のデータに対するアクセス権を安全に許可するための認証の仕組みです。アクセストークンを使用した安全な認証方法です。
OAuth 2.0の設定は、[配信元API]タブで行います。
OAuth 2.0の設定に関する詳細については、こちらをご参照ください。
SMTP(Simple Mail Transfer Protocol)とは、インターネットを通じてメールを送受信するための通信規格です。SMTPに対して、個別の認証方法は不要です。認証には、OAuth 2.0認証で生成された同じトークンを使用することが可能です。SMTPの設定に関する詳細については、こちらをご参照ください。 抑制リスト
抑制リスト(サプレッションリスト)とは、不達となったメールアドレスや配信登録を解除したメールアドレスなど、メール配信の対象外となるメールアドレスの一覧です。Zoho Campaigns Email APIを利用するにあたって、[抑制リスト]タブの管理は非常に重要です。抑制リストの管理メリットは、以下のとおりです。
ドメインの信頼性の維持
IPアドレスの信頼性の維持
対象者のメールアドレスのみに対するメールの配信
Zoho Campaigns Email APIでは、APIを通じて抑制リストに対象者を追加できます。また、対象者を手動で追加することも可能です。手動で追加する際には、複数の対象者を抑制リストにまとめて追加できます。なお、設定/管理できる抑制リストは、1件のみです。抑制リストに関する詳細については、こちらをご参照ください。 受信者リスト
[受信者リスト]タブでは、メールの受信者の詳細情報を管理できます。受信者の詳細情報は、API経由または手動で追加することが可能です。抑制リストとは異なり、複数の受信者リストを設定/管理できます。APIを通じて受信者の詳細情報や受信者リストを追加する方法については、
こちらをご参照ください。 テンプレートリスト
[テンプレートリスト]では、APIを通じてメールを配信する際に使用可能なメールテンプレートを管理できます。APIを通じて新しいテンプレートを作成したり、既存のテンプレートを編集したり、テンプレートの詳細を表示したりすることが可能です。詳細については、こちらをご参照ください。