【SPIRAL×Yoom×Gmail】特定のラベルが付いたメールをSPIRALのDBに自動同期する方法

学生インターンシップです！
スパイラル株式会社の学生インターンとして、SPIRALを学習しながらユーザー目線で質問に答える活動をしています。
補足情報や調査結果を提供を行い、皆様のお役立てができればと思っています！
※学生による調査・補足情報です、参考としてご利用ください。
　正式な仕様や最終的な内容は保証されません。

はじめに

今回ご紹介するのは、特定のラベルが付いたメールをSPIRALのDBに自動同期する方法です。
この連携を活用することで、必要な情報をSPIRALのDBで一元管理することが可能になります！
ステップごとに設定方法を解説していくので皆様も是非お試しください！

全体図

こちらが今回ご紹介する外部連携の流れです。
Gmailで特定のラベルが付いたメールを受信するとそのメールをSPIRALのDBに登録する仕組みになっています。
それでは設定を行っていきましょう！

事前準備

連携を始める前に、Yoomのアカウントをお持ちでない方はアカウント登録を行ってください。
Yoomの登録はこちら
また、あらかじめSPIRALver.2でAPIエージェントを作成しておく必要があります。
設定方法については、こちらをご覧ください。

Step１：SPIRALver.2の設定

Yoomにレコードを送信するために、アプリ利用者とアプリ管理者にAPIエージェントを追加する必要があります。

以下の手順に従って設定を行ってください。

アプリ作成

「アプリ管理」をクリックします。
左上にある四角いアイコンをクリックし、表示名を入力します。
「DB」の横にある四角いアイコンをクリックし、表示名を入力します。
フィールド設定を行い、「保存」をクリックします。

サイト作成

「サイト管理」をクリックします。
左上にある四角いアイコンをクリックし、表示名を入力します。
テスト環境タブにある「ページ」をクリックします。
左上にある四角いアイコンをクリックし、表示名と識別名を入力します。
フォームを作成し、「保存」をクリックします。

グループの作成

「アカウント管理」をクリックします。
ユーザ・グループ管理タブの「グループ」をクリックします。
左上にある四角いアイコンをクリックし、表示名と識別名を入力します。
APIエージェントタブから利用するAPIエージェントを追加してください。

アプリ側の設定

利用するアプリの「管理」にある「アプリ利用者」をクリックし、先ほど作成したグループを追加します。
利用するアプリの「管理」にある「アプリ管理者」をクリックし、先ほど作成したグループを追加します。

Step２：Yoomの設定

特定のラベルのメールを受信したら（アプリ： Gmail）

Yoomにログインし、「新規作成」をクリックします。
「はじめから作成」をクリックします。
「特定のアプリイベントを受信」をクリックし、検索欄に「Gmail」を入力します。
「Gmail」をクリックし、「特定のラベルのメールを受信したら」をクリックします。
「Gmailと連携するアカウント情報」を設定します。
設定が完了したら「次へ」をクリックします。
「トリガーの起動間隔」と「ラベル」を設定してください。
ここで設定したラベルが付与されたメールを受信した場合に、内容が自動的にSPIRALへ同期されます。
「テスト」をクリックし、レコードが取得できるかご確認ください。
問題がなければ「完了」をクリックしてください。
レコードを取得できなかった場合は設定を見直し、再度テストを行ってください。

レコードを登録（アプリ： SPIRALVer.2 ）

＋ボタンをクリックし、検索欄に「SPIRAL」を入力します。
「SPIRAL (ver.2)」をクリックし、「レコードを登録」をクリックします。
「SPIRAL (ver.2)と連携するアカウント情報」を設定します。
アカウント情報の登録ではアカウント名とアクセストークンを設定してください。
設定が完了したら「次へ」をクリックします。
API接続設定を行います。
「アプリID」、「データベースID」、「レコードID」、「レコード情報」を設定してください。
レコード情報は「識別名」と「値」をそれぞれ設定してください。
※アプリIDとデータベースIDの確認方法
・アプリID→管理タブにある「基本設定」内の画面下部
・データベースID→データベース内基本設定タブの画面下部
※「値」はSPIRALのDBに格納される値のことです。
「特定のラベルのメールを受信したら（アプリ：Gmail）」で取得した値を各レコード情報内に設定することでデータがDBに登録されます。
「テスト」をクリックし、SPIRALのDBに値が登録されていることを確認してください。
上手くいかなかった場合は設定を見直してみてください。
※API連携をしている都合上、転記には時間がかかる場合があります。

上手くいかなかった場合は以下の点を確認してください。
・APIエージェントの権限設定が正しく行われているか
→「アプリ利用者」と「アプリ管理者」の両方にAPIエージェントが追加されているかご確認ください。
・Yoomのフィールド取得設定は正しいか
・アプリIDとデータベースIDは正しいか
・メールに正しいラベルを付与しているか

以上で設定は完了です。

では動作確認をしてみましょう！
以下は、実際に設定を行い、動作確認をした結果です。
【受信したメールにラベルを付ける】