今回はPythonでGmail APIを利用するまでの手順を解説します。
Gmail API を利用するまでに、APIを有効化したり、認証情報を作成したり、ライブラリをインストールしたりとやることが多いので、備忘録として書きました。
Google Cloud PlatformでGmail APIを有効化
Gmail APIを利用するにはGoogle Cloud Platform(GCP)でAPIを有効化する必要があります。GCPにはこちら( https://console.cloud.google.com/ )からアクセスしてください。
初めてアクセスすると下記の画面が出てくると思うので利用規約に同意し、「同意して実行」をクリックしてください。
プロジェクト名を設定する必要があるので、分かりやすい名前をつけましょう。入力後、「作成」をクリック。
これでプロジェクトが作成されました。
次にGmail APIを有効化していきます。検索窓に「gmail」と打ってみるとGmail APIと表示されるのでクリック。
プロジェクトの選択画面が出てきますので、先ほど作成したプロジェクトをクリック。
これでGmail APIが有効になりました。
認証情報、OAuth同意画面の作成
次に、このプログラムを使うユーザーからGmailの利用許可をもらうための設定をします。もし、ユーザーから許可をとらずにプログラム単体でメールを勝手に送信できたら悪用される可能性があります。なので、プログラムを実行したときにユーザーから許可をもらう設定が必要になります。
下記の画面が出ていたら、「認証情報を作成」をクリックします。
「プロジェクトへの認証情報の追加」画面で、下図のように設定します。今回はPythonスクリプトからAPIを利用するので、APIを呼び出す場所は「その他のUI(Windows、CLIツールなど)」を選択しました。また、ユーザーの受信メールの情報を取得したいので、アクセスしたいデータの種類は「ユーザーデータ」を選択しました。設定が出来たら「必要な認証情報」をクリックします。
ダイアログが出てくるので、「同意画面を設定」をクリックします。
「サイドバーの「OAuth同意画面」タブを選択すると、下記の画面が出てきますので、「外部」を選択し、「作成」をクリック
ここまで出来ましたら、認証情報の作成画面に戻ります。
OAuthクライアントIDの作成
「認証情報」タブを選択し「認証情報を作成」をクリックします。表示されるメニューから「OAuthクライアントID」を選択。
「アプリケーションの種類」で「デスクトップアプリ」を選択し、名前に適当なものを付ける。
出来たら「作成」をクリック。
下記の画面に遷移したら、認証情報のJSONファイルをダウンロードします。
Googleクライアントライブラリをインストールする
PythonでGmail APIを利用するにあたって必要なライブラリをpipでインストールしておきましょう。pipとはPythonのパッケージ管理ツールで外部ライブラリを簡単に読み込んで使用できます。Windowsの場合はコマンドプロンプト、Macの場合はターミナルを開いて下記コマンドを実行します。
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
これで、Gmail APIを利用する準備が整いました。
まとめ
PythonでGmail APIを利用するまでの手順を解説しました。
Gmail APIを利用するとメールの送信を自動化することができるので、定期的にメールを送信する作業がある方などは参考にしてください。