Gmail API へのリクエストは OAuth 2.0 を使用して承認する必要がある 認証情報を取得できます。サーバーサイド フローは、アプリケーションの ユーザーの代わりに Google API にアクセスする必要がある。たとえば、ユーザーが オフラインです。この方法では、プロバイダから 1 回限りの認証コードを クライアントをサーバーに送ります。このコードを使用してアクセス トークンを取得し、 更新トークンが生成されます。
サーバーサイドの Google OAuth 2.0 実装について詳しくは、以下をご覧ください。 ウェブサーバー アプリケーションに OAuth 2.0 を使用する
目次
クライアント ID とクライアント シークレットを作成する
Gmail API の使用を開始するには、まず 設定ツールを使用して、Google Cloud コンソールでプロジェクトを作成する手順が 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 が変更された、またはリクエストされたスコープが変更された。
お客様を認証する
この初回ログインにより、承認結果オブジェクトが返されます。このオブジェクトには、 認証コードが成功した場合に表示されます。
認証コードをアクセス トークンに交換する
認証コードは、サーバーが交換できるワンタイム コードです。 アクセス トークン。このアクセス トークンは Gmail API に渡され、 ユーザーデータへのアクセスを制限できます。
アプリが offline へのアクセスを必要とする場合、アプリが初めて交換するときに
認証コードを受け取ると、認証コードのリクエストに使用する更新トークンも受け取ります。
以前のトークンの有効期限が切れた後に新しいアクセス トークンを受け取る。アプリケーション
更新トークンを（通常はサーバーのデータベースに）保存し、
使用できます。
次のコードサンプルは、認証コードを Google Compute Engine に
offline アクセス権が付与され、更新トークンを格納するアクセス トークン。
Python
CLIENTSECRETS_LOCATION 値は、実際のロケーションに置き換えます。
client_secrets.json ファイル。
import logging
from oauth2client.client import flow_from_clientsecrets
from oauth2client.client import FlowExchangeError
from apiclient.discovery import build
# ...
# Path to client_secrets.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."""
self.authorization_url = authorization_url
class CodeExchangeException(GetCredentialsException):
"""Error raised when a code exchange has failed."""
class NoRefreshTokenException(GetCredentialsException):
"""Error raised when no refresh token has been found."""
class NoUserIdException(Exception):
"""Error raised when no user ID could be retrieved."""
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:
NotImplemented: 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.
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:
NotImplemented: 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.
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, 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 errors.HttpError, 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
return flow.step1_get_authorize_url(REDIRECT_URI)
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)
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, 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 apiclient 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 = response['messages']
while 'nextPageToken' in response:
page_token = response['nextPageToken']
response = service.users().messages().list(userId=user, q=query,
pageToken=page_token).execute()
messages.extend(response['messages'])
return messages
except errors.HttpError, 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 リファレンス。