Запросы к API Gmail должны быть авторизованы с использованием учётных данных OAuth 2.0. Серверный процесс следует использовать, когда вашему приложению требуется доступ к API Google от имени пользователя, например, когда пользователь находится офлайн. Этот подход требует передачи одноразового кода авторизации от клиента на сервер; этот код используется для получения токена доступа и токенов обновления для вашего сервера.
Дополнительную информацию о реализации Google OAuth 2.0 на стороне сервера см. в разделе Использование OAuth 2.0 для приложений веб-сервера .
Содержание
Создайте идентификатор клиента и секретный код клиента
Чтобы начать использовать API Gmail, вам необходимо сначала воспользоваться инструментом настройки , который поможет вам создать проект в консоли API Google, включить API и создать учетные данные.
- На странице «Учетные данные» нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» , чтобы создать учетные данные OAuth 2.0, или «Создать учетные данные» > «Ключ учетной записи службы» , чтобы создать учетную запись службы.
- Если вы создали идентификатор клиента OAuth, выберите тип приложения.
- Заполните форму и нажмите «Создать» .
Идентификаторы клиентов и ключи учётных записей служб вашего приложения теперь указаны на странице «Учётные данные». Для получения подробной информации нажмите на идентификатор клиента; параметры различаются в зависимости от типа идентификатора, но могут включать адрес электронной почты, секретный ключ клиента, источники JavaScript или URI перенаправления.
Запишите идентификатор клиента, так как позже его нужно будет добавить в код.
Обработка запросов на авторизацию
При первой загрузке вашего приложения пользователю отображается диалоговое окно с просьбой предоставить вашему приложению разрешение на доступ к его учётной записи Gmail с запрошенными областями доступа . После этой первоначальной авторизации диалоговое окно с запросом разрешения отображается только в случае изменения идентификатора клиента вашего приложения или запрошенных областей доступа.
Аутентифицировать пользователя
Первоначальный вход в систему возвращает объект результата авторизации, который в случае успеха содержит код авторизации .
Обменяйте код авторизации на токен доступа
Код авторизации — это одноразовый код, который ваш сервер может обменять на токен доступа . Этот токен доступа передаётся в API Gmail, чтобы предоставить вашему приложению доступ к пользовательским данным на ограниченное время.
Если вашему приложению требуется offline доступ, при первой передаче кода авторизации оно также получает токен обновления , который используется для получения нового токена доступа после истечения срока действия предыдущего. Ваше приложение сохраняет этот токен обновления (обычно в базе данных на сервере) для последующего использования.
В следующих примерах кода демонстрируется обмен кода авторизации на токен доступа с offline доступом и сохранение токена обновления.
Питон
Замените значение 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.
Питон
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-адрес авторизации.
Дополнительные операции API Gmail описаны в Справочнике API .
Питон
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()
Следующие шаги
Как только вы освоитесь с авторизацией запросов API Gmail, вы будете готовы приступить к обработке сообщений, потоков и меток, как описано в разделах Руководства для разработчиков.
Более подробную информацию о доступных методах API можно найти в Справочнике API .