開発備忘録:手間がかかっても無料でGmailの通知を受けたい

 こんにちは、豆珈琲です。 そろそろ(小説を書きつつも)ゲームよりもエンジニアらしいことをしようと思います。

 色々なものに手を出していますが、仕事中に前から欲しかった

Gmailの指定ラベルのメールだけ受信通知

を目標に今日は備忘録を書きながら、頑張って行こうと思います。

GoogleAPIを使う準備

Google Cloud Platform に登録またはログインします。 これによりGoogle関係の開発を行うAPI*1が使えます。

私がページを見た時点でGoogle Cloud Platform の無料お試し期間の通知が来ていたのですが、今回必要なさそうand無料期間が1年なので目的*2が出来るまで放置です。

cloud.google.com

プロジェクト作成とGmailAPIの有効化

f:id:mamecafe:20170922144021p:plain

 上画像のような画面に遷移するので、そこでプロジェクト作成とGmailAPIを有効化します。

f:id:mamecafe:20170922144609p:plain

 また認証後にこの API を使用するには、認証情報が必要になる可能性があります。開始するには、[認証情報を作成] をクリックしてください。 と言われるので、指示に従いましょう。

f:id:mamecafe:20170922145139p:plain

 APIを呼び出す場所としてjavaScriptなどを選べるようです。今回は、Slack&Botkitで呼び出す予定だったので今回はNode.jsを選択しました。

承認済みのJavaScript生成承認済みのリダイレクトURIhttp://localhostまたは自分自身が使用するURLを入力。

試行錯誤のHello,World!!(比喩表現)

いつもの如く、「Hello,World!!」に挑みます。

Node.js Quickstart  |  Gmail API  |  Google Developers

まずはGoogleのドキュメントを確認。それを元に下記のものを作成しました。

var fs = require('fs');
var readline = require('readline');
var google = require('googleapis');
var googleAuth = require('google-auth-library');

// If modifying these scopes, delete your previously saved credentials
// at ~/.credentials/gmail-nodejs-quickstart.json
var SCOPES = ['https://www.googleapis.com/auth/gmail.readonly'];//許可範囲
var TOKEN_DIR = __dirname + '/../data/auth/'; //API tokenがある場所を指定
var TOKEN_PATH = TOKEN_DIR + 'client_id.json';

// Load client secrets from a local file.
fs.readFile(TOKEN_PATH, function processClientSecrets(err, content) {
    if (err) {
    console.log('Error loading client secret file: ' + err);
    return;
    }
  // Authorize a client with the loaded credentials, then call the
  // Gmail API.
    authorize(JSON.parse(content), listLabels);
});

/**
 * Create an OAuth2 client with the given credentials, and then execute the
 * given callback function.
 *
 * @param {Object} credentials The authorization client credentials.
 * @param {function} callback The callback to call with the authorized client.
 */
function authorize(credentials, callback) {
    //credentialsを確認したところinstalledではなく、webでした
    var clientSecret = credentials.web.client_secret;
    var clientId = credentials.web.client_id;
    var redirectUrl = credentials.web.redirect_uris[0];
    var auth = new googleAuth();
    var oauth2Client = new auth.OAuth2(clientId, clientSecret, redirectUrl);
    // Check if we have previously stored a token.
    fs.readFile(TOKEN_PATH, function(err, token) {
      if (err) {
        getNewToken(oauth2Client, callback);
      } else {
        oauth2Client.credentials = JSON.parse(token);
        console.log(oauth2Client.credentials);
        callback(oauth2Client);
      }
    });
}

/**
 * Get and store new token after prompting for user authorization, and then
 * execute the given callback with the authorized OAuth2 client.
 *
 * @param {google.auth.OAuth2} oauth2Client The OAuth2 client to get token for.
 * @param {getEventsCallback} callback The callback to call with the authorized
 *     client.
 */
function getNewToken(oauth2Client, callback) {
  var authUrl = oauth2Client.generateAuthUrl({
    access_type: 'offline',
    scope: SCOPES
  });
  console.log(authUrl);
  console.log('Authorize this app by visiting this url: ', authUrl);
  var rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout
  });
  rl.question('Enter the code from that page here: ', function(code) {
    rl.close();
    oauth2Client.getToken(code, function(err, token) {
      if (err) {
        console.log('Error while trying to retrieve access token', err);
        return;
      }
      oauth2Client.credentials = token;
      storeToken(token);
      callback(oauth2Client);
    });
  });
}

/**
 * Store token to disk be used in later program executions.
 *
 * @param {Object} token The token to store to disk.
 */
function storeToken(token) {
  try {
    fs.mkdirSync(TOKEN_DIR);
  } catch (err) {
    if (err.code != 'EEXIST') {
      throw err;
    }
  }
  fs.writeFile(TOKEN_PATH, JSON.stringify(token));
  console.log('Token stored to ' + TOKEN_PATH);
}

/**
 * Lists the labels in the user's account.
 *
 * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
 */
function listLabels(auth) {
  var gmail = google.gmail('v1');
  gmail.users.labels.list({
    auth: auth,
    userId: 'me',
  }, function(err, response) {
    if (err) {
      console.log('The API returned an error: ' + err);
      return;
    }
    var labels = response.labels;
    if (labels.length == 0) {
      console.log('No labels found.');
    } else {
      console.log('Labels:');
      for (var i = 0; i < labels.length; i++) {
        var label = labels[i];
        console.log('- %s', label.name);
      }
    }
  });
}

 ひとまず、手元で修正してjs系のエラーはなく動くのですが、 The API returned an error: Error: No access, refresh token or API key is set.と出てしまいます。

アクセストークン(Access Token)の取得

 The API returned an error: Error: No access, refresh token or API key is set.はAccessTokenが無いエラーということなのですが、取得しても30分毎に無効になるようです。

qiita.com

実はAccessTokenという単語に行き着くまで時間がかかりましたので、1次情報に行きつくまで時間がかかりました。

Using OAuth 2.0 for Web Server Applications  |  Google Identity Platform  |  Google Developers

次にやること

今日一日で成し遂げたかったのですが、間に合わなかったので次回に回します。(工数的見積もりは甘かったですね)

  • AccessTokenを使ってGmailAPIを使う
  • ラベル毎のメールを取得する

参考にしたサイト

Google Gmail APIでメールを取得する - Qiita

Google APIを使用するためにGoogle OAuth認証をしようよ | ひま缶

Google API OAuth2.0のトークン取得手順 - Qiita

Node.jsのOAuthを使ってGoogleDriveAPIを叩いてみた - Qiita

*1:車輪の再発明を回避できますが、使うとは別にAPIの原理の理解は必要

*2:機械学習があるので、人工知能では触るかもしれません

広告を非表示にする