AndroidのAccountManager経由でGoogleのOAuth2認証を行うには？（外部ライブラリ完全非依存版）

以前にAndroidでOAuth2認証をする方法については書いたことがある。ただし、WebView経由だった。

琴線探査: AndroidでGoogleのOAuth2認証を行うには？（外部ライブラリ完全非依存版）

WebView経由では必ずユーザーにIDとパスワードを入力してもらう必要があるが、AccountManager経由だとすでにアカウント情報が端末に入力してあるなら入力してもらう必要がなくなる。

ただ、AccountManager経由のOAuth2は必ずしもユーザーフレンドリーとは言えない部分がある。

琴線探査: Androidのアカウントマネージャー経由のOAuth2は本当にユーザーフレンドリーなのか？
琴線探査: AndroidのAccountManagerを使ったOAuth2認証は何だか怪しい

しかし、多くのユーザーにとってはアカウント情報の入力を省いてくれる方がユーザーフレンドリーと言えるのかもしれないと思った。そこで今度はAccountManager経由で行う方法をまとめてみようと思う。

このようなテストアプリを作った。


Eclipseプロジェクトファイル：AccountManagerOAuth2.zip (694KB)

多くの処理はtasks-android-sampleを参考にした。

プログラミングに入る前にAndroidManifest.xmlでパーミッションを設定しておかなければならない。

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.MANAGE_ACCOUNTS" />
<uses-permission android:name="android.permission.USE_CREDENTIALS" />

これらのパーミッションは全て必要だ。

まずは「ユーザー情報取得」ボタンをクリックする。するとonClickBtnUserInfo()が呼び出される。

protected static final String AUTH_TOKEN_TYPE_PROFILE = "oauth2:https://www.googleapis.com/auth/userinfo.profile";
  public void onClickBtnUserInfo(View view) {
    Log.v("onClickBtnUserInfo", "ユーザー情報取得ボタンクリック");
    startRequest(AUTH_TOKEN_TYPE_PROFILE);
  }

AUTH_TOKEN_TYPE_PROFILEはGoogleのユーザー情報を取得するためのAPIのURLだ。このメソッドによりstartRequest()が呼び出される。

protected void startRequest(String authTokenType) {
    Log.v("startRequest", "リクエスト開始 - リクエスト先:" + authTokenType);
    this.authTokenType = authTokenType;
    if (accountName == null) {
      Log.v("startRequest", "アカウントが選択されていない");
      chooseAccount();
    } else {
      getAuthToken();
    }
  }

起動直後はaccountNameはnullなのでchooseAccount()が呼び出される。

protected static final String ACCOUNT_TYPE = "com.google";
  protected void chooseAccount() {
    Log.v("chooseAccount", "AuthToken取得開始（アカウント選択）");
    accountManager.getAuthTokenByFeatures(ACCOUNT_TYPE, authTokenType, null, AccountManagerOAuth2Activity.this, null, null,
        new AccountManagerCallback() {
          public void run(AccountManagerFuture future) {
            onGetAuthToken(future);
          }
        },
        null);
  }

accountManager.getAuthTokenByFeatures()は端末に入力されているアカウント数によって異なる動作をする。一連の画面はアプリではなくOSが用意する画面だ。

アカウントがゼロなら、アカウントを作成する画面になる。アカウントを作成した後、アクセス許可画面に誘導される。


アカウントが１つなら、選択画面が出ずに、すぐアクセス許可画面が表示される。

アクセス許可画面

ここで問題なのは、URLがそのまま出てしまっていること。ICS以降だと分かりやすい説明が出る場合もあるようだけど、それ以前のOSでは諦めるしかないようだ。

アカウントが２つ以上なら、アカウントを選択する画面になって、選択するとアクセス許可画面が表示される。



アクセス許可画面でAllowかDenyをするとonGetAuthToken()が呼び出される。

protected void onGetAuthToken(AccountManagerFuture<Bundle> future) {
    try {
      Bundle bundle = future.getResult();
      accountName = bundle.getString(AccountManager.KEY_ACCOUNT_NAME);
      authToken = bundle.getString(AccountManager.KEY_AUTHTOKEN);
      Log.v("onGetAuthToken", "AuthToken取得完了 accountName=" + accountName + " authToken=" + authToken + " authTokenType=" + authTokenType);
      if (authTokenType.equals(AUTH_TOKEN_TYPE_PROFILE)) {
        getUserInfo(); //ユーザー情報取得開始
      } else if (authTokenType.equals(AUTH_TOKEN_TYPE_ADSENSE)) {
        getAdSenseReport(); //レポート取得開始
      }
    } catch (OperationCanceledException e) {
      Log.v("onGetAuthToken", "AuthToken取得キャンセル");
    } catch (Exception e) {
      Log.v("onGetAuthToken", "AuthToken取得失敗", e);
    }
  }

Denyした場合はfuture.getResult()した段階でOperationCanceledExceptionがスローされる。つまりキャンセル扱い。

Allowした場合はOAuth2の処理をOSが自動的に行った結果、accountNameとauthTokenを取得できる。その後はauthTokenTypeに設定された値に従ってgetUserInfo()が呼び出される。

getUserInfo()で正常にユーザー情報が取得できたら、次は「AdSenseレポート取得」ボタンをクリックする。するとonClickBtnAdSense()が呼び出される。

protected static final String AUTH_TOKEN_TYPE_ADSENSE = "oauth2:https://www.googleapis.com/auth/adsense.readonly";
  public void onClickBtnAdSense(View view) {
    Log.v("onClickBtnAdSense", "AdSenseレポート取得ボタンクリック");
    startRequest(AUTH_TOKEN_TYPE_ADSENSE);
  }

ここでまたstartRequest()が呼び出される。ただし、引数がAUTH_TOKEN_TYPE_ADSENSEになっていることに注意。

protected void startRequest(String authTokenType) {
    Log.v("startRequest", "リクエスト開始 - リクエスト先:" + authTokenType);
    this.authTokenType = authTokenType;
    if (accountName == null) {
      Log.v("startRequest", "アカウントが選択されていない");
      chooseAccount();
    } else {
      getAuthToken();
    }
  }

今回はaccountNameがnullではないのでgetAuthToken()が呼び出される。

protected static final int REQUEST_CODE_AUTH = 0;
  protected void getAuthToken() {
    Account account = null;
    Account[] accounts = accountManager.getAccounts();
    for (int i = 0; i < accounts.length; i++) {
      account = accounts[i];
      if (account.name.equals(accountName)) {
        break;
      }
    }
    Log.v("getAuthToken", "AuthToken取得開始");
    accountManager.getAuthToken(account, authTokenType, true,
        new AccountManagerCallback<Bundle>() {
          public void run(AccountManagerFuture<Bundle> future) {
            try {
              Bundle bundle = future.getResult();
              if (bundle.containsKey(AccountManager.KEY_INTENT)) {
                //まだAPIアクセス許可が出ていない場合にgetAuthToken()すると
                //BundleにKEY_INTENTが含まれる。この場合AuthTokenはNULLとなる。
                Log.v("getAuthToken", "アクセス許可画面へ");
                Intent intent = bundle.getParcelable(AccountManager.KEY_INTENT);
                //「FLAG_ACTIVITY_NEW_TASK」の前の「~」はビット反転演算子
                //これをしないとアクセス許可画面でのボタンクリックを待たずにonActivityResult()が呼ばれてしまう
                intent.setFlags(intent.getFlags() & ~Intent.FLAG_ACTIVITY_NEW_TASK);
                startActivityForResult(intent, REQUEST_CODE_AUTH);
              } else if (bundle.containsKey(AccountManager.KEY_AUTHTOKEN)) {
                onGetAuthToken(future);
              }
            } catch (Exception e) {
              Log.v("getAuthToken", "AuthToken取得失敗", e);
            }
          }
        },
        null);
  }

まずaccountNameからaccountを検索する。そして、そのaccountを使ってaccountManager.getAuthToken()を呼ぶ。

この先の動作はAPIの使用許可が出ているかどうかで異なる。

アクセス許可が出ている場合は、すぐにAuthTokenを取得できるのでonGetAuthToken()を呼ぶ。

アクセス許可が出ていない場合は、すぐにAuthTokenを取得できないので、Intentを使ってアクセス許可画面を呼び出す。今回はアクセス許可が出ていないのでこのケース。


ここでAllowされてもDenyされてもonActivityResult()が呼ばれる。

@Override
  protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    Log.v("onActivityResult", "requestCode=" + requestCode + " resultCode=" + resultCode);
    switch (requestCode) {
      case REQUEST_CODE_AUTH:
        if (resultCode == RESULT_OK) {
          getAuthToken();
        } else {
          Log.v("onActivityResult", "アクセス許可画面で拒否された");
        }
        break;
    }
  }

アクセス許可画面でAllowされたら既出のgetAuthToken()を再度呼び出す。

今度はアクセス許可が出ているので「アクセス許可が出ている場合」にあたり、getAuthToken()内で既出のonGetAuthToken()が呼ばれる。

そして今回はonGetAuthToken()内でgetAdSenseReport()が呼ばれる。

protected void getAdSenseReport() {
    Log.v("getAdSenseReport", "AdSenseレポート取得開始");
    String url = "https://www.googleapis.com/adsense/v1.1/reports"
        + "?startDate=2012-07-26"
        + "&endDate=2012-08-02"
        + "&metric=EARNINGS"
        + "&dimension=DATE"
        + "&key=" + API_KEY
        + "&access_token=" + authToken;
    AsyncTaskGetJson task = new AsyncTaskGetJson();
    task.setListener(new OnResultEventListener() {
      @Override
      public void onResult(JSONObject json) {
        TextView tv = (TextView) findViewById(R.id.textView);
        String msg = "";
        if (json == null) {
          msg = "AdSenseレポート取得失敗";
          Log.v("getAdSenseReport", msg);
          dialog.dismiss();
        } else if (json.toString().contains(KEY_AUTH_ERROR)) {
          msg = "AdSenseレポート取得失敗（認証エラー）";
          Log.v("getAdSenseReport", msg + " AuthTokenを破棄して再取得");
          accountManager.invalidateAuthToken(ACCOUNT_TYPE, authToken);
          startRequest(AUTH_TOKEN_TYPE_ADSENSE);
        } else {
          msg = "AdSenseレポート取得成功\njson=" + json.toString();
          Log.v("getAdSenseReport", msg);
          dialog.dismiss();
        }
        tv.setText(msg);
      }
    });
    task.execute(url);
    dialog.setMessage("AdSenseレポート取得中");
    dialog.show();
  }

authTokenは一定期間過ぎると無効になるので再取得する必要がある。

一定時間が過ぎたauthTokenを使ってAPIにリクエストすると「"code":401」を含むjsonが返される。上では「else if (json.toString().contains(KEY_AUTH_ERROR))」のケースだ。

このケースではaccountManager.invalidateAuthToken()した後startRequest()を再度呼び出す。すると更新されたauthTokenを取得できるようになり、エラー無くリクエストできるようになる。

以上のようにしてAccountManager経由のOAuth2認証で複数のGoogle APIにアクセスできる。

OAuth2の処理については隠蔽されているので全く分からない。通常必要なClientIDやClientSecretも必要ないらしい。APIにリクエスト投げる時につけてやったほうがいいのかな？この部分についてはもう少し調べる必要がある。

コメント

コメントを投稿

このブログの人気の投稿

レオナルド・ダ・ビンチはなぜノートを「鏡文字」で書いたのか？

イメージ
日経14.06.08朝　芸術と科学のあいだ　１７　鏡文字に込めた天才の思惑　福岡伸一 …ダ・ビンチの筆の特徴は、線が左上から斜め右下へと流れていることである。これは彼が左利きだったかららしい。 もう一つの際立った特徴は、文字がすべて鏡文字、左右反転で書かれていることだ… アイディアを盗まれないよう暗号化したのだという説があるが、暗号にしては簡単に解読されてしまう… ダ・ビンチは天才であり完璧主義者であると同時に、大いなる山っ気を持った人物でもあった。 いつも自分を売り込むこと、プランやアイディアを広めることを考えていた。そのためには何が必要か。マスメディアである。 ダ・ビンチの鏡文字は自分の原稿をいつの日か活版印刷するために意図された周到な準備だったのではなかったか。 日経記事より レオナルド・ダ・ビンチは過去の人物の中で最も尊敬する人物だ。彼は本当に何でも出来た。芸術も、科学も、工学も。まさに「万能人 (uomo universale)」。 レオナルド・ダ・ヴィンチ - Wikipedia 当然自分はダ・ビンチの足元にも及ばないが、いくつもの人工言語（プログラミング言語）を使うことができる。ひとつをマスターするのは大変だったが、ひとつマスターするとその他の言語にはかなりの共通点があるので、新しい言語を習得するのにそれほど時間がかからなくなったからだ。 いかに天才であったとしても生きられる時間は限られている。その限られた時間の中であれほどの多方面に渡る物事を習得できたのは、「すべてのものに共通する何か」を習得したからではないかと思うのだ。 自分の知る限り、その「すべてのものに共通する何か」を習得したのではないかと思える人物は、ダ・ビンチただ一人だ。 そのダ・ビンチの新たな側面を知った。山っ気というか、マーケティングにも興味があったようだ。 そのマーケティングには何らかのメディアが必要だ。やはり自分もダ・ビンチは活版印刷のために鏡文字を使っていた説に一票だ。 マーケティングへの興味という他にもう一つ根拠がある。ダ・ビンチが生まれたのが1452å¹´。グーテンベルクの聖書が世界で初めて活版印刷でつくられたのが1455å¹´。 グーテンベルク聖書 - Wikipedia つまり、ダ・ビンチが生きた時代は活版印...
続きを読む

macでsmb（samba）共有サーバーに別名で接続（別アカウント名で接続）する方法

macでsmb（samba）共有サーバーに別のアカウント名で接続したくなった。 接続を解除してもパスワードを保存してしまったために自動的に再接続してしまい、別アカウント名で接続できなくなってしまった(´・ω・`) どうすれば別名で接続できるのか？ Finder＞移動＞サーバーへ接続＞サーバアドレス に下記のように入力する。 smb://アカウント名@ホスト名 ノリでやってみたら、たまたまできちゃった(・∀・) 知らなかったわ〜
続きを読む

Windows7でネットワーク上の共有フォルダにアクセスする資格情報を保存するには？

イメージ
Windows7でネットワーク上の共有フォルダにアクセスする場合、通常IDとパスワードを求められる。Windows7ではこれを「資格情報」と呼んでいるようだ。 普通に入力してアクセスすることはできた。しかし問題は、 ログオフや再起動をすると、「資格情報を記憶する」をチェックしても毎回聞かれる ことだ。ネットで調べると、このような状況になる人は多いようだった。自分なりのログを書いておこうと思う。 普通に入力して共有フォルダにアクセスした後、「コントロールパネル」＞「ユーザーアカウントと家族のための安全設定」＞「資格情報マネージャ」を見るとこのようになっていた。何度も聞かれるのは、「常設」が「ログオンセッション」となっているためだろうとわかる。これをなんとかしなければならない。 そこで、まず「資格情報コンテナから削除」でこの資格情報を消してから、「Windows資格情報の追加」をする。普通に考えればこのように入力することになるだろう。 これで一度再起動した。しかし、これでもなぜか次のような画面が出て接続できなかった。 試行錯誤の結果、 ポイントはユーザー名を「サーバー名¥ãƒ¦ãƒ¼ã‚¶ãƒ¼å」とすること だとわかった。 こうして追加すると、このように「常設」が「エンタープライズ」になる。これで2度と聞かれなくなった。 このような苦労をしなくてもNASには普通に接続できたのだけれど、接続先がMacの共有フォルダだったのがいけなかったのだろうか。いまだに謎だ。
続きを読む