Les requêtes adressées à l'API Gmail doivent être autorisées à l'aide des identifiants OAuth 2.0. Vous devez utiliser un flux côté serveur lorsque votre application doit accéder aux API Google pour le compte de l'utilisateur, par exemple lorsque l'utilisateur est hors connexion. Cette approche nécessite la transmission d'un code d'autorisation à usage unique de votre client à votre serveur. Ce code permet d'obtenir un jeton d'accès et des jetons d'actualisation pour votre serveur.
Pour en savoir plus sur la mise en œuvre du protocole OAuth 2.0 côté serveur côté serveur, consultez la page Utiliser OAuth 2.0 pour les applications de serveur Web.
Sommaire
Créer un ID client et un code secret du client
Pour commencer à utiliser l'API Gmail, vous devez d'abord utiliser l'outil de configuration, qui vous guide tout au long de la création d'un projet dans la console Google APIs, de l'activation de l'API et de la création d'identifiants.
- Sur la page "Identifiants", cliquez sur Créer des identifiants > ID client OAuth pour créer vos identifiants OAuth 2.0, ou sur Créer des identifiants > Clé de compte de service pour créer un compte de service.
- Si vous avez créé un ID client OAuth, sélectionnez votre type d'application.
- Remplissez le formulaire, puis cliquez sur Créer.
Les ID client et les clés de compte de service de votre application sont désormais répertoriés sur la page "Identifiants". Pour en savoir plus, cliquez sur un ID client. Les paramètres varient en fonction du type d'ID, mais peuvent inclure une adresse e-mail, un code secret du client, des origines JavaScript ou des URI de redirection.
Notez l'ID client, car vous devrez l'ajouter à votre code ultérieurement.
Traiter les demandes d'autorisation
Lorsqu'un utilisateur charge votre application pour la première fois, une boîte de dialogue lui est présentée afin d'autoriser votre application à accéder à son compte Gmail avec les champs d'application d'autorisation demandés. Après cette autorisation initiale, la boîte de dialogue d'autorisation ne s'affiche que si l'ID client de votre application ou les champs d'application demandés ont changé.
Authentifier l'utilisateur
Cette connexion initiale renvoie un objet de résultat d'autorisation contenant un code d'autorisation en cas de succès.
Échanger le code d'autorisation contre un jeton d'accès
Le code d'autorisation est un code à usage unique que votre serveur peut échanger contre un jeton d'accès. Ce jeton d'accès est transmis à l'API Gmail pour autoriser votre application à accéder aux données utilisateur pendant une durée limitée.
Si votre application nécessite un accès offline, la première fois qu'elle échange le code d'autorisation, elle reçoit également un jeton d'actualisation qu'elle utilise pour recevoir un nouveau jeton d'accès après l'expiration d'un jeton précédent. Votre application stocke ce jeton d'actualisation (généralement dans une base de données sur votre serveur) en vue d'une utilisation ultérieure.
Les exemples de code suivants illustrent l'échange d'un code d'autorisation contre un jeton d'accès avec un accès offline et le stockage du jeton d'actualisation.
Python
Remplacez la valeur CLIENTSECRETS_LOCATION par l'emplacement de votre fichier 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)
Autoriser avec les identifiants stockés
Lorsque les utilisateurs accèdent à votre application après un flux d'autorisation initiale réussi, votre application peut utiliser un jeton d'actualisation stocké pour autoriser les requêtes sans avoir à afficher à nouveau l'utilisateur.
Si vous avez déjà authentifié l'utilisateur, votre application peut récupérer le jeton d'actualisation de sa base de données et le stocker dans une session côté serveur. Si le jeton d'actualisation est révoqué ou s'il n'est pas valide pour une autre raison, vous devez le détecter et prendre les mesures appropriées.
Utiliser des identifiants OAuth 2.0
Une fois les identifiants OAuth 2.0 récupérés comme indiqué dans la section précédente, vous pouvez les utiliser pour autoriser un objet de service Gmail et envoyer des requêtes à l'API.
Instancier un objet de service
Cet exemple de code montre comment instancier un objet de service, puis l'autoriser à envoyer des requêtes 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)
Envoyer des requêtes autorisées et vérifier les identifiants révoqués
L'extrait de code suivant utilise une instance de service Gmail autorisée pour récupérer une liste de messages.
Si une erreur se produit, le code recherche un code d'état HTTP 401, qui doit être géré en redirigeant l'utilisateur vers l'URL d'autorisation.
Pour plus d'informations sur les opérations de l'API Gmail, consultez la documentation de référence de l'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()
Étapes suivantes
Une fois que vous savez autoriser les requêtes de l'API Gmail, vous pouvez commencer à gérer les messages, les threads et les libellés, comme décrit dans les sections des guides du développeur.
Pour en savoir plus sur les méthodes d'API disponibles, consultez la documentation de référence de l'API.