Żądania wysyłane do interfejsu Gmail API muszą być autoryzowane przy użyciu danych logowania OAuth 2.0. Z przepływu po stronie serwera należy korzystać, gdy aplikacja musi uzyskać dostęp do interfejsów API Google w imieniu użytkownika, na przykład gdy jest on offline. Ta metoda wymaga przekazania jednorazowego kodu autoryzacji z klienta na serwer. Służy on do uzyskania tokena dostępu i tokenów odświeżania dla serwera.
Więcej informacji o implementacji Google OAuth 2.0 po stronie serwera znajdziesz w tym artykule.
Spis treści
Tworzenie identyfikatora klienta i tajnego klucza klienta
Aby rozpocząć korzystanie z interfejsu Gmail API, musisz najpierw użyć narzędzia do konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w konsoli interfejsów API Google, włączania interfejsu API i tworzenia danych logowania.
- Na stronie Dane logowania kliknij Utwórz dane logowania > Identyfikator klienta OAuth, aby utworzyć dane logowania OAuth 2.0, lub Utwórz dane logowania > Klucz konta usługi, aby utworzyć konto usługi.
- Jeśli masz utworzony identyfikator klienta OAuth, wybierz typ aplikacji.
- Wypełnij formularz i kliknij Utwórz.
Identyfikatory klienta aplikacji i klucze konta usługi są teraz wymienione na stronie Dane logowania. Aby uzyskać szczegółowe informacje, kliknij identyfikator klienta. Parametry różnią się w zależności od typu identyfikatora, ale mogą obejmować adres e-mail, tajny klucz klienta, źródła JavaScript lub identyfikatory URI przekierowania.
Zanotuj identyfikator klienta, ponieważ później trzeba będzie go dodać do kodu.
Obsługa żądań autoryzacji
Gdy użytkownik wczyta aplikację po raz pierwszy, zobaczy okno z prośbą o przyznanie aplikacji uprawnień dostępu do konta Gmail z żądanymi zakresami uprawnień. Po tej wstępnej autoryzacji użytkownik zobaczy okno uprawnień tylko w przypadku zmiany identyfikatora klienta aplikacji lub zmiany żądanych zakresów.
Uwierzytelnienie użytkownika
W przypadku powodzenia tego początkowego logowania zwracany jest obiekt wyniku autoryzacji, który zawiera kod autoryzacji.
Wymiana kodu autoryzacji na token dostępu
Kod autoryzacji to jednorazowy kod, który Twój serwer może wymienić na token dostępu. Token dostępu jest przekazywany do interfejsu Gmail API, aby przyznać aplikacji dostęp do danych użytkownika na ograniczony czas.
Jeśli Twoja aplikacja wymaga dostępu do offline, przy pierwszej wymianie kodu autoryzacji aplikacja otrzyma token odświeżania, który służy do uzyskania nowego tokena dostępu po wygaśnięciu poprzedniego. Aplikacja przechowuje ten token odświeżania (zwykle w bazie danych na serwerze) do późniejszego użycia.
Poniższe przykłady kodu pokazują wymianę kodu autoryzacji na token dostępu z dostępem offline i zapisanie tokena odświeżania.
Python
Zastąp wartość CLIENTSECRETS_LOCATION lokalizacją pliku 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)
Autoryzacja przy użyciu zapisanych danych logowania
Gdy użytkownicy odwiedzają Twoją aplikację po udanym procesie autoryzacji po raz pierwszy, może ona użyć zapisanego tokena odświeżania do autoryzacji żądań bez pytania użytkownika o ponowne wyświetlenie.
Jeśli użytkownik został już uwierzytelniony, aplikacja może pobrać token odświeżania ze swojej bazy danych i zapisać go w sesji po stronie serwera. Jeśli token odświeżania zostanie unieważniony lub będzie nieprawidłowy z innego powodu, musisz to wykryć i podjąć odpowiednie działania.
Korzystanie z danych uwierzytelniających OAuth 2.0
Po pobraniu danych logowania OAuth 2.0, tak jak w poprzedniej sekcji, można ich użyć do autoryzowania obiektu usługi Gmail i wysyłania żądań do interfejsu API.
Tworzenie wystąpienia obiektu usługi
Ten przykładowy kod pokazuje, jak utworzyć instancję obiektu usługi, a następnie autoryzować go do wysyłania żądań do interfejsu 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)
Wysyłanie autoryzowanych żądań i sprawdzanie unieważnionych danych logowania
Ten fragment kodu pobiera listę wiadomości za pomocą instancji usługi autoryzowanej usługi Gmail.
Jeśli wystąpi błąd, kod sprawdza, czy w kodzie HTML znajduje się kod stanu HTTP 401, który powinien zostać przekierowany na adres URL autoryzacji.
Więcej operacji w interfejsie Gmail API znajdziesz w dokumentacji interfejsu 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()
Dalsze kroki
Gdy już nauczysz się autoryzować żądania do interfejsu Gmail API, możesz zacząć obsługiwać wiadomości, wątki i etykiety zgodnie z opisem w sekcjach przewodników dla programistów.
Więcej informacji o dostępnych metodach interfejsu API znajdziesz w dokumentacji API.