צריך לאשר בקשות ל-Gmail API באמצעות פרטי כניסה של OAuth 2.0. כדאי להשתמש בתהליך בצד השרת כשהאפליקציה צריכה לגשת ל-Google APIs מטעם המשתמש, למשל כשהמשתמש לא מחובר לאינטרנט. בגישה הזו צריך להעביר קוד הרשאה חד-פעמי מהלקוח לשרת. הקוד הזה משמש לקבלת טוקן גישה וטוקנים לרענון עבור השרת.
מידע נוסף על הטמעה של Google OAuth 2.0 בצד השרת זמין במאמר שימוש ב-OAuth 2.0 לאפליקציות של שרת אינטרנט.
תוכן עניינים
יצירת מזהה לקוח וסוד לקוח
כדי להתחיל להשתמש ב-Gmail API, קודם צריך להשתמש בכלי ההגדרה, שמדריך אתכם בתהליך של יצירת פרויקט ב-Google API Console, הפעלת ה-API ויצירת פרטי כניסה.
- בדף Credentials (פרטי כניסה), לוחצים על Create credentials > OAuth client ID (יצירת פרטי כניסה > מזהה לקוח OAuth) כדי ליצור פרטי כניסה מסוג OAuth 2.0, או על Create credentials > Service account key (יצירת פרטי כניסה > מפתח לחשבון שירות) כדי ליצור חשבון שירות.
- אם יצרתם מזהה לקוח ב-OAuth, בוחרים את סוג האפליקציה.
- ממלאים את הטופס ולוחצים על יצירה.
מזהי הלקוח ומפתחות חשבון השירות של האפליקציה מופיעים עכשיו בדף Credentials (פרטי כניסה). כדי לראות פרטים, לוחצים על מזהה לקוח. הפרמטרים משתנים בהתאם לסוג המזהה, אבל יכולים לכלול כתובת אימייל, סוד לקוח, מקורות JavaScript או כתובות URI להפניה אוטומטית.
חשוב לשים לב למספר הלקוח, כי תצטרכו להוסיף אותו לקוד מאוחר יותר.
טיפול בבקשות הרשאה
כשמשתמש טוען את האפליקציה שלכם בפעם הראשונה, מוצג לו דו-שיח שבו הוא מתבקש להעניק לאפליקציה הרשאה לגשת לחשבון Gmail שלו עם היקפי ההרשאות המבוקשים. אחרי האישור הראשוני הזה, תיבת הדו-שיח של ההרשאות תוצג למשתמש רק אם Client-ID של האפליקציה ישתנה או אם ההיקפים המבוקשים ישתנו.
אימות המשתמש
אם הכניסה הראשונית מצליחה, היא מחזירה אובייקט של תוצאת הרשאה שמכיל קוד הרשאה.
המרת קוד ההרשאה לטוקן גישה
קוד ההרשאה הוא קוד חד-פעמי שהשרת יכול להחליף באסימון גישה. אסימון הגישה הזה מועבר אל Gmail API כדי להעניק לאפליקציה שלכם גישה לנתוני המשתמשים למשך זמן מוגבל.
אם האפליקציה שלכם דורשת גישה ל-offline, בפעם הראשונה שהאפליקציה מחליפה את קוד ההרשאה, היא מקבלת גם אסימון רענון שמשמש אותה לקבלת אסימון גישה חדש אחרי שאסימון קודם פג תוקפו. האפליקציה שלכם מאחסנת את אסימון הרענון הזה (בדרך כלל במסד נתונים בשרת) לשימוש מאוחר יותר.
בדוגמאות הקוד הבאות מוצג תהליך ההחלפה של קוד הרשאה באסימון גישה עם גישה ל-offline ואחסון של אסימון הרענון.
Python
מחליפים את הערך 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.
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 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()
השלבים הבאים
אחרי שתהיו בטוחים שאתם יודעים איך לאשר בקשות ל-Gmail API, תוכלו להתחיל לטפל בהודעות, בשרשורים ובתויות, כמו שמתואר בקטעים של מדריכי המפתחים.
מידע נוסף על שיטות ה-API הזמינות אפשר למצוא בהפניית ה-API.