Gmail API'ye gönderilen istekler, OAuth 2.0 kimlik bilgileri kullanılarak yetkilendirilmelidir. Uygulamanızın kullanıcı adına Google API'lerine erişmesi gerektiğinde (ör. kullanıcı çevrimdışıyken) sunucu tarafı akışını kullanmanız gerekir. Bu yaklaşımda, istemcinizden sunucunuza tek seferlik bir yetkilendirme kodu gönderilmesi gerekir. Bu kod, sunucunuz için erişim jetonu ve yenileme jetonu almak amacıyla kullanılır.
Sunucu tarafı Google OAuth 2.0 uygulaması hakkında daha fazla bilgi edinmek için Web Sunucusu Uygulamaları için OAuth 2.0'ı Kullanma başlıklı makaleyi inceleyin.
İçindekiler
İstemci kimliği ve istemci gizli anahtarı oluşturma
Gmail API'yi kullanmaya başlamak için önce kurulum aracını kullanmanız gerekir. Bu araç, Google API Konsolu'nda proje oluşturma, API'yi etkinleştirme ve kimlik bilgileri oluşturma konusunda size rehberlik eder.
- Kimlik Bilgileri sayfasında, OAuth 2.0 kimlik bilgilerinizi oluşturmak için Kimlik bilgisi oluştur > OAuth istemci kimliği'ni veya hizmet hesabı oluşturmak için Kimlik bilgisi oluştur > Hizmet hesabı anahtarı'nı tıklayın.
- OAuth istemci kimliği oluşturduysanız uygulama türünüzü seçin.
- Formu doldurup Oluştur'u tıklayın.
Uygulamanızın istemci kimlikleri ve hizmet hesabı anahtarları artık Kimlik Bilgileri sayfasında listelenir. Ayrıntılar için bir istemci kimliğini tıklayın. Parametreler kimlik türüne göre değişir ancak e-posta adresi, istemci gizlisi, JavaScript kaynakları veya yönlendirme URI'lerini içerebilir.
Daha sonra kodunuza eklemeniz gerekeceği için istemci kimliğini not edin.
Yetkilendirme isteklerini işleme
Bir kullanıcı uygulamanızı ilk kez yüklediğinde, istenen izin kapsamlarıyla uygulamanızın Gmail hesabına erişmesine izin vermesi için bir iletişim kutusu gösterilir. Bu ilk yetkilendirmeden sonra kullanıcıya yalnızca uygulamanızın istemci kimliği veya istenen kapsamlar değişirse izin iletişim kutusu gösterilir.
Kullanıcının kimliğini doğrulama
Bu ilk oturum açma işlemi, başarılı olursa yetkilendirme kodu içeren bir yetkilendirme sonucu nesnesi döndürür.
Yetkilendirme kodunu erişim jetonuyla değiştirme
Yetkilendirme kodu, sunucunuzun erişim jetonuyla değiştirebileceği tek kullanımlık bir koddur. Bu erişim jetonu, uygulamanıza sınırlı bir süre boyunca kullanıcı verilerine erişim izni vermek için Gmail API'ye iletilir.
Uygulamanız offline erişimi gerektiriyorsa uygulamanız, yetkilendirme kodunu ilk kez değiştirdiğinde önceki jetonun süresi dolduktan sonra yeni bir erişim jetonu almak için kullandığı bir yenileme jetonu da alır. Uygulamanız bu yenileme jetonunu daha sonra kullanmak üzere (genellikle sunucunuzdaki bir veritabanında) depolar.
Aşağıdaki kod örnekleri, bir yetkilendirme kodunun offline erişimi olan bir erişim jetonuyla değiştirilmesini ve yenileme jetonunun saklanmasını göstermektedir.
CLIENTSECRETS_LOCATION değerini client_secrets.json dosyanızın konumuyla değiştirin.
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)
Depolanan kimlik bilgileriyle yetkilendirme
Kullanıcılar ilk kez başarılı bir yetkilendirme akışı gerçekleştirdikten sonra uygulamanızı ziyaret ettiğinde uygulamanız, kullanıcıdan tekrar istemde bulunmadan istekleri yetkilendirmek için depolanan bir yenileme jetonu kullanabilir.
Kullanıcının kimliğini zaten doğruladıysanız uygulamanız yenileme jetonunu veritabanından alıp sunucu tarafı oturumunda saklayabilir. Yenileme jetonu iptal edilirse veya başka bir şekilde geçersizse bunu yakalamanız ve uygun işlemi yapmanız gerekir.
OAuth 2.0 kimlik bilgilerini kullanma
OAuth 2.0 kimlik bilgileri önceki bölümde gösterildiği gibi alındıktan sonra bir Gmail hizmet nesnesini yetkilendirmek ve API'ye istek göndermek için kullanılabilir.
Hizmet nesnesi oluşturma
Bu kod örneğinde, bir hizmet nesnesinin nasıl oluşturulacağı ve ardından API isteği göndermesi için nasıl yetkilendirileceği gösterilmektedir.
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)
Yetkili istekler gönderme ve iptal edilen kimlik bilgilerini kontrol etme
Aşağıdaki kod snippet'i, iletilerin listesini almak için yetkili bir Gmail hizmet örneği kullanır.
Hata oluşursa kod, HTTP 401 durum kodu olup olmadığını kontrol eder. Bu durum kodu, kullanıcıyı yetkilendirme URL'sine yönlendirerek ele alınmalıdır.
Diğer Gmail API işlemleri API Referansı'nda açıklanmıştır.
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()
Sonraki adımlar
Gmail API isteklerine yetki vermeyi öğrendikten sonra, Geliştirici Kılavuzları bölümlerinde açıklandığı gibi iletileri, ileti dizilerini ve etiketleri işlemeye başlayabilirsiniz.
Kullanılabilir API yöntemleri hakkında daha fazla bilgiyi API Referansı'nda bulabilirsiniz.