सर्वर साइड ऑथराइज़ेशन लागू करें

Gmail API को किए गए अनुरोधों को OAuth 2.0 का इस्तेमाल करके अनुमति दी जानी चाहिए क्रेडेंशियल डालें. अगर आपका ऐप्लिकेशन को उपयोगकर्ता की ओर से Google API को ऐक्सेस करने की ज़रूरत होती है. उदाहरण के लिए, जब उपयोगकर्ता ऑफ़लाइन. इस तरीके को अपनाने के लिए, आपको अपने खाते से एक बार इस्तेमाल होने वाला ऑथराइज़ेशन कोड पास करना होगा अपने सर्वर को क्लाइंट से जोड़ें; इस कोड का इस्तेमाल ऐक्सेस टोकन पाने के लिए किया जाता है और अपने सर्वर के लिए टोकन रीफ़्रेश करें.

सर्वर साइड Google OAuth 2.0 को लागू करने के बारे में ज़्यादा जानने के लिए, यहां देखें वेब सर्वर ऐप्लिकेशन के लिए OAuth 2.0 का इस्तेमाल करना.

कॉन्टेंट

क्लाइंट आईडी और क्लाइंट सीक्रेट बनाना

Gmail API का इस्तेमाल शुरू करने के लिए, इस्तेमाल करें सेटअप टूल की मदद से, सेटअप टूल की मदद ली जा सकती है. Google API (एपीआई) कंसोल, एपीआई चालू करना, और क्रेडेंशियल बनाना.

1. क्रेडेंशियल पेज पर जाकर, क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी का इस्तेमाल करके, अपने OAuth 2.0 क्रेडेंशियल बनाएं या क्रेडेंशियल बनाएं > दी गई सेवा खाता कुंजी का इस्तेमाल करें.
2. अगर आपने OAuth क्लाइंट आईडी बनाया है, तो चुनें कि आपका ऐप्लिकेशन किस तरह का है.
3. फ़ॉर्म भरें और बनाएं पर क्लिक करें.

आपके ऐप्लिकेशन के क्लाइंट आईडी और सेवा खाते की कुंजियां अब यहां दी गई हैं क्रेडेंशियल पेज. ज़्यादा जानकारी के लिए, क्लाइंट आईडी पर क्लिक करें; पैरामीटर में अंतर होता है यह आईडी टाइप के आधार पर तय होता है, लेकिन इसमें ईमेल पता, क्लाइंट सीक्रेट, JavaScript ऑरिजिन या रीडायरेक्ट यूआरआई.

Client-ID को ध्यान में रखें, क्योंकि आपको बाद में इसे अपने कोड में जोड़ना होगा.

अनुमति देने के अनुरोधों को मैनेज करना

जब कोई उपयोगकर्ता पहली बार आपका ऐप्लिकेशन लोड करता है, तो उसे स्क्रीन पर यह दिखाया जाता है आपके ऐप्लिकेशन को Gmail ऐक्सेस करने की अनुमति देने के लिए डायलॉग बॉक्स अनुरोध किए गए अनुमति के दायरे वाले खाते में. इस शुरुआती के बाद की अनुमति है, तो उपयोगकर्ता को केवल अनुमति डायलॉग दिखाया जाता है, अगर आपका ऐप्लिकेशन के क्लाइंट आईडी में हुए बदलाव या अनुरोध किए गए दायरे बदल गए हैं.

उपयोगकर्ता की पुष्टि करें

यह शुरुआती साइन इन, अनुमति देने के नतीजे के लिए ऐसा ऑब्जेक्ट दिखाता है जिसमें अनुमति कोड डालें.

ऐक्सेस टोकन के लिए ऑथराइज़ेशन कोड को एक्सचेंज करें

ऑथराइज़ेशन कोड एक बार इस्तेमाल होने वाला कोड होता है, जिसे आपका सर्वर बदल सकता है ऐक्सेस टोकन. यह ऐक्सेस टोकन अनुमति देने के लिए Gmail API को भेजा जाता है सीमित समय के लिए, आपके ऐप्लिकेशन को उपयोगकर्ता के डेटा का ऐक्सेस देना.

अगर आपके ऐप्लिकेशन को offline का ऐक्सेस चाहिए, तो पहली बार आपके ऐप्लिकेशन के एक्सचेंज होने पर को अनुमति देने के लिए, उसे एक रीफ़्रेश टोकन भी मिलता है. इसका इस्तेमाल करके, वह इन कामों के लिए पिछले टोकन की समयसीमा खत्म होने पर, नया ऐक्सेस टोकन पाएं. आपका आवेदन इस रीफ़्रेश टोकन को (आम तौर पर आपके सर्वर के डेटाबेस में) के लिए सेव करता है बाद में इसका इस्तेमाल करें.

अहम जानकारी: उपयोगकर्ता के रीफ़्रेश टोकन हमेशा सेव किए जाते हैं. अगर आपके ऐप्लिकेशन को किसी नए रीफ़्रेश टोकन, इसे approval_prompt क्वेरी पैरामीटर के साथ अनुरोध भेजना होगा force पर सेट किया गया. ऐसा करने पर, उपयोगकर्ता को अनुमति देने के लिए एक डायलॉग दिखेगा को फिर से लिंक करें.

नीचे दिए गए कोड सैंपल, offline का ऐक्सेस और रीफ़्रेश टोकन को सेव करने वाला ऐक्सेस टोकन.

Python

CLIENTSECRETS_LOCATION वैल्यू को अपने client_secrets.json फ़ाइल.

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)

सेव किए गए क्रेडेंशियल से अनुमति देना

जब उपयोगकर्ता पहली बार अनुमति पाने के बाद आपके ऐप्लिकेशन पर जाते हैं फ़्लो हो, तो आपका ऐप्लिकेशन अनुरोधों को अनुमति देने के लिए, सेव किए गए रीफ़्रेश टोकन का इस्तेमाल कर सकता है उन्हें ऐसा करने की सूचना भी दी जाएगी.

अगर आपने उपयोगकर्ता को पहले ही प्रमाणित कर दिया है, तो आपका ऐप्लिकेशन जानकारी वापस पा सकता है को अपने डेटाबेस से रीफ़्रेश टोकन देता है और टोकन को सर्वर-साइड में स्टोर करता है सत्र. अगर रीफ़्रेश टोकन को रद्द कर दिया जाता है या वह अमान्य होता है, तो आपको हमें इस समस्या की जांच करके उचित कार्रवाई करनी होगी.

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 स्टेटस कोड की जांच करता है, इसे, उपयोगकर्ता को अनुमति वाले पेज पर रीडायरेक्ट करके किया जाना चाहिए यूआरएल.

एपीआई के रेफ़रंस में, Gmail API से जुड़ी ज़्यादा कार्रवाइयां की गई हैं.

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()

अगले चरण

जब आपको Gmail API अनुरोधों को अनुमति देने में कोई परेशानी न हो, तो मैसेज, थ्रेड, और लेबल को मैनेज करना शुरू करें, जैसा कि डेवलपर गाइड सेक्शन.

एपीआई के उपलब्ध तरीकों के बारे में ज़्यादा जानने के लिए, यहां जाएं: एपीआई का संदर्भ.

चेतावनी: अपने ऐप्लिकेशन की जांच करते समय डेवलपमेंट के दौरान, ऐसे परीक्षण Gmail खाते का उपयोग करना न भूलें जिसे आपने कोई फ़र्क़ नहीं पड़ता. यह आपको ग़लती से नुकसान पहुंचाने से बचाएगा आपके असली ईमेल, थ्रेड, और लेबल के साथ.