इस पेज का अनुवाद Cloud Translation API से किया गया है.

Google Data प्रोटोकॉल क्लाइंट लाइब्रेरी में ClientLogin

चेतावनी: यह पेज, Google के पुराने एपीआई यानी कि Google Data API के बारे में है. यह सिर्फ़ उन एपीआई के बारे में है जो Google Data API डायरेक्ट्री में मौजूद हैं. इनमें से कई एपीआई को नए एपीआई से बदला गया है. किसी नए एपीआई के बारे में जानकारी पाने के लिए, उस नए एपीआई के दस्तावेज़ देखें. नए एपीआई से अनुरोधों को अनुमति देने के बारे में जानकारी पाने के लिए, Google खाते की पुष्टि करना और अनुमति देना देखें.

ज़रूरी: नए ऐप्लिकेशन के लिए ClientLogin का इस्तेमाल न करें. इसके बजाय, ज़्यादा सुरक्षित OAuth पुष्टि वाला प्रोटोकॉल इस्तेमाल करें. ClientLogin, अब बहिष्कृत प्रोटोकॉल है और इसे 20 अप्रैल, 2015 को बंद कर दिया जाएगा. उस समय, ClientLogin के अनुरोधों का उत्तर नहीं दिया जाएगा. अगर आपके पास ऐसे मौजूदा ऐप्लिकेशन हैं जो ClientLogin का इस्तेमाल करते हैं, तो हमारा सुझाव है कि आप OAuth पर माइग्रेट करें. अगली बड़ी रिलीज़ में इस लाइब्रेरी से ClientLogin की सहायता हटा दी जाएगी.

यह दस्तावेज़ Google डेटा एपीआई के हर क्लाइंट लाइब्रेरी में इंस्टॉल किए गए ऐप्लिकेशन के लिए पुष्टि का इस्तेमाल करने का तरीका बताता है.

इंस्टॉल किए गए ऐसे ऐप्लिकेशन जिन्हें उपयोगकर्ता के निजी डेटा (Google या G Suite खाते से सुरक्षित) को ऐक्सेस करने की ज़रूरत होती है वे ऐसे उपयोगकर्ताओं को पुष्टि करने के लिए प्रोग्रामैटिक लॉगिन के तौर पर ClientLogin का इस्तेमाल कर सकते हैं. "इंस्टॉल किया गया ऐप्लिकेशन" वह होता है जो वेब ऐप्लिकेशन के बजाय, किसी डेस्कटॉप कंप्यूटर या सेल फ़ोन, जैसे डिवाइस पर इंस्टॉल किया जाता है.

वेब ऐप्लिकेशन बनाना है?

वेब ऐप्लिकेशन, अपनी पुष्टि के लिए ClientLogin का इस्तेमाल नहीं कर सकते. इसके बजाय, कृपया Google Data API क्लाइंट लाइब्रेरी के साथ AuthSub का इस्तेमाल करना देखें.

दर्शक

यह दस्तावेज़ उन डेवलपर के लिए है जो Google Data API क्लाइंट लाइब्रेरी का इस्तेमाल करके, Google डेटा सेवा को ऐक्सेस करने वाले ऐप्लिकेशन लिखना चाहते हैं. यह दस्तावेज़ यह मानता है कि आप ClientLogin इंटरफ़ेस से परिचित हैं. ClientLogin के प्रोटोकॉल के बारे में पूरी जानकारी पाने के लिए, इंस्टॉल किए गए ऐप्लिकेशन के लिए पुष्टि करना देखें.

Google Data API क्लाइंट लाइब्रेरी से आपके ऐप्लिकेशन में ClientLogin का इस्तेमाल करने में मदद मिलती हैं. खास तौर पर, पुष्टि करने वाला टोकन पाने, कैप्चा से जुड़ी चुनौतियों को हैंडल करने, और बाद में इस्तेमाल करने के लिए पुष्टि करने वाले टोकन को वापस लाने, और हर अनुरोध के साथ सही Authorization हेडर भेजने के कई तरीके हैं.

क्लाइंट लाइब्रेरी के बिना ClientLogin और Google Data API का इस्तेमाल करना

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

ClientLogin और Google Data API के साथ काम करना: क्लाइंट लाइब्रेरी के उदाहरण

इस सेक्शन में क्लाइंट लॉगिन दस्तावेज़ के "क्लाइंट लॉगिन इंटरफ़ेस" सेक्शन में दिए गए निर्देशों का पालन करने के लिए, Google डेटा एपीआई क्लाइंट लाइब्रेरी के इस्तेमाल के उदाहरण दिए गए हैं.

इस दस्तावेज़ में दिए गए उदाहरण, Google Calendar के साथ इंटरैक्ट करने के बारे में बताते हैं. हालांकि, उदाहरणों का पालन करने के लिए, आपको Calendar Data API के बारे में कुछ जानने की ज़रूरत नहीं है.

पुष्टि करने वाला टोकन पाना

ClientLogin का इस्तेमाल करने के लिए, आपके ऐप्लिकेशन से एचटीटीपीएस क्लाइंटलॉगिन के हैंडलर के लिए एचटीटीपीएस POST बनाया जाना चाहिए https://www.google.com/accounts/ClientLogin. POST मुख्य हिस्से को एक फ़ॉर्म पोस्ट के रूप में स्ट्रक्चर्ड किया जाना चाहिए, जिसमें डिफ़ॉल्ट एन्कोडिंग application/x-www-form-urlencoded हो. किसी क्लाइंट लाइब्रेरी का इस्तेमाल करके, कोड की एक लाइन में यह अनुरोध किया जा सकता है.

नीचे दिए गए नमूने सबसे पहले Calendar Data API से कनेक्ट करने वाले सेवा ऑब्जेक्ट को सेट अप करते हैं. इसके बाद, ClientLogin हैंडलर के लिए एचटीटीपी POST बनाते हैं.

Java

import com.google.gdata.client.*;
import com.google.gdata.client.calendar.*;

CalendarService client = new CalendarService("yourCompany-yourAppName-v1");
client.setUserCredentials("user@example.com", "pa$$word");

If you know your users will be using a G Suite account (as opposed to a Google/Gmail Account), you can streamline the login process by specifying the appropriate ClientLogin account type:

import com.google.gdata.client.*;
import com.google.gdata.client.calendar.*;

CalendarService client = new CalendarService("yourCompany-yourAppName-v1");
client.setUserCredentials("user@example.com", "pa$$word", ClientLoginAccountType.HOSTED);

.NET

using Google.GData.Client;
using Google.GData.Calendar;

CalendarService client = new CalendarService("yourCompany-yourAppName-v1");
client.setUserCredentials("user@example.com", "pa$$word");
client.QueryAuthenticationToken(); // Authenticate the user immediately

If you know your users will be using a G Suite account (as opposed to a Google/Gmail Account), you can streamline the login process by specifying the appropriate ClientLogin account type:

using Google.GData.Client;
using Google.GData.Calendar;

GDataGAuthRequestFactory authFactory = new GDataGAuthRequestFactory("cl", "yourCompany-yourAppName-v1");
authFactory.AccountType = "HOSTED";

CalendarService client = new CalendarService(authFactory.ApplicationName);
client.RequestFactory = authFactory;
client.setUserCredentials("user@example.com", "pa$$word");
client.QueryAuthenticationToken(); // Authenticate the user immediately

PHP

require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Calendar');

$serviceName = Zend_Gdata_Calendar::AUTH_SERVICE_NAME; // predefined service name ('cl') for calendar
$applicationName = 'yourCompany-yourAppName-v1';

// Create an authenticated HTTP client
$httpClient = Zend_Gdata_ClientLogin::getHttpClient('user@example.com', 'pa$$word', $serviceName, null, $applicationName);
$client = new Zend_Gdata_Calendar($httpClient, $applicationName); // Create an instance of the Calendar service

If you know your users will be using a G Suite account (as opposed to a Google/Gmail Account), you can streamline the login process by specifying the appropriate ClientLogin account type:

require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Calendar');

$serviceName = Zend_Gdata_Calendar::AUTH_SERVICE_NAME;
$applicationName = 'yourCompany-yourAppName-v1';
$accountType = 'HOSTED';

$httpClient = Zend_Gdata_ClientLogin::getHttpClient(
    'user@example.com', 'pa$$word', $serviceName, null, $applicationName, null, null, null, $accountType);
$client = new Zend_Gdata_Calendar($httpClient, $applicationName);

Python

अगर आप GDClient के आधार पर नए v2.0+ क्लास का इस्तेमाल कर रहे हैं, तो इनका इस्तेमाल करें:

import gdata.calendar.client

email = 'user@example.com'
password = 'pa$$word'
application_name = 'yourCompany-yourAppName-v1'

client = gdata.calendar.client.CalendarClient()
auth_token = client.ClientLogin(email, password,
                                application_name,
                                service='cl')

If you know your users will be using a G Suite account (as opposed to a Google/Gmail Account), you can streamline the login process by specifying the appropriate ClientLogin account type:

auth_token = client.ClientLogin(email, password,
                                application_name,
                                account_type='HOSTED',
                                service='cl')

Alternatively, if you're using the older v1.0 classes based off of GDataService, the calls are a bit different:

import gdata.calendar.service

email = 'user@example.com'
password = 'pa$$word'
application_name = 'yourCompany-yourAppName-v1'

client = gdata.calendar.service.CalendarService()
client.ClientLogin(email, password, source=application_name)

# OR, you can use ProgrammaticLogin()

client = gdata.calendar.service.CalendarService(email=email, password=password, source=application_name)
client.ProgrammaticLogin()

वर्शन 2.0 के बाद वाले वर्शन की तरह, अगर आपके उपयोगकर्ता G Suite खाते का इस्तेमाल करते हैं, तो आप सही ClientLogin खाता टाइप तय कर सकते हैं:

import gdata.calendar.service

client = gdata.calendar.service.CalendarService()
client.ClientLogin('user@example.com', 'pa$$word', account_type='HOSTED', source='yourCompany-yourAppName-v1')

See the request parameters section for a detailed explanation of each ClientLogin parameter. A complete list of available service names is available in the FAQ.

Note: By default, the client libraries set an account-type parameter to HOSTED_OR_GOOGLE. That means ClientLogin will first try to authenticate the user's credentials as a G Suite account. If that fails, it will try to authenticate as a Google Account. This becomes tricky if user@example.com is both a Google Account and a G Suite account. In that special case, set the account type to GOOGLE if the user wishes to use the Google Accounts version of user@example.com.

Once the login information has been successfully authenticated, Google returns a token, which your application will reference each time it requests access to the user's account, such as to GET or POST data. The token remains valid for a set length of time, defined by whichever Google service you're working with. Typically, tokens remain valid for 2 weeks.

Recalling an auth token

After your application has authenticated the user once, there's no need for them to input their credentials again. We recommend storing the Auth token in your database and recalling it as necessary. That will save the overhead of an additional HTTPS POST and a possible CAPTCHA challenge.

The libraries provide getters/setters for accessing the token:

Handling CAPTCHA challenges

A failure response from ClientLogin contains an error code and a URL to an error page that can be displayed to the user. If the error code is a CAPTCHA challenge, the response also includes a URL to a CAPTCHA image and a special token. Your application should be able to solicit an answer from the user and then retry the login request.

Java

String email = "user@example.com";
String password = "pa$$word";

try {
  client.setUserCredentials(email, password);
} catch (CaptchaRequiredException e) {
  System.out.println("Please visit " + e.getCaptchaUrl());
  System.out.print("Answer to the challenge? ");
  BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
  String answer = in.readLine();
  service.setUserCredentials(email, password, e.getCaptchaToken(), answer);

} catch (AuthenticationException e) {
  System.out.println(e.getMessage());
}

.NET

try
{
  client.setUserCredentials("user@example.com", "pa$$word");
  client.QueryAuthenticationToken(); // Authenticate the user immediately
}
catch (CaptchaRequiredException e)
{
  Console.WriteLine("Please visit " + e.Url);
  Console.Write("Answer to the challenge? ");
  String answer = Console.ReadLine();
  GDataGAuthRequestFactory requestFactory = (GDataGAuthRequestFactory) client.RequestFactory;
  requestFactory.CaptchaAnswer = answer;
  requestFactory.CaptchaToken = e.Token;
  client.QueryAuthenticationToken(); // authenticate the user again
}
catch (InvalidCredentialsException e)
{
  Console.WriteLine(e.Message);
}
catch (AuthenticationException e)
{
  Console.WriteLine(e.Message);
}

PHP

$email = 'user@example.com';
$password = 'pa$$word';
$serviceName = 'cl';  // 'cl' is the service name for the Calendar API
$appName = 'yourCompany-yourAppName-v1';

try {
  $httpClient = Zend_Gdata_ClientLogin::getHttpClient($email, $password, $serviceName, null, $appName);
} catch (Zend_Gdata_App_CaptchaRequiredException $e) {
  echo '<a href="' . $e->getCaptchaUrl() . '">CAPTCHA answer required to login</a>';
  $answer = 'Your answer to the challenge';
  $httpClient = Zend_Gdata_ClientLogin::getHttpClient(
      $email, $password, $serviceName, null, $appName, $e->getCaptchaToken(), $answer);

} catch (Zend_Gdata_App_AuthException $e) {
  echo 'Error: ' . $e->getMessage();
  if ($e->getResponse() != null) {
    echo 'Body: ' . $e->getResponse()->getBody();
  }
}

Python

अगर आप GDClient के आधार पर नए v2.0+ क्लास का इस्तेमाल कर रहे हैं, तो इनका इस्तेमाल करें:

import gdata.client

try:
  client.ClientLogin(email, password, application_name,
                     service='cl')
except gdata.client.CaptchaChallenge as challenge:
  print 'Please visit ' + challenge.captcha_url
  answer = raw_input('Answer to the challenge? ')
  client.ClientLogin(email, password, application_name,
                     captcha_token=challenge.captcha_token,
                     captcha_response=answer)
except gdata.client.BadAuthentication:
  exit('Users credentials were unrecognized')
except gdata.client.RequestError:
  exit('Login Error')

अगर GDataService के आधार पर पुरानी v1.0 क्लास का इस्तेमाल किया जा रहा है, तो यह थोड़ी अलग है.

import gdata.service

email = 'user@example.com'
password = 'pa$$word'
application_name = 'yourCompany-yourAppName-v1'

try:
  client.ClientLogin(email, password, source=application_name)
except gdata.service.CaptchaRequired:
  print 'Please visit ' + client.captcha_url
  answer = raw_input('Answer to the challenge? ')
  client.ClientLogin(email, password, source=application_name,
                     captcha_token=client.captcha_token,
                     captcha_response=answer)
except gdata.service.BadAuthentication:
  exit('Users credentials were unrecognized')
except gdata.service.Error:
  exit('Login Error')

कैप्चा के बारे में ज़्यादा जानकारी पाने के लिए, "इंस्टॉल किए गए ऐप्लिकेशन के लिए पुष्टि करना" दस्तावेज़ में ClientLogin रिस्पॉन्स सेक्शन देखें.

अतिरिक्त संसाधन और सैंपल

Google Data API सलाह ब्लॉग पर ClientLogin के उदाहरण
इंस्टॉल किए गए ऐप्लिकेशन के लिए पुष्टि करना

वापस सबसे ऊपर जाएं