Gmail API'ye yapılan istekler OAuth 2.0 kullanılarak yetkilendirilmelidir kimlik bilgileri. Uygulamanız çalışırken sunucu tarafı akışı Kullanıcı adına Google API'lerine erişmesi gerekir (örneğin, kullanıcı çevrimdışı. Bu yaklaşım, istemcinizi sunucunuza bağlayabilirsiniz. bu kod, erişim jetonu almak ve yenileme jetonlarını kullanabilirsiniz.
Sunucu tarafında Google OAuth 2.0 uygulaması hakkında daha fazla bilgi edinmek için Web Sunucusu Uygulamaları için OAuth 2.0'ı Kullanma.
İçindekiler
İstemci kimliği ve istemci gizli anahtarı oluşturma
Gmail API'yi kullanmaya başlamak için öncelikle kullan kurulum aracını kullanın. Bu araç, Google API Konsolu, API'yi etkinleştirme ve kimlik bilgileri oluşturma.
- Kimlik bilgileri sayfasından Kimlik bilgileri oluştur > OAuth istemcisi Kimliği'ni tıklayın veya OAuth 2.0 kimlik bilgilerinizi oluşturmak için Kimlik bilgileri oluştur > Hizmet hesap anahtarıyla oturum açın.
- OAuth istemci kimliği oluşturduysanız uygulama türünüzü seçin.
- Formu doldurun ve Oluştur'u tıklayın.
Uygulamanızın istemci kimlikleri ve hizmet hesabı anahtarları artık kimlik bilgileri sayfasını ziyaret edin. Ayrıntılar için bir istemci kimliğini tıklayın; parametreler değişiklik gösterir kimlik türüne göre değişir, ancak e-posta adresi, istemci sırrı ve JavaScript kaynakları veya yönlendirme URI'leri.
Daha sonra kodunuza eklemeniz gerekeceğinden Client-ID'yi not edin.
Yetkilendirme isteklerini işleme
Uygulamanızı ilk kez yükleyen kullanıcılara uygulamanızın Gmail'ine erişmesine izin vermek için bir iletişim kutusu hesabınızda, istenen izin kapsamlarına sahip kişiler bulunmalıdır. Bu ilk addan sonra kullanıcıya izin iletişim kutusu yalnızca istemci kimliği veya istenen kapsamlar değişmiş olabilir.
Kullanıcının kimliğini doğrulama
Bu ilk oturum açma işlemi, yetkilendirme kodunu kullanın.
Erişim jetonu için yetkilendirme kodunu değiştirin
Yetkilendirme kodu, sunucunuzun değiştirebileceği tek seferlik bir koddur. erişim jetonu bulunmalıdır. Bu erişim jetonu, veri kullanımına izin vermek için Gmail API'ye uygulamanızın sınırlı bir süre için kullanıcı verilerine erişmesine izin verir.
Uygulamanız, uygulama değişimi için ilk kez offline erişimi gerektiriyorsa
bir yenileme jetonu alır ve bu jetonu kullanmak için
yeni bir erişim jetonu alınması için bu jetonun kullanılması zorunludur. Uygulamanız
bu yenileme jetonunu (genellikle sunucunuzdaki bir veritabanında)
daha sonradan kullanabilirsiniz.
Aşağıdaki kod örnekleri,
offline erişimine sahip ve yenileme jetonunu depolayan bir erişim jetonu.
Python
CLIENTSECRETS_LOCATION değerini
client_secrets.json dosya
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)
Depolanmış kimlik bilgileriyle yetkilendirme
Kullanıcılar başarılı bir ilk yetkilendirmeden sonra uygulamanızı ziyaret ettiğinde akışına izin veriyorsanız uygulamanız, istekleri yetkilendirmek için depolanmış bir yenileme jetonunu kullanabilir kullanıcıya sormayı unutmayın.
Kullanıcının kimliğini zaten doğruladıysanız uygulamanız Yenileme jetonunu veritabanından alıp sunucu tarafında depolayarak kabul edilir. Yenileme jetonu iptal edilmişse veya başka bir şekilde geçersizse bunu yakalamalı ve uygun işlemi yapmalısınız.
OAuth 2.0 kimlik bilgilerini kullanma
OAuth 2.0 kimlik bilgileri Bu ayarlar, Gmail hizmet nesnesini yetkilendirmek için kullanılabilir. API'ye istek gönderebilirsiniz.
Hizmet nesnesini örneklendirme
Bu kod örneğinde, bir hizmet nesnesinin nasıl örneklendirileceği ve sonra nasıl yetkilendirileceği gösterilmektedir API isteklerinde bulunmasını sağlar.
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)
Yetkilendirilmiş istekler gönderme ve iptal edilen kimlik bilgilerini kontrol etme
Aşağıdaki kod snippet'i, yetkilendirilmiş bir Gmail hizmeti örneğini kullanarak bir ileti listesini alabilirsiniz.
Bir hata oluşursa kod HTTP 401 durum kodu olup olmadığını kontrol eder
Bu işlem, kullanıcıyı yetkilendirme sayfasına
URL'yi tıklayın.
Diğer Gmail API işlemleri API Referansı'nda açıklanmaktadır.
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()
Sonraki adımlar
Gmail API isteklerini kolayca yetkilendirdikten sonra, ileti dizilerini ve etiketleri aşağıdaki sayfada açıklandığı şekilde işlemeye Geliştirici Kılavuzları bölümlerini içerir.
Kullanılabilir API yöntemleri hakkında daha fazla bilgiyi API Referansı.