[Qiita] Androidの新しいGoogleサインインAPIについて

※この記事は以前Qiitaに投稿されていた古い記事です

はじめに

GoogleがGoogle Play services 8.3をリリースした際に、その新機能の1つとして新しいGoogleサインインAPIを公開しました。
GoogleサインインをAndroidで実装するためには、以前は実装がとても面倒かつ分かりづらいものでしたが、これが簡単に実装できるようになったのが、新しいGoogleサインインAPIです。これにより、ユーザーエクスペリエンスも向上します。
この内容については以前、勉強会で発表したのですが、今回はQiita記事として書こうと思います。
基本的に以下のGoogle Play Developersの記事を参考に書いているので、より正確な情報を見たい場合にはそちらを参照してください。
Integrating Google Sign-In into Your Android App
https://developers.google.com/identity/sign-in/android/sign-in

Googleサインインとはどういうものか

だいたいこんな感じのやつです。
  1. ログインボタンを押す
    device-2015-11-16-012403.png
  2. Android端末にログインしているアカウントを選択する
    device-2015-11-16-020408.png
  3. 許可する
    device-2015-11-16-012426.png
  4. 許可されたAPIが使えたりアカウント情報が取得できる(∩´∀｀)∩
    device-2015-11-16-020451.png
  5. 許可すると、ユーザーのGoogleアカウントの「アカウントに接続されてるアプリ」から確認できるようになる
    スクリーンショット 2015-11-16 4.15.31.png

Googleサインインを使うための前提条件

  • Google Play Storeを含むAndroid 2.3以上
  • Google APIプラットフォームベースのAndroid 4.2.2以上を実行するAVD

設定ファイルを取得する

設定ファイルには、サービス固有の情報が記述されています。それを取得するためには、Google Developers Consoleから既存のプロジェクトを選択するか、新しいプロジェクトを作成する必要があります。また、アプリのパッケージ名と署名証明書のSHA-1ハッシュも必要となります。
プロジェクトが既にある場合は、以下のページから必要な項目を入力し、「google-services.json」をダウンロードします。
Enable Google services for your app
スクリーンショット 2015-11-15 2.43.09.png
ダウンロードしたら、「google-services.json」をアプリケーションのプロジェクトのappディレクトリ配下にコピーします。

Google Services pluginを追加する

  1. プロジェクトのbuild.gradleのdependenciesに以下を追記します。
    classpath 'com.google.gms:google-services:1.5.0-beta2'
  2. appのbuild.gradleに以下を追加します。
    apply plugin: 'com.google.gms.google-services'

Google Play Servicesを追加する

appのbuild.gradleのdependenciesにGoogle Play Servicesを宣言します。
compile 'com.google.android.gms:play-services-auth:8.3.0'

OAuth 2.0 client ID を作成する

アプリがバックエンドサーバで認証したり、バックエンドサーバからGoogleのAPIにアクセスする場合は、サーバー用のOAuth 2.0 client IDを作成する必要があります。
  1. 資格情報ページを開きます
  2. 資格情報を追加 > OAuth 2.0 クライアント ID
  3. ウェブアプリケーションを選択
  4. 作成
GoogleSignInOptionsオブジェクトを作成するときに、requestIdTokenまたはrequestServerAuthCodeメソッドにこのクライアントIDを渡します。

Googleサインインの実装

GoogleSignInOptionsオブジェクトを作成する

Googleサインインを実装するActivityのonCreateメソッドの中で、アプリで必要とされるユーザデータを要求するように設定します。
たとえば、ユーザーのIDと基本的なプロフィール情報を要求するためにGoogleサインインを設定するには、DEFAULT_SIGN_INパラメータでGoogleSignInOptionsオブジェクトを作成します。
同様に、ユーザーのメールアドレスを要求するには、GoogleSignInOptionsがrequestEmailオプションを指定してオブジェクトを作成します。
GoogleSignInOptions gso = new GoogleSignInOptions
    .Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
    .requestEmail()
    .build();
GoogleのAPIにアクセスするための追加のスコープを要求する必要がある場合には、requestScopeでそれらを設定します。
例えば、Google Url Shortener APIへのリクエストを要求するには以下のようになります。
mScope = new Scope("https://www.googleapis.com/auth/urlshortener");
GoogleSignInOptions gso = new GoogleSignInOptions
    .Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
    .requestScopes(mScope)
    .requestEmail()
    .build();

GoogleApiClientオブジェクトを作成する

GoogleSignInOptionsオブジェクトを作成した後、またGoogleサインインを実装するActivityのonCreateメソッドの中で、GoogleサインインAPIへのアクセスとオプションを使用してGoogleApiClientオブジェクトを作成します。
mGoogleApiClient = new GoogleApiClient.Builder(this)
    .enableAutoManage(this /* FragmentActivity */, this /* OnConnectionFailedListener */)
    .addScope(mScope)
    .addApi(Auth.GOOGLE_SIGN_IN_API, gso)
    .build();
ここで使用しているenableAutoManageメソッドの第一引数にはFragmentActivityを、第二引数にはGoogleApiClient#OnConnectionFailedListenerをActivityに実装しておく必要があります。
また、addScopeについてですが、GoogleSignInOptionsでrequestScopeせずにaddScopeするとIllegalStateExceptionで落ちますが、requestScopeが設定されていてaddScopeしなくてもrequestScopeしたAPIに問題無くアクセス許可できたので、今のところいつ設定すべきなのかがまだ分かっていません。

Googleサインインボタンを追加する

Googleサインインボタンを追加したいレイアウトにSignInButtonを追加します。
<com.google.android.gms.common.SignInButton
 android:id="@+id/sign_in_button"
 android:layout_width="wrap_content"
 android:layout_height="wrap_content" />
ActivityにView#OnClickListenerを実装し、
サインインボタンにクリックイベントをセットします。
SignInButton signInButton = (SignInButton) findViewById(R.id.sign_in_button);
signInButton.setOnClickListener(this);
このサインインボタンを使用している場合、setSizeやsetScopesメソッドによってボタンのサイズやカラースキームを変更することができます。
signInButton.setSize(SignInButton.SIZE_WIDE);
signInButton.setScopes(gso.getScopeArray());
例えば、Google+のスコープを設定している場合には、サインインボタンが赤のGoogle+ブランディングでレンダリングされます。
device-2015-11-16-020541.png

サインイン処理の実装

サインイン処理を開始するには、getSignInIntentで取得したIntentをそのままstartActivityForResultに渡してActivityを起動するだけです。
@Override
public void onClick(View v) {
    if(v.getId() == R.id.sign_in_button) {
        signIn();
    }
}

private void signIn() {
    Intent signInIntent = Auth.GoogleSignInApi.getSignInIntent(mGoogleApiClient);
    startActivityForResult(signInIntent, RC_SIGN_IN);
}
サインイン処理の開始ができたら、ActivityのonActivityResultメソッドで結果を受け取る処理を書いていきます。
結果の取得はgetSignInResultFromIntentメソッドで行い、返ってきたGoogleSignInResultから各情報を取得します。
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == RC_SIGN_IN) {
        GoogleSignInResult result = Auth.GoogleSignInApi.getSignInResultFromIntent(data);
        handleSignInResult(result);
    }
}
サインインが成功したかどうかを取得するにはisSuccessメソッドを使用します。また、サインインが成功していた場合にはgetSignInAccountメソッドでGoogleSignInAccountオブジェクトを取得し、そこからサインインしたユーザーの電子メールアドレスやユーザー名などを取得することができます。
private void handleSignInResult(GoogleSignInResult result) {
    Log.d(TAG, "handleSignInResult:" + result.isSuccess());
    if (result.isSuccess()) {
        // サインインが成功したら、サインインボタンを消して、ユーザー名を表示する
        mGoogleSignInAccount = result.getSignInAccount();
        mStatusTextView.setText("DisplayName: " + mGoogleSignInAccount.getDisplayName());
        updateUI(true);
    } else {
        // Signed out, show unauthenticated UI.
        updateUI(false);
    }
}

クロスプラットフォームシングルサインオン

ユーザーが以前に別のプラットフォーム上のアプリに許可を付与している場合、silentSignInを使用することができます。
これは、プロジェクトのクライアントが次の要件を満たすように構成されている場合、ユーザーはすぐにアプリケーションにサインインすることができます。
  • OAuth 2.0クライアントIDは、同じGoogle Developer Consoleプロジェクトでなければならない
  • OAuthのスコープは、両方のクライアントで同じでなければならない
ユーザーが以前にウェブアプリケーションでサインインしていた場合は、silentサインインが成功します。
そして、ユーザーの情報を取得し、Google APIへのアクセスに進むことができ、ユーザーが再びアプリにサインインする必要性を回避できます。

多言語対応

com.google.android.gms.common.SignInButtonは、ローカライズされた文字列を提供しており、これらは自動的に使用可能となります。どの言語に対応しているかなどを確認するためにはSDKの以下のディレクトリから確認することができます。
<android-sdk-folder>/extras/google/google_play_services/libproject/google-play-services_lib/res/. In that location, you will find directories named values-<langcode>

AuthTokenはどうやって取得するのか

AccountManagerでOAuth2認証していたときにはAccountManagerのgetAuthTokenメソッドを使用してAuthTokenを取得していました。
しかし、GoogleSignInAccountクラスにはそのようなメソッドは用意されていないので、GoogleAuthUtilクラスのgetTokenメソッドを使ってAuthTokenを取得します。具体的には以下のように取得します。
String accessToken;
try {
    accessToken = GoogleAuthUtil.getToken(
            MainActivity.this,
            new Account(mGoogleSignInAccount.getEmail(), ACCOUNT_TYPE),
            "oauth2:" + API_SCOPE
    );
    Log.d(TAG, "accessToken: " + accessToken);
} catch (IOException | GoogleAuthException e) {
    e.printStackTrace();
}
GoogleAuthUtilにはgetToken (Context context, String accountName, String scope)というメソッドも存在するのですが、リファレンスを見ると[このメソッドは非推奨となっていた](https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil.html#getToken(android.content.Context, java.lang.String, java.lang.String))ので、getToken (Context context, Account account, String scope)を使うようにしましょう。
36b8e1c1-f45e-06fb-f4b0-a8dbff77cbeb.png
AuthTokenが取得できたら、あとは以前と同じようにAPIにリクエストを投げるときにこのAuthTokenをaccess_tokenパラメータとして渡してあげることで、APIを使うことができます。

おわりに

僕が以前にGoogle+ログインを使ってGoogle Url Shortenerを使おうとした時にどうやるのか調べたら、認証方法がいくつかあって、複雑すぎてとても苦労したのでOAuthHelperなんていうものを作って簡単に実装できるようにしたのですが、このGoogleサインインAPIを使えばサインインが簡単に実装できるようになるので開発者としては実装の手間が省けて幸せになれるのかなと思いました。
以上、お疲れさまでした。

参考



コメント

コメントを投稿

人気の投稿

【Linux】Linuxでディレクトリ毎にzip圧縮する

Linuxで、ディレクトリ毎にzip圧縮したかったのだが、一発でできるようなコマンドが無かったため、ディレクトリ毎にzip圧縮するシェルスクリプトを作ってみた。 適当なファイルを作って、下記のスクリプトを書いて、ファイル名を「zip_per_directory.sh」みたいな感じにして保存する。 #! /bin/sh IFS=" " for dir in `find ./ -type d` do dir=`basename $dir` if [ $dir != `basename ./` ] then zip -r $1$dir.zip $1$dir fi done 次に、そのままだと実行できないので実行権限を与える。 $ chmod +x zip_per_directory.sh 後は、圧縮したいディレクトリが入っている場所にさっき作ったファイルを移動して、ターミナルでディレクトリを移動してから実行する。 $ cd 圧縮したいディレクトリが入ってるパス $ ./zip_per_directory.sh 実行すると、カレントディレクトリにあるディレクトリをすべて自動で圧縮してくれるので、終わるまで待つだけ。 圧縮する際にはそのディレクトリにシェルスクリプトのファイルを移動しなければならないが、ディレクトリを右クリックして圧縮するという作業を何回も繰り返すよりは楽にできるのでは無いかと思う。
続きを読む

[Qiita] Androidの実機でPCのlocalhostに接続したり、Webページの要素を検証する

イメージ
※この記事は以前Qiitaに投稿されていた古い記事です はじめに 実機でPCのlocalhostに接続したいときや、実機で見ているWebページの要素を検証したいことがあったので、その方法をメモとして書いておきます。 必要なもの Android Android 4.0以上 最新のChrome PC Chrome 32以上 Android SDK SDKが必要というよりはadbが必要なので、既にSDKが入っている場合はadbにパスを通しておくだけで良いです。 ※ Chrome拡張で「adb」というものがありますが、現在は非推奨になっているため、ここでは使いません。 Android SDKをインストールする 手元にWindowsが無いため、今回はMacの説明のみ書きます。 既にAndroid SDKが入っている場合は、この手順は必要無いです。 Android SDKをダウンロードする ここ から、自分の環境のAndroid SDKをダウンロードします。 今回はadbのみ必要なため、SDKのみのダウンロードをします。 ダウンロードしたzipを任意の場所に置き、zipを解凍する ターミナルでダウンロードしたSDKのディレクトリ配下のtoolsディレクトリを開く cd [ 任意のディレクトリ ] /android-sdk-macosx/tools android というシェルスクリプトを起動する ./android Android SDK Managerが起動するので、 Android SDK Platform-tools のみにチェックを入れて右下のinstallボタンを押す 同意してインストールする 完了したら Close を押してAndroid SDK Managerも閉じる adbにパスを通す 先ほどのインストールでplatform-toolsというディレクトリが生成されているはずなので、そこにパスを通します。 ~/.bash_profile を開く vi ~/.bash_profile 以下のようにSDKのディレクトリ配下のplatform-toolsディレクトリにパスを通す export PATH = $PATH : [ SDKのディレクト...
続きを読む

[Qiita] Google Playのクローズドベータ版テストでメールアドレスを指定して公開する

イメージ
※この記事は以前Qiitaに投稿されていた古い記事です はじめに ふと、Google Playのクローズドベータ版テストを試してみたくなって使ってみたので手順を書いてみました。 Google Playのクローズドベータ版テストについて Google Playで決まったユーザーのみにアプリをテストしてもらいたい場合、クローズドベータ版テストを使用することができます。 クローズドベータテストには以下の3種類がありますが、今回はメールアドレスを指定する方法でテストを公開してみます。 メールアドレスを指定して公開する Googleグループのユーザーに公開する Google+コミュニティのユーザーに公開する 前提条件 テスターのメールアドレスはGoogleアカウントまたはGoogle Appsアカウントであること テスト開始手順 テスターの設定 Google Play デベロッパーコンソール にログイン アプリを選択 左のメニューから[APK]を選択 タブの中央にある[ベータ版テスト]を選択 [クローズドベータ版テストを設定]を選択 [Create list]を選択 リスト名を入力(「〜事業部」や「〜チーム」など、リスト内のテスターがどのような人なのかを識別するための名前を入力する) メールアドレスを入力(以下の3通りのどれか) メールアドレスを1つずつ入力してカンマかエンターを押す カンマ区切りのメールアドレスをコピペしてエンターを押す CSVファイルをアップロードする [保存]を押す 公開したいリストにチェックを入れる 右上の[更新を送信]を押す (製品版の公開と同じく即時公開はされないため、公開されるまで少し時間がかかる) 青い枠で囲われているオプトインURLをテスターに共有する 公開したベータ版をそのまま製品版に移行するには[製品版にプロモート]を押すことで、簡単に移行できます。 APKを公開する Google Play デベロッパーコンソール にログイン アプリを選択 左のメニューから[APK]を選択 タブの中央にある[ベータ版テスト]を選択 [ベータ版に新しいAPKをアップロード]を選択 APKファイルを選択 [このバージョンの新機能]を記載...
続きを読む