Google Data Protocol クライアントライブラリの ClientLogin

警告: このページでは、Google の古い API である Google Data APIs について説明します。このページは、Google Data APIs ディレクトリに記載されている API にのみ関連しています。これらの API の多くは、新しい API に置き換えられています。特定の新しい API については、その API のドキュメントをご覧ください。新しい API でリクエストを承認する方法については、Google アカウントの認証と認可をご覧ください。

重要: 新しいアプリケーションには ClientLogin を使用しないでください。代わりに、より安全な OAuth 認証プロトコルを使用してください。ClientLogin は非推奨の認証プロトコルであり、2015 年 4 月 20 日に廃止されます。その時点で、ClientLogin リクエストへの応答は停止されます。ClientLogin を使用する既存のアプリケーションがある場合は、OAuth への移行をおすすめします。このライブラリの ClientLogin のサポートは、次回のメジャーリリースで削除されます。

このドキュメントでは、各 Google Data API クライアントライブラリ内で Google のインストール済みアプリケーションの認証を使用する方法について説明します。

ユーザーのプライベートデータ（Google アカウントまたは G Suite アカウントで保護されている）にアクセスする必要があるインストール済みアプリケーションは、ユーザーを認証するプログラムによる手段として ClientLogin を使用できます。「インストール済みアプリケーション」とは、ウェブアプリケーションとは異なり、デスクトップパソコンや携帯電話などのデバイスにインストールされているアプリケーションのことです。

ウェブアプリケーションを構築する場合

ウェブアプリケーションで ClientLogin を認証方法として使用することは推奨されません。代わりに、Google Data API クライアントライブラリで AuthSub を使用するをご覧ください。

オーディエンス

このドキュメントは、Google Data APIs クライアントライブラリを使用して Google Data サービスにアクセスするアプリケーションを作成するデベロッパーを対象としています。このドキュメントは、ClientLogin インターフェースに精通していることを前提としています。ClientLogin のプロトコルの詳細については、インストール済みアプリケーションの認証をご覧ください。

Google Data API クライアントライブラリには、アプリケーションで ClientLogin を使用するのに役立つメソッドが用意されています。具体的には、認証トークンの取得、CAPTCHA チャレンジの処理、後で使用するための認証トークンの呼び出し、すべてのリクエストで正しい Authorization ヘッダーの送信を行うメソッドがあります。

クライアントライブラリを使用せずに ClientLogin と Google Data API を使用する

クライアントライブラリは、アプリケーションで ClientLogin を使用する唯一の方法ではありません。必要な情報はすべて、ClientLogin のドキュメントのインストール済みアプリケーションの認証に記載されています。ただし、クライアントライブラリには、Google Data アプリケーションで ClientLogin を利用するのに役立つメソッドが用意されています。

ClientLogin と Google Data API の使用: クライアントライブラリの例

このセクションでは、Google Data APIs クライアントライブラリを使用して、ClientLogin ドキュメントの「ClientLogin インターフェース」セクションで説明されている手順を行う例を示します。

このドキュメントの例では、Google カレンダーとのやり取りを示しています（例を理解するために Calendar Data API について知っておく必要はありません）。

認証トークンの取得

ClientLogin を使用するには、アプリケーションでハンドラ ClientLogin のハンドラ https://www.google.com/accounts/ClientLogin に HTTPS POST を行う必要があります。POST 本文は、デフォルトのエンコード application/x-www-form-urlencoded を使用したフォーム投稿として構造化する必要があります。クライアントライブラリのいずれかを使用すると、このリクエストを 1 行のコードで作成できます。

次のサンプルでは、まず Calendar Data API に接続するサービスオブジェクトを設定し、次に ClientLogin ハンドラに HTTP 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()

v2.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:

Java

String token = '12345abcde'; // TODO: Read user's token from your database
client.setUserToken(token);

UserToken auth_token = (UserToken) client.getAuthTokenFactory().getAuthToken();
token = auth_token.getValue(); // token is '12345abcde'

.NET

String token = '12345abcde'; // TODO: Read user's token from your database
client.SetAuthenticationToken(token);

GDataGAuthRequestFactory requestFactory = (GDataGAuthRequestFactory) client.RequestFactory;
token = requestFactory.GAuthToken;  // token is '12345abcde'

PHP

$token = '12345abcde'; // TODO: Read user's token from your database
$client->getHttpClient()->setClientLoginToken($token);

$token = $client->getHttpClient()->getClientLoginToken(); // $token is '12345abcde'

Python

If you're using the newer v2.0+ classes based off of GDClient, use:

import gdata.gauth

token = '12345abcde'  # TODO: Read user's token from your database
client.auth_token = gdata.gauth.ClientLoginToken(token)

token = client.auth_token.token_string  # token is '12345abcde'

If you're using the older v1.0 classes based off of GDataService, the process is a bit different.

token = '12345abcde'  # TODO: Read user's token from your database
client.SetClientLoginToken(token)

token = client.GetClientLoginToken()  # token is '12345abcde'

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

CAPTCHA の詳細については、「インストール済みアプリケーションの認証」のドキュメントの ClientLogin レスポンスのセクションをご覧ください。

その他のリソースとサンプル

Google Data API Tips ブログの ClientLogin の例
インストール済みアプリケーションの認証

トップへ戻る

Google Data Protocol クライアント ライブラリの ClientLogin コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

ウェブ アプリケーションを構築する場合

オーディエンス

クライアント ライブラリを使用せずに ClientLogin と Google Data API を使用する

ClientLogin と Google Data API の使用: クライアント ライブラリの例

認証トークンの取得

Java

.NET

PHP

Python

Recalling an auth token

Java

.NET

PHP

Python

Handling CAPTCHA challenges

Java

.NET

PHP

Python

その他のリソースとサンプル

Google Data Protocol クライアントライブラリの ClientLogin

ウェブアプリケーションを構築する場合

クライアントライブラリを使用せずに ClientLogin と Google Data API を使用する

ClientLogin と Google Data API の使用: クライアントライブラリの例