يجب السماح بالطلبات الموجّهة إلى Gmail API باستخدام بيانات اعتماد OAuth 2.0. يجب استخدام عملية الخادم عندما يحتاج تطبيقك إلى الوصول إلى واجهات Google APIs نيابةً عن المستخدم، مثلاً عندما يكون المستخدم غير متصل بالإنترنت. يتطلّب هذا الأسلوب إرسال رمز تفويض صالح لمرة واحدة من تطبيقك إلى الخادم، ويُستخدَم هذا الرمز للحصول على رمز دخول ورموز مميزة لإعادة التحميل للخادم.
لمزيد من المعلومات حول تنفيذ Google OAuth 2.0 من جهة الخادم، يُرجى الاطّلاع على استخدام OAuth 2.0 لتطبيقات خادم الويب.
المحتويات
إنشاء معرّف عميل وسر عميل
لبدء استخدام Gmail API، عليك أولاً استخدام أداة الإعداد التي تقدّم لك إرشادات خلال عملية إنشاء المشروع في وحدة التحكم في Google API وتفعيل واجهة برمجة التطبيقات وإنشاء بيانات الاعتماد.
- من صفحة "بيانات الاعتماد" (Credentials)، انقر على إنشاء بيانات اعتماد > معرّف عميل OAuth لإنشاء بيانات اعتماد OAuth 2.0 أو على إنشاء بيانات اعتماد > مفتاح حساب الخدمة لإنشاء حساب خدمة.
- إذا أنشأت معرّف عميل OAuth، اختَر نوع تطبيقك.
- املأ النموذج وانقر على إنشاء.
تظهر الآن معرّفات العملاء ومفاتيح حسابات الخدمة الخاصة بتطبيقك في صفحة "بيانات الاعتماد". للاطّلاع على التفاصيل، انقر على معرّف عميل. تختلف المَعلمات حسب نوع المعرّف، ولكن قد تتضمّن عنوان البريد الإلكتروني أو سر العميل أو مصادر JavaScript أو معرّفات الموارد المنتظمة (URI) لإعادة التوجيه.
دوِّن معرّف العميل لأنّك ستحتاج إلى إضافته إلى الرمز البرمجي لاحقًا.
التعامل مع طلبات التفويض
عندما يحمّل المستخدم تطبيقك لأول مرة، سيظهر له مربع حوار يطلب منه منح تطبيقك الإذن بالوصول إلى حسابه على Gmail باستخدام نطاقات الأذونات المطلوبة. بعد منح الإذن الأوّلي، لن يظهر للمستخدم مربّع حوار الأذونات إلا إذا تغيّر معرّف العميل لتطبيقك أو تغيّرت النطاقات المطلوبة.
مصادقة المستخدم
تعرض عملية تسجيل الدخول الأولية هذه عنصر نتيجة تفويض يحتوي على رمز تفويض في حال نجاحها.
تبديل رمز التفويض برمز دخول
رمز التفويض هو رمز يُستخدَم لمرة واحدة ويمكن لخادمك استبداله بـ رمز دخول. يتم تمرير رمز الدخول هذا إلى 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 وإرسال طلبات إلى واجهة برمجة التطبيقات.
إنشاء مثيل لكائن خدمة
يوضّح نموذج الرمز البرمجي هذا كيفية إنشاء عنصر خدمة ثم منحه الإذن بإجراء طلبات إلى واجهة برمجة التطبيقات.
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 من أجل استرداد قائمة بالرسائل.
في حال حدوث خطأ، يتحقّق الرمز من رمز الحالة 401 لبروتوكول HTTP،
والذي يجب التعامل معه من خلال إعادة توجيه المستخدم إلى عنوان URL الخاص بالتفويض.
يمكنك الاطّلاع على المزيد من عمليات Gmail 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، ستكون جاهزًا لبدء التعامل مع الرسائل وسلاسل المحادثات والتصنيفات، كما هو موضّح في أقسام "أدلة المطوّرين".
يمكنك الاطّلاع على مزيد من المعلومات عن طرق واجهة برمجة التطبيقات المتاحة في مرجع واجهة برمجة التطبيقات.