درخواستهای ارسالی به Gmail API باید با استفاده از اعتبارنامههای OAuth 2.0 مجاز شوند. وقتی برنامه شما نیاز به دسترسی به APIهای گوگل از طرف کاربر دارد، مثلاً وقتی کاربر آفلاین است، باید از جریان سمت سرور استفاده کنید. این رویکرد مستلزم ارسال یک کد مجوز یکبار مصرف از کلاینت به سرور شماست؛ این کد برای دریافت توکن دسترسی و توکنهای تازهسازی برای سرور شما استفاده میشود.
برای کسب اطلاعات بیشتر در مورد پیادهسازی Google OAuth 2.0 در سمت سرور، به بخش «استفاده از OAuth 2.0 برای برنامههای وب سرور» مراجعه کنید.
فهرست مطالب
ایجاد شناسه کلاینت و راز کلاینت
برای شروع استفاده از Gmail API، ابتدا باید از ابزار راهاندازی استفاده کنید که شما را در ایجاد یک پروژه در کنسول Google API و فعال کردن API راهنمایی میکند.
- از صفحه اعتبارنامهها، برای ایجاد اعتبارنامههای OAuth 2.0 خود ، روی ایجاد اعتبارنامهها > شناسه کلاینت OAuth کلیک کنید یا برای ایجاد یک حساب سرویس، روی ایجاد اعتبارنامهها > کلید حساب سرویس کلیک کنید.
- اگر یک شناسه کلاینت OAuth ایجاد کردهاید، نوع برنامه خود را انتخاب کنید.
- فرم را پر کنید و روی ایجاد کلیک کنید.
شناسههای کلاینت برنامه شما و کلیدهای حساب سرویس اکنون در صفحه اعتبارنامهها فهرست شدهاند. برای جزئیات، روی یک شناسه کلاینت کلیک کنید؛ پارامترها بسته به نوع شناسه متفاوت هستند، اما ممکن است شامل آدرس ایمیل، رمز کلاینت، ریشههای جاوا اسکریپت یا URI های تغییر مسیر باشند.
شناسه کلاینت را یادداشت کنید زیرا بعداً باید آن را به کد خود اضافه کنید.
رسیدگی به درخواستهای مجوز
وقتی کاربری برای اولین بار برنامه شما را بارگذاری میکند، با پنجرهای برای اعطای مجوز به برنامه شما جهت دسترسی به حساب جیمیل خود با محدودههای مجوز درخواستی مواجه میشود. پس از این مجوز اولیه، کاربر تنها در صورتی با پنجره مجوز مواجه میشود که شناسه کلاینت برنامه شما تغییر کند یا محدودههای درخواستی تغییر کرده باشند.
احراز هویت کاربر
این ورود اولیه، در صورت موفقیت، یک شیء نتیجه مجوز را برمیگرداند که حاوی یک کد مجوز است.
کد مجوز را با یک توکن دسترسی تعویض کنید
کد مجوز، یک کد یکبار مصرف است که سرور شما میتواند آن را با یک توکن دسترسی (access token) تعویض کند. این توکن دسترسی به API جیمیل ارسال میشود تا به برنامه شما امکان دسترسی به دادههای کاربر را برای مدت محدودی بدهد.
اگر برنامه شما نیاز به دسترسی offline داشته باشد، اولین باری که برنامه شما کد مجوز را رد و بدل میکند، یک توکن بهروزرسانی نیز دریافت میکند که پس از انقضای توکن قبلی، برای دریافت توکن دسترسی جدید از آن استفاده میکند. برنامه شما این توکن بهروزرسانی را (معمولاً در یک پایگاه داده روی سرور شما) برای استفادههای بعدی ذخیره میکند.
نمونههای کد زیر، تبادل کد مجوز برای یک توکن دسترسی با دسترسی offline و ذخیره توکن بهروزرسانی را نشان میدهند.
پایتون
مقدار 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 را نشان میدهد.
پایتون
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 مجوز، مدیریت شود.
عملیات بیشتر API جیمیل در مرجع API مستند شده است.
پایتون
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 موجود بیشتر بیاموزید.