Gmail API へのリクエストは、OAuth 2.0 認証情報を使用して承認する必要があります。アプリケーションがユーザーの代わりに Google APIs にアクセスする必要がある場合（ユーザーがオフラインの場合など）は、サーバーサイド フローを使用する必要があります。この方法では、クライアントからサーバーに 1 回限りの認証コードを渡す必要があります。このコードは、サーバーのアクセス トークンと更新トークンを取得するために使用されます。
サーバーサイドの Google OAuth 2.0 実装の詳細については、ウェブサーバー アプリケーションに OAuth 2.0 を使用するをご覧ください。
目次
クライアント ID とクライアント シークレットを作成する
Gmail API の使用を開始するには、まず設定ツールを使用して Google API Console でプロジェクトを作成し、API を有効にして認証情報を作成する必要があります。
- [Credentials] ページで、[Create credentials] > [OAuth client ID] の順にクリックして OAuth 2.0 の認証情報を作成するか、[Create credentials] > [Service account key] の順にクリックしてサービス アカウントを作成します。
- OAuth クライアント ID を作成した場合は、アプリケーション タイプを選択します。
- フォームに記入し、[Create] をクリックします。
アプリケーションのクライアント ID とサービス アカウント キーが [Credentials] ページに表示されます。クライアント ID をクリックすると詳細を表示できます。パラメータは ID の種類によって異なりますが、メールアドレス、クライアント シークレット、JavaScript のオリジン（生成元）、リダイレクト URI などが含まれる場合があります。
クライアント ID は後でコードに追加する必要があるため、メモしておきます。
承認リクエストの処理
ユーザーが初めてアプリケーションを読み込むと、リクエストされた権限スコープを使用して Gmail アカウントにアクセスする権限をアプリケーションに付与するためのダイアログが表示されます。この初回認証の後、アプリのクライアント ID が変更された場合や、リクエストされたスコープが変更された場合にのみ、ユーザーに権限ダイアログが表示されます。
お客様の認証
この初回ログインでは、成功した場合に認証コードを含む認証結果オブジェクトが返されます。
認可コードをアクセス トークンと交換する
認証コードは、サーバーがアクセス トークンと交換できる 1 回限りのコードです。このアクセス トークンは Gmail API に渡され、アプリケーションにユーザーデータへのアクセス権が一定期間付与されます。
アプリケーションで offline アクセスが必要な場合、アプリが最初に認可コードを交換するときに、更新トークンも受け取ります。このトークンは、前のトークンの有効期限が切れた後に新しいアクセス トークンを受け取るために使用されます。アプリケーションは、後で使用するためにこの更新トークンを保存します（通常はサーバー上のデータベースに保存します）。
次のコードサンプルは、offline アクセス権を持つアクセス トークンと認可コードを交換し、更新トークンを保存する方法を示しています。
Python
CLIENTSECRETS_LOCATION の値は、credentials.json ファイルの場所に置き換えます。
import logging
from oauth2client.client import flow_from_clientsecrets
from oauth2client.client import FlowExchangeError
from oauth2client.client import Credentials # Needed for type hinting/usage in comments
from googleapiclient.discovery import build
from googleapiclient import errors as google_api_errors
import httplib2
# Path to credentials.json which should contain a JSON document such as:
# {
# "web": {
# "client_id": "[[YOUR_CLIENT_ID]]",
# "client_secret": "[[YOUR_CLIENT_SECRET]]",
# "redirect_uris": [],
# "auth_uri": "https://accounts.google.com/o/oauth2/auth",
# "token_uri": "https://accounts.google.com/o/oauth2/token"
# }
# }
CLIENTSECRETS_LOCATION = '<PATH/TO/CLIENT_SECRETS.JSON>'
REDIRECT_URI = '<YOUR_REGISTERED_REDIRECT_URI>'
SCOPES = [
'https://www.googleapis.com/auth/gmail.readonly',
'https://www.googleapis.com/auth/userinfo.email',
'https://www.googleapis.com/auth/userinfo.profile',
# Add other requested scopes.
]
class GetCredentialsException(Exception):
"""Error raised when an error occurred while retrieving credentials.
Attributes:
authorization_url: Authorization URL to redirect the user to in order to
request offline access.
"""
def __init__(self, authorization_url):
"""Construct a GetCredentialsException."""
super().__init__(f"Authorization URL: {authorization_url}")
self.authorization_url = authorization_url
class CodeExchangeException(GetCredentialsException):
"""Error raised when a code exchange has failed."""
pass
class NoRefreshTokenException(GetCredentialsException):
"""Error raised when no refresh token has been found."""
pass
class NoUserIdException(Exception):
"""Error raised when no user ID could be retrieved."""
pass
def get_stored_credentials(user_id):
"""Retrieved stored credentials for the provided user ID.
Args:
user_id: User's ID.
Returns:
Stored oauth2client.client.OAuth2Credentials if found, None otherwise.
Raises:
NotImplementedError: This function has not been implemented.
"""
# TODO: Implement this function to work with your database.
# To instantiate an OAuth2Credentials instance from a Json
# representation, use the oauth2client.client.Credentials.new_from_json
# class method. (oauth2client.client.Credentials needs to be imported)
# Example:
# from oauth2client.client import Credentials
# json_creds = load_from_db(user_id)
# if json_creds:
# return Credentials.new_from_json(json_creds)
# return None
raise NotImplementedError()
def store_credentials(user_id, credentials):
"""Store OAuth 2.0 credentials in the application's database.
This function stores the provided OAuth 2.0 credentials using the user ID as
key.
Args:
user_id: User's ID.
credentials: OAuth 2.0 credentials to store.
Raises:
NotImplementedError: This function has not been implemented.
"""
# TODO: Implement this function to work with your database.
# To retrieve a Json representation of the credentials instance, call the
# credentials.to_json() method.
# Example:
# save_to_db(user_id, credentials.to_json())
raise NotImplementedError()
def exchange_code(authorization_code):
"""Exchange an authorization code for OAuth 2.0 credentials.
Args:
authorization_code: Authorization code to exchange for OAuth 2.0
credentials.
Returns:
oauth2client.client.OAuth2Credentials instance.
Raises:
CodeExchangeException: an error occurred.
"""
flow = flow_from_clientsecrets(CLIENTSECRETS_LOCATION, ' '.join(SCOPES))
flow.redirect_uri = REDIRECT_URI
try:
credentials = flow.step2_exchange(authorization_code)
return credentials
except FlowExchangeError as error:
logging.error('An error occurred: %s', error)
raise CodeExchangeException(None)
def get_user_info(credentials):
"""Send a request to the UserInfo API to retrieve the user's information.
Args:
credentials: oauth2client.client.OAuth2Credentials instance to authorize the
request.
Returns:
User information as a dict.
"""
user_info_service = build(
serviceName='oauth2', version='v2',
http=credentials.authorize(httplib2.Http()))
user_info = None
try:
user_info = user_info_service.userinfo().get().execute()
except google_api_errors.HttpError as e:
logging.error('An error occurred: %s', e)
if user_info and user_info.get('id'):
return user_info
else:
raise NoUserIdException()
def get_authorization_url(email_address, state):
"""Retrieve the authorization URL.
Args:
email_address: User's e-mail address.
state: State for the authorization URL.
Returns:
Authorization URL to redirect the user to.
"""
flow = flow_from_clientsecrets(CLIENTSECRETS_LOCATION, ' '.join(SCOPES))
flow.params['access_type'] = 'offline'
flow.params['approval_prompt'] = 'force'
flow.params['user_id'] = email_address
flow.params['state'] = state
# The step1_get_authorize_url method uses the flow.redirect_uri attribute.
flow.redirect_uri = REDIRECT_URI
return flow.step1_get_authorize_url()
def get_credentials(authorization_code, state):
"""Retrieve credentials using the provided authorization code.
This function exchanges the authorization code for an access token and queries
the UserInfo API to retrieve the user's e-mail address.
If a refresh token has been retrieved along with an access token, it is stored
in the application database using the user's e-mail address as key.
If no refresh token has been retrieved, the function checks in the application
database for one and returns it if found or raises a NoRefreshTokenException
with the authorization URL to redirect the user to.
Args:
authorization_code: Authorization code to use to retrieve an access token.
state: State to set to the authorization URL in case of error.
Returns:
oauth2client.client.OAuth2Credentials instance containing an access and
refresh token.
Raises:
CodeExchangeError: Could not exchange the authorization code.
NoRefreshTokenException: No refresh token could be retrieved from the
available sources.
"""
email_address = ''
try:
credentials = exchange_code(authorization_code)
user_info = get_user_info(credentials) # Can raise NoUserIdException or google_api_errors.HttpError
email_address = user_info.get('email')
user_id = user_info.get('id')
if credentials.refresh_token is not None:
store_credentials(user_id, credentials)
return credentials
else:
credentials = get_stored_credentials(user_id)
if credentials and credentials.refresh_token is not None:
return credentials
except CodeExchangeException as error:
logging.error('An error occurred during code exchange.')
# Drive apps should try to retrieve the user and credentials for the current
# session.
# If none is available, redirect the user to the authorization URL.
error.authorization_url = get_authorization_url(email_address, state)
raise error
except NoUserIdException:
logging.error('No user ID could be retrieved.')
# No refresh token has been retrieved.
authorization_url = get_authorization_url(email_address, state)
raise NoRefreshTokenException(authorization_url)
保存された認証情報による承認
初回認証フローが完了した後にユーザーがアプリにアクセスすると、アプリは保存された更新トークンを使用して、ユーザーに再度プロンプトを表示することなくリクエストを承認できます。
ユーザーをすでに認証している場合、アプリはデータベースから更新トークンを取得し、サーバーサイド セッションにトークンを保存できます。更新トークンが取り消された場合や無効になった場合は、この状態をキャッチして適切な処理を行う必要があります。
OAuth 2.0 認証情報を使用する
前のセクションで説明したように OAuth 2.0 認証情報を取得したら、それを使用して Gmail サービス オブジェクトを承認し、API にリクエストを送信できます。
サービス オブジェクトをインスタンス化する
このコードサンプルは、サービス オブジェクトをインスタンス化し、API リクエストを行うことを承認する方法を示しています。
Python
from apiclient.discovery import build
# ...
def build_service(credentials):
"""Build a Gmail service object.
Args:
credentials: OAuth 2.0 credentials.
Returns:
Gmail service object.
"""
http = httplib2.Http()
http = credentials.authorize(http)
return build('gmail', 'v1', http=http)
承認済みリクエストを送信し、取り消された認証情報を確認する
次のコード スニペットでは、承認済みの Gmail サービス インスタンスを使用してメッセージのリストを取得します。
エラーが発生した場合、コードは HTTP 401 ステータス コードを確認します。このステータス コードは、ユーザーを認証 URL にリダイレクトすることで処理する必要があります。
Gmail API のその他のオペレーションについては、API リファレンスをご覧ください。
Python
from googleapiclient import errors
# ...
def ListMessages(service, user, query=''):
"""Gets a list of messages.
Args:
service: Authorized Gmail API service instance.
user: The email address of the account.
query: String used to filter messages returned.
Eg.- 'label:UNREAD' for unread Messages only.
Returns:
List of messages that match the criteria of the query. Note that the
returned list contains Message IDs, you must use get with the
appropriate id to get the details of a Message.
"""
try:
response = service.users().messages().list(userId=user, q=query).execute()
messages = []
if 'messages' in response:
messages.extend(response['messages'])
while 'nextPageToken' in response:
page_token = response['nextPageToken']
response = service.users().messages().list(userId=user, q=query,
pageToken=page_token).execute()
if 'messages' in response:
messages.extend(response['messages'])
return messages
except errors.HttpError as error:
print('An error occurred: %s' % error)
if error.resp.status == 401:
# Credentials have been revoked.
# TODO: Redirect the user to the authorization URL.
raise NotImplementedError()
次のステップ
Gmail API リクエストの承認に問題がなければ、デベロッパー ガイドの各セクションで説明されているように、メッセージ、スレッド、ラベルの処理を開始できます。
使用可能な API メソッドの詳細については、API リファレンスをご覧ください。