Android app + Drive API with full-drive access ... what's the procedure?

Question

I'm looking for some guidance related to accessing Google Drive with an Android app.

1) I need to be able to read files uploaded by users outside of my app. Does this mean I need full-drive access? (If the app could create a folder and then see all files uploaded by the user that exist in this folder, that would be great, but I don't think it works this way.)

2) If I need full-drive access, it seems that Googles "Drive API for Android" doesn't support this, and I need to use the REST api. I think this is true.

3) I need an Auth 2.0 client ID from Google. If I use the rest API, does this mean I need to use a "Web Application" ID? I think I need this because I want an "auth code". I wasn't able to get it working with an "Android" type ID.

4) I'm currently using "Google Sign-In" for Android to handle the login and provide an auth code. I can then convert this into a Token + Refresh Token, and save these so I can get new tokens after an hour in some fashion. Is this manually handling of refresh tokens required?

It's getting ugly, but I think that since I need (?) full-drive access then this is the procedure.

Thanks for any guidance.

Edit: The question has been identified as a duplicate. The link provided gives an answer for question #2, but doesn't address the other questions.

I agree the question is messy...

Ernie Thomason · Accepted Answer

I'm answering my own question.

I struggled with this because A) Google's REST example uses an outdated login process, B) The "Sign In" example uses code that doesn't work with "full-access" scope, and C) the there were too many vastly different code examples when trying to put it all together.

To quickly answer my questions as I see it now: 1) Yes, full-drive access is required to read files uploaded outside my app. 2) Yes, I need to use REST api. 3) Yes, I need a "Web Application" client ID. 4) Google Sign-In seems the best way currently to sign in, and using a GoogleCredential object along with the Drive api abject will handle the token refreshes automatically, as long as you keep around a refresh token.

In case anyone else is struggling with accessing Drive with full-access from Android using the latest "Sign-In" procedure and REST v3, below is my sample code.

In addition to the "Web application" OAuth client ID, you also need to create an "Android" type ID with a matching package name and certificate fingerprint in order for the Sign-In to work. Also note that you'll have different certificates for your dev and production versions. The IDs/codes from these Android clients do not need to be entered into the app.

build.gradle : app

// Google Sign In
compile 'com.google.android.gms:play-services-auth:10.0.1'

// Drive REST API
compile('com.google.apis:google-api-services-drive:v3-rev54-1.22.0') {
    exclude group: 'org.apache.httpcomponents'
}

Activity

@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);

    // Callback from Signin (Auth.GoogleSignInApi.getSignInIntent)
    if (requestCode == 1) {
        GoogleSignInResult result = Auth.GoogleSignInApi.getSignInResultFromIntent(data);
        _googleApi.handleSignInResult(result);
    }
}

A "GoogleApi" class to do the work

import android.app.Activity;
import android.content.Context;
import android.content.Intent;
import android.content.SharedPreferences;
import android.content.pm.ApplicationInfo;
import android.os.Bundle;
import android.os.Handler;
import android.util.Log;

import com.google.android.gms.auth.api.Auth;
import com.google.android.gms.auth.api.signin.GoogleSignInAccount;
import com.google.android.gms.auth.api.signin.GoogleSignInOptions;
import com.google.android.gms.auth.api.signin.GoogleSignInResult;
import com.google.android.gms.common.ConnectionResult;
import com.google.android.gms.common.api.GoogleApiClient;
import com.google.android.gms.common.api.ResultCallback;
import com.google.android.gms.common.api.Scope;
import com.google.android.gms.common.api.Status;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeTokenRequest;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.auth.oauth2.GoogleTokenResponse;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.drive.Drive;
import com.google.api.services.drive.model.File;
import com.google.api.services.drive.model.FileList;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;


public class GoogleApi implements GoogleApiClient.ConnectionCallbacks, GoogleApiClient.OnConnectionFailedListener {

    private Context         _context;
    private Handler         _handler;
    private GoogleCredential _credential;
    private Drive           _drive;

    private GoogleApiClient _googleApiClient;       // only set during login process
    private Activity        _activity;              // launch intent for login (UI)

    // Saved to data store
    private boolean         _loggedIn;
    private String          _refreshToken;          // store, even if user is logged out as we may need to reuse


    private static final String ClientID = "xxxxxx.apps.googleusercontent.com"; // web client
    private static final String ClientSecret = "xxxxx"; // web client

    private class FileAndErrorMsg {
        public File file;
        public String errorMsg;
        public FileAndErrorMsg (File file_, String errorMsg_) { file = file_; errorMsg = errorMsg_; }
    }
    private class FileListAndErrorMsg {
        public List fileList;
        public String errorMsg;
        public FileListAndErrorMsg (List fileList_, String errorMsg_) { fileList = fileList_; errorMsg = errorMsg_; }
    }

    // -------------------
    // Constructor
    // -------------------


    public GoogleApi (Context context) {

        _context = context;
        _handler = new Handler();
        loadFromPrefs();        //  loggedIn, refreshToken

        // create credential; will refresh itself automatically (in Drive calls) as long as valid refresh token exists
        HttpTransport transport = new NetHttpTransport();
        JsonFactory jsonFactory = JacksonFactory.getDefaultInstance();
        _credential = new GoogleCredential.Builder()
                .setTransport(transport)
                .setJsonFactory(jsonFactory)
                .setClientSecrets(ClientID, ClientSecret)       // .addRefreshListener
                .build();
        _credential.setRefreshToken(_refreshToken);

        // Get app name from Manifest (for Drive builder)
        ApplicationInfo appInfo = context.getApplicationInfo();
        String appName = appInfo.labelRes == 0 ? appInfo.nonLocalizedLabel.toString() : context.getString(appInfo.labelRes);

        _drive = new Drive.Builder(transport, jsonFactory, _credential).setApplicationName(appName).build();
    }

    // -------------------
    // Auth
    // -------------------

    // https://developers.google.com/identity/sign-in/android/offline-access#before_you_begin
    // https://developers.google.com/identity/sign-in/android/offline-access#enable_server-side_api_access_for_your_app
    // https://android-developers.googleblog.com/2016/02/using-credentials-between-your-server.html
    // https://android-developers.googleblog.com/2016/05/improving-security-and-user-experience.html


    public boolean isLoggedIn () {
        return _loggedIn;
    }

    public void startAuth(Activity activity) {
        startAuth(activity, false);
    }

    public void startAuth(Activity activity, boolean forceRefreshToken) {

        _activity = activity;
        _loggedIn = false;
        saveToPrefs();

        GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
                .requestScopes(new Scope("https://www.googleapis.com/auth/drive"))
                .requestServerAuthCode(ClientID, forceRefreshToken)     // if force, guaranteed to get back refresh token, but will show "offline access?" if Google already issued refresh token
                .build();

        _googleApiClient = new GoogleApiClient.Builder(activity)
                .addConnectionCallbacks(this)
                .addOnConnectionFailedListener(this)
                .addApi(Auth.GOOGLE_SIGN_IN_API, gso)
                .build();

        _googleApiClient.connect();
    }

    @Override
    public void onConnected(Bundle connectionHint) {
        // Called soon after .connect()
        // This is only called when starting our Login process.  Sign Out first so select-account screen shown.  (OK if not already signed in)
        Auth.GoogleSignInApi.signOut(_googleApiClient).setResultCallback(new ResultCallback() {
            @Override
            public void onResult(Status status) {
                // Start sign in
                Intent signInIntent = Auth.GoogleSignInApi.getSignInIntent(_googleApiClient);
                _activity.startActivityForResult(signInIntent, 1);    // Activity's onActivityResult will use the same code: 1
            }
        });
    }

    @Override
    public void onConnectionSuspended(int cause) {
        authDone("Connection suspended.");
    }
    @Override
    public void onConnectionFailed(ConnectionResult connectionResult) { authDone("Connection failed."); }

    public void handleSignInResult(GoogleSignInResult result) {

        // Callback from Activity > onActivityResult
        if (result.isSuccess()) {
            GoogleSignInAccount acct = result.getSignInAccount();
            String authCode = acct.getServerAuthCode();
            new Thread(new ContinueAuthWithAuthCode_Background(authCode)).start();
        }
        else authDone("Login canceled or unable to connect to Google.");    // can we get better error message?
    }

    private class ContinueAuthWithAuthCode_Background implements Runnable {

        String _authCode;
        public ContinueAuthWithAuthCode_Background (String authCode) {
            _authCode = authCode;
        }
        public void run() {

            // Convert authCode to tokens
            GoogleTokenResponse tokenResponse = null;
            String errorMsg = null;
            try {
                tokenResponse = new GoogleAuthorizationCodeTokenRequest(new NetHttpTransport(), JacksonFactory.getDefaultInstance(), "https://www.googleapis.com/oauth2/v4/token", ClientID, ClientSecret, _authCode, "").execute();
            }
            catch (IOException e) { errorMsg = e.getLocalizedMessage(); }
            final GoogleTokenResponse tokenResponseFinal = tokenResponse;
            final String errorMsgFinal = errorMsg;

            _handler.post(new Runnable() { public void run() {
                // Main thread
                GoogleTokenResponse tokenResponse = tokenResponseFinal;
                String errorMsg = errorMsgFinal;
                if (tokenResponse != null && errorMsg == null) {
                    _credential.setFromTokenResponse(tokenResponse);    // this will keep old refresh token if no new one sent
                    _refreshToken = _credential.getRefreshToken();
                    _loggedIn = true;
                    saveToPrefs();
                    // FIXME: if our refresh token is bad and we're not getting a new one, how do we deal with this?
                    Log("New refresh token: " + tokenResponse.getRefreshToken());
                }
                else if (errorMsg == null) errorMsg = "Get token error.";   // shouldn't get here
                authDone(errorMsg);
            } });
        }
    }

    private void authDone(String errorMsg) {
        // Disconnect (we only need googleApiClient for login process)
        if (_googleApiClient != null && _googleApiClient.isConnected()) _googleApiClient.disconnect();
        _googleApiClient = null;
    }

    /*
    public void signOut() {
        Auth.GoogleSignInApi.signOut(_googleApiClient).setResultCallback(new ResultCallback() {
            @Override
            public void onResult(Status status) {
            }
        });
    }

    public void revokeAccess() {
        // FIXME: I don't know yet, but this may revoke access for all android devices
        Auth.GoogleSignInApi.revokeAccess(_googleApiClient).setResultCallback(new ResultCallback() {
            @Override
            public void onResult(Status status) {
            }
        });
    }
    */

    public void LogOut() {
        _loggedIn = false;
        saveToPrefs();      // don't clear refresh token as we may need again
    }


    // -------------------
    // API Calls
    // -------------------


    public void makeApiCall() {
        new Thread(new TestApiCall_Background()).start();
    }

    private class TestApiCall_Background implements Runnable {
        public void run() {

            FileAndErrorMsg fileAndErr = getFolderFromName_b("Many Files", null);
            if (fileAndErr.errorMsg != null) Log("getFolderFromName_b error: " + fileAndErr.errorMsg);
            else {
                FileListAndErrorMsg fileListAndErr = getFileListInFolder_b(fileAndErr.file);
                if (fileListAndErr.errorMsg != null)
                    Log("getFileListInFolder_b error: " + fileListAndErr.errorMsg);
                else {
                    Log("file count: " + fileListAndErr.fileList.size());
                    for (File file : fileListAndErr.fileList) {
                        //Log(file.getName());
                    }
                }
            }

            _handler.post(new Runnable() { public void run() {
                // Main thread
            } });
        }
    }

    private FileAndErrorMsg getFolderFromName_b (String folderName, File parent) {

        // parent can be null for top level
        // Working with folders: https://developers.google.com/drive/v3/web/folder

        File folder = null;
        folderName = folderName.replace("'", "\'");    // escape '
        String q = String.format(Locale.US, "mimeType='application/vnd.google-apps.folder' and '%s' in parents and name='%s' and trashed=false", parent == null ? "root" : parent.getId(), folderName);
        String errorMsg = null;
        try {
            FileList result = _drive.files().list().setQ(q).setPageSize(1000).execute();
            int foundCount = 0;
            for (File file : result.getFiles()) {
                foundCount++;
                folder = file;
            }
            if (foundCount == 0) errorMsg = "Folder not found: " + folderName;
            else if (foundCount > 1) errorMsg = "More than one folder found with name (" + foundCount + "): " + folderName;
        }
        catch (IOException e) { errorMsg = e.getLocalizedMessage(); }
        if (errorMsg != null) folder = null;
        return new FileAndErrorMsg(folder, errorMsg);
    }

    private FileListAndErrorMsg getFileListInFolder_b (File folder) {

        // folder can be null for top level; does not return subfolder names
        List fileList = new ArrayList();
        String q = String.format(Locale.US, "mimeType != 'application/vnd.google-apps.folder' and '%s' in parents and trashed=false", folder == null ? "root" : folder.getId());
        String errorMsg = null;
        try {
            String pageToken = null;
            do {
                FileList result = _drive.files().list().setQ(q).setPageSize(1000).setPageToken(pageToken).execute();
                fileList.addAll(result.getFiles());
                pageToken = result.getNextPageToken();
            } while (pageToken != null);
        }
        catch (IOException e) { errorMsg = e.getLocalizedMessage(); }
        if (errorMsg != null) fileList = null;
        return new FileListAndErrorMsg(fileList, errorMsg);
    }


    // -------------------
    // Misc
    // -------------------

    private void Log(String msg) {
        Log.v("ept", msg);
    }


    // -------------------
    // Load/Save Tokens
    // -------------------


    private void loadFromPrefs() {
        SharedPreferences pref = _context.getSharedPreferences("prefs", Context.MODE_PRIVATE);
        _loggedIn = pref.getBoolean("GoogleLoggedIn", false);
        _refreshToken = pref.getString("GoogleRefreshToken", null);
    }
    private void saveToPrefs() {
        SharedPreferences.Editor editor =  _context.getSharedPreferences("prefs", Context.MODE_PRIVATE).edit();
        editor.putBoolean("GoogleLoggedIn", _loggedIn);
        editor.putString("GoogleRefreshToken", _refreshToken);
        editor.apply();     // async

    }

}

Android app + Drive API with full-drive access ... what's the procedure?

Answers (2)

Related Questions

Android app + Drive API with full-drive access ... what&#39;s the procedure?

Answers (2)

Related Questions

Android app + Drive API with full-drive access ... what's the procedure?