Anfragen an die Gmail API müssen mit OAuth 2.0 autorisiert werden Anmeldedaten. Sie sollten den serverseitigen Ablauf verwenden, wenn Ihre Anwendung muss im Namen des Nutzers auf Google APIs zugreifen, beispielsweise wenn der Nutzer offline. Bei diesem Ansatz muss ein einmaliger Autorisierungscode von vom Client auf den Server übertragen. wird dieser Code verwendet, um ein Zugriffstoken zu erhalten und Aktualisierungstokens für Ihren Server.
Weitere Informationen zur serverseitigen Implementierung von Google OAuth 2.0 findest du unter OAuth 2.0 für Webserveranwendungen verwenden.
Inhalt
Client-ID und Clientschlüssel erstellen
Um die Gmail API verwenden zu können, müssen Sie zuerst verwenden das Einrichtungstool, das Sie durch die Erstellung eines Projekts im Google API Console, um die API zu aktivieren und Anmeldedaten zu erstellen
- Klicken Sie auf der Seite „Anmeldedaten“ auf Anmeldedaten erstellen > OAuth-Client ID zum Erstellen Ihrer OAuth 2.0-Anmeldedaten oder auf Anmeldedaten erstellen > Dienst Kontoschlüssel, um ein Dienstkonto zu erstellen.
- Wenn du eine OAuth-Client-ID erstellt hast, wähle deinen Anwendungstyp aus.
- Füllen Sie das Formular aus und klicken Sie auf Erstellen.
Die Client-IDs und Dienstkontoschlüssel Ihrer Anwendung sind jetzt auf auf der Seite „Anmeldedaten“. Klicken Sie auf eine Kundennummer, um weitere Informationen zu erhalten. Parameter variieren je nach ID-Typ, kann aber E-Mail-Adresse, Clientschlüssel, JavaScript-Quellen oder Weiterleitungs-URIs.
Notieren Sie sich die Client-ID, da Sie sie später Ihrem Code hinzufügen müssen.
Autorisierungsanfragen verarbeiten
Wenn ein Nutzer Ihre Anwendung zum ersten Mal lädt, wird ihm eine ein Dialogfeld, um Ihrer Anwendung die Berechtigung zu erteilen, auf ihr Gmail-Konto zuzugreifen. Konto mit den angeforderten Berechtigungsbereichen. Nach dieser ersten Berechtigungsdialogfeld wird dem Nutzer nur angezeigt, Änderungen der Client-ID der App oder die angeforderten Bereiche haben sich geändert.
Nutzer authentifizieren
Diese erste Anmeldung gibt ein Autorisierungsergebnisobjekt zurück, das ein Autorisierungscode, wenn der Vorgang erfolgreich war.
Autorisierungscode gegen Zugriffstoken austauschen
Der Autorisierungscode ist ein Einmalcode, den Ihr Server gegen Ein Zugriffstoken Dieses Zugriffstoken wird an die Gmail API übergeben, um auf Nutzerdaten zugreifen können.
Wenn Ihre Anwendung offline-Zugriff benötigt, tauscht sie beim ersten
den Autorisierungscode enthält, empfängt er auch ein Aktualisierungstoken, mit dem er
ein neues Zugriffstoken zu erhalten, nachdem ein vorheriges Token abgelaufen ist. Ihre Anwendung
speichert dieses Aktualisierungstoken (normalerweise in einer Datenbank auf Ihrem Server) für
später verwenden können.
Mit den folgenden Codebeispielen wird veranschaulicht, wie ein Autorisierungscode gegen
ein Zugriffstoken mit offline-Zugriff und Speichern des Aktualisierungstokens.
Python
Ersetzen Sie CLIENTSECRETS_LOCATION durch den Speicherort Ihres
client_secrets.json-Datei.
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)
Mit gespeicherten Anmeldedaten autorisieren
Wenn Nutzer deine App nach einer erfolgreichen erstmaligen Autorisierung aufrufen kann Ihre Anwendung ein gespeichertes Aktualisierungstoken zum Autorisieren von Anfragen verwenden. ohne den Nutzer noch einmal zu fragen.
Wenn Sie den Nutzer bereits authentifiziert haben, kann Ihre Anwendung das Aktualisierungstoken aus seiner Datenbank aus und speichern Sie das Token auf einem Sitzung. Wenn das Aktualisierungstoken widerrufen oder anderweitig ungültig ist, um entsprechende Maßnahmen zu ergreifen.
OAuth 2.0-Anmeldedaten verwenden
Sobald die OAuth 2.0-Anmeldedaten abgerufen wurden, zur Autorisierung eines Gmail-Dienstobjekts und Anfragen an die API senden.
Dienstobjekt instanziieren
Dieses Codebeispiel zeigt, wie ein Dienstobjekt instanziiert und anschließend autorisiert wird um API-Anfragen zu senden.
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)
Autorisierte Anfragen senden und auf widerrufene Anmeldedaten prüfen
Im folgenden Code-Snippet wird eine autorisierte Gmail-Dienstinstanz verwendet, um um eine Liste von Nachrichten abzurufen.
Wenn ein Fehler auftritt, sucht der Code nach dem HTTP-Statuscode 401.
Das sollte passieren, indem der Nutzer zur Autorisierung weitergeleitet wird.
URL
Weitere Gmail API-Vorgänge sind in der API-Referenz dokumentiert.
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()
Nächste Schritte
Sobald Sie mit der Autorisierung von Gmail API-Anfragen vertraut sind, können Sie mit der Verarbeitung von Nachrichten, Threads und Labels beginnen, wie in den Entwicklerleitfäden.
Weitere Informationen zu den verfügbaren API-Methoden finden Sie in der API-Referenz