Google ログインを Android アプリに統合するには、Google ログインを設定し、ログインフローを開始するボタンをアプリのレイアウトに追加します。
始める前に
Google API Console プロジェクトを設定し、Android Studio プロジェクトをセットアップします。
Google ログインと GoogleSignInClient オブジェクトを構成する
ログイン アクティビティの
onCreate
メソッドで、アプリに必要なユーザーデータをリクエストするように Google ログインを構成します。たとえば、ユーザー ID と基本的なプロフィール情報をリクエストするように Google ログインを構成するには、DEFAULT_SIGN_IN
パラメータを含むGoogleSignInOptions
オブジェクトを作成します。ユーザーのメールアドレスもリクエストするには、requestEmail
オプションを指定してGoogleSignInOptions
オブジェクトを作成します。// Configure sign-in to request the user's ID, email address, and basic // profile. ID and basic profile are included in DEFAULT_SIGN_IN. GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN) .requestEmail() .build();
Google API にアクセスするために追加のスコープをリクエストする必要がある場合は、
requestScopes
を使用して指定します。最適なユーザー エクスペリエンスを実現するには、ログイン時に、アプリの最小限の機能に必要なスコープのみをリクエストします。必要な場合にのみ追加のスコープをリクエストして、ユーザーが行った操作のコンテキストで同意画面が表示されるようにします。スコープの追加リクエストをご覧ください。次に、ログイン アクティビティの
onCreate
メソッドでも、指定したオプションを使用してGoogleSignInClient
オブジェクトを作成します。// Build a GoogleSignInClient with the options specified by gso. mGoogleSignInClient = GoogleSignIn.getClient(this, gso);
すでにログインしているユーザーを確認する
アクティビティの onStart
メソッドで、ユーザーがすでに Google でアプリにログインしたかどうかを確認します。
// Check for existing Google Sign In account, if the user is already signed in // the GoogleSignInAccount will be non-null. GoogleSignInAccount account = GoogleSignIn.getLastSignedInAccount(this); updateUI(account);
GoogleSignIn.getLastSignedInAccount
が null
ではなく GoogleSignInAccount
オブジェクトを返した場合、ユーザーはすでに Google でアプリにログインしています。UI を適宜更新します。つまり、ログインボタンを非表示にする、メイン アクティビティを起動するなど、アプリに適した内容を更新します。
GoogleSignIn.getLastSignedInAccount
が null
を返した場合、ユーザーはまだ Google でアプリにログインしていません。UI を更新して [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" />
省略可: 独自のログインボタンのアセットを提供するのではなく、デフォルトのログインボタンのグラフィックを使用している場合は、
setSize
メソッドを使用してボタンのサイズをカスタマイズできます。// Set the dimensions of the sign-in button. SignInButton signInButton = findViewById(R.id.sign_in_button); signInButton.setSize(SignInButton.SIZE_STANDARD);
Android のアクティビティ(
onCreate
メソッド内のアクティビティなど)で、ボタンのOnClickListener
を登録して、クリックされたときにユーザーがログインできるようにします。findViewById(R.id.sign_in_button).setOnClickListener(this);
ログインフローを開始する
アクティビティの
onClick
メソッドで、getSignInIntent
メソッドでログイン インテントを作成し、startActivityForResult
でインテントを開始することで、ログインボタンのタップを処理します。@Override public void onClick(View v) { switch (v.getId()) { case R.id.sign_in_button: signIn(); break; // ... } }
private void signIn() { Intent signInIntent = mGoogleSignInClient.getSignInIntent(); startActivityForResult(signInIntent, RC_SIGN_IN); }
インテントを開始すると、ログインに使用する Google アカウントを選択するよう求められます。
profile
、email
、openid
を超えるスコープをリクエストした場合、ユーザーはリクエストされたリソースへのアクセス権を付与するよう求められます。ユーザーがログインした後、アクティビティの
onActivityResult
メソッドでユーザーのGoogleSignInAccount
オブジェクトを取得できます。@Override public void onActivityResult(int requestCode, int resultCode, Intent data) { super.onActivityResult(requestCode, resultCode, data); // Result returned from launching the Intent from GoogleSignInClient.getSignInIntent(...); if (requestCode == RC_SIGN_IN) { // The Task returned from this call is always completed, no need to attach // a listener. Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data); handleSignInResult(task); } }
GoogleSignInAccount
オブジェクトには、ユーザー名など、ログインしているユーザーに関する情報が含まれます。private void handleSignInResult(Task<GoogleSignInAccount> completedTask) { try { GoogleSignInAccount account = completedTask.getResult(ApiException.class); // Signed in successfully, show authenticated UI. updateUI(account); } catch (ApiException e) { // The ApiException status code indicates the detailed failure reason. // Please refer to the GoogleSignInStatusCodes class reference for more information. Log.w(TAG, "signInResult:failed code=" + e.getStatusCode()); updateUI(null); } }
getEmail
でユーザーのメールアドレス、getId
でユーザーの Google ID(クライアントサイドで使用する場合)、getIdToken
でユーザーの ID トークンを取得することもできます。現在ログインしているユーザーをバックエンド サーバーに渡す必要がある場合は、ID トークンをバックエンド サーバーに送信し、サーバーでトークンを検証します。