Accesso alle API di Google con GoogleApiClient (deprecato)

Puoi utilizzare l'oggetto GoogleApiClient ("Client API di Google") per accedere alle API di Google fornite nella libreria di Google Play Services (ad esempio Accedi con Google, Giochi e Drive). Il client API di Google fornisce un punto di accesso comune a Google Play Services e gestisce la connessione di rete tra il dispositivo dell'utente e ogni servizio Google.

Tuttavia, la nuova interfaccia di GoogleApi e le relative implementazioni sono più facili da usare e rappresentano il modo preferito per accedere alle API di Play Services. Vedi Accesso alle API di Google.

Nota: se l'API di Google che vuoi utilizzare non è inclusa nella libreria di Google Play Services, puoi connetterti utilizzando l'API REST appropriata, ma devi ottenere l'autorizzazione dell'utente con OAuth 2.0.

Questa guida illustra come:

• Gestisci automaticamente la tua connessione a Google Play Services.
• Eseguire chiamate API sincrone e asincrone a tutti i servizi Google Play.
• Gestisci manualmente la tua connessione a Google Play Services nei rari casi in cui sia necessario. Per scoprire di più, vedi Connessioni gestite manualmente.

Figura 1: illustrazione che mostra in che modo il client dell'API di Google fornisce un'interfaccia per connettere ed effettuare chiamate a qualsiasi servizio di Google Play disponibile, come Google Play Giochi e Google Drive.

Per iniziare, devi prima installare la libreria Google Play Services (revisione 15 o versioni successive) per il tuo SDK Android. Se non l'hai ancora fatto, segui le istruzioni in Configurare l'SDK Google Play Services.

Avviare una connessione gestita automaticamente

Dopo aver collegato il progetto alla libreria di Google Play Services, crea un'istanza di GoogleApiClient utilizzando le API GoogleApiClient.Builder nel metodo onCreate() della tua attività. La classe GoogleApiClient.Builder fornisce metodi che ti consentono di specificare le API di Google che vuoi utilizzare e gli ambiti OAuth 2.0 desiderati. Ecco un esempio di codice che crea un'istanza GoogleApiClient che si connette al servizio Google Drive:

GoogleApiClient mGoogleApiClient = new GoogleApiClient.Builder(this)
    .enableAutoManage(this /* FragmentActivity */,
                      this /* OnConnectionFailedListener */)
    .addApi(Drive.API)
    .addScope(Drive.SCOPE_FILE)
    .build();

Puoi aggiungere più API e ambiti multipli allo stesso GoogleApiClient aggiungendo chiamate aggiuntive a addApi() e addScope().

Importante: se aggiungi l'API Wearable insieme ad altre API a un GoogleApiClient, potresti riscontrare errori di connessione del client sui dispositivi su cui non è installata l'app per Wear OS. Per evitare errori di connessione, chiama il metodo addApiIfAvailable() e passalo all'API Wearable per consentire al client di gestire agevolmente l'API mancante. Per maggiori informazioni, vedi Accedere all'API Wearable.

Per avviare una connessione gestita automaticamente, devi specificare un'implementazione affinché l'interfaccia OnConnectionFailedListener riceva errori di connessione irrisolvibili. Quando l'istanza GoogleApiClient gestita automaticamente tenta di connettersi alle API di Google, mostrerà automaticamente la UI per tentare di risolvere eventuali errori di connessione risolvibili (ad esempio, se Google Play Services deve essere aggiornato). Se si verifica un errore che non può essere risolto, riceverai una chiamata a onConnectionFailed().

Puoi anche specificare un'implementazione facoltativa per l'interfaccia di ConnectionCallbacks se la tua app deve sapere quando viene stabilita o sospesa la connessione gestita automaticamente. Ad esempio, se la tua app effettua chiamate per scrivere dati nelle API di Google, queste dovrebbero essere richiamate solo dopo che è stato chiamato il metodo onConnected().

Di seguito è riportato un esempio di attività che implementa le interfacce di callback e le aggiunge al client API di Google:

import com.google.android.gms.common.api.GoogleApiClient;
import com.google.android.gms.common.api.GoogleApiClient.OnConnectionFailedListener;
import gms.drive.*;
import android.support.v4.app.FragmentActivity;

public class MyActivity extends FragmentActivity
        implements OnConnectionFailedListener {
    private GoogleApiClient mGoogleApiClient;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Create a GoogleApiClient instance
        mGoogleApiClient = new GoogleApiClient.Builder(this)
                .enableAutoManage(this /* FragmentActivity */,
                                  this /* OnConnectionFailedListener */)
                .addApi(Drive.API)
                .addScope(Drive.SCOPE_FILE)
                .build();

        // ...
    }

    @Override
    public void onConnectionFailed(ConnectionResult result) {
        // An unresolvable error has occurred and a connection to Google APIs
        // could not be established. Display an error message, or handle
        // the failure silently

        // ...
    }
}

La tua istanza di GoogleApiClient si connetterà automaticamente dopo che l'attività chiama onStart() e si disconnetterà dopo aver chiamato onStop(). La tua app può iniziare a inviare richieste di lettura alle API di Google immediatamente dopo aver creato GoogleApiClient, senza attendere il completamento della connessione.

Comunica con i servizi Google

Dopo la connessione, il client può effettuare chiamate di lettura e scrittura utilizzando le API specifiche del servizio per le quali l'app è autorizzata, come specificato dalle API e dagli ambiti che hai aggiunto all'istanza GoogleApiClient.

Nota: prima di effettuare chiamate a servizi Google specifici, potresti dover registrare l'app in Google Developer Console. Per istruzioni, consulta la guida introduttiva appropriata per l'API che utilizzi, ad esempio Google Drive o Accedi con Google.

Quando esegui una richiesta di lettura o scrittura utilizzando GoogleApiClient, il client API restituisce un oggetto PendingResult che rappresenta la richiesta. Ciò avviene immediatamente, prima che la richiesta venga consegnata al servizio Google chiamato dalla tua app.

Ad esempio, ecco una richiesta per leggere da Google Drive un file che fornisce un oggetto PendingResult:

Query query = new Query.Builder()
        .addFilter(Filters.eq(SearchableField.TITLE, filename));
PendingResult<DriveApi.MetadataBufferResult> result = Drive.DriveApi.query(mGoogleApiClient, query);

Quando l'app ha un oggetto PendingResult, l'app può specificare se la richiesta viene gestita come una chiamata asincrona o come una chiamata sincrona.

Suggerimento:la tua app può accodare le richieste di lettura quando non è connessa a Google Play Services. Ad esempio, la tua app può chiamare metodi per leggere un file da Google Drive indipendentemente dal fatto che la tua istanza GoogleApiClient sia ancora connessa. Dopo aver stabilito una connessione, le richieste di lettura accodate vengono eseguite. Le richieste di scrittura generano un errore se la tua app chiama i metodi di scrittura di Google Play Services mentre il client API di Google non è connesso.

Utilizzo delle chiamate asincrone

Per rendere la richiesta asincrona, chiama setResultCallback() sul PendingResult e fornisci un'implementazione dell'interfaccia ResultCallback. Ad esempio, ecco la richiesta eseguita in modo asincrono:

private void loadFile(String filename) {
    // Create a query for a specific filename in Drive.
    Query query = new Query.Builder()
            .addFilter(Filters.eq(SearchableField.TITLE, filename))
            .build();
    // Invoke the query asynchronously with a callback method
    Drive.DriveApi.query(mGoogleApiClient, query)
            .setResultCallback(new ResultCallback<DriveApi.MetadataBufferResult>() {
        @Override
        public void onResult(DriveApi.MetadataBufferResult result) {
            // Success! Handle the query result.
            // ...
        }
    });
}

Quando la tua app riceve un oggetto Result nel callback onResult(), viene pubblicato come istanza della sottoclasse appropriata come specificato dall'API che stai utilizzando, ad esempio DriveApi.MetadataBufferResult.

Utilizzo delle chiamate sincrone

Se vuoi che il codice venga eseguito in un ordine rigorosamente definito, forse perché il risultato di una chiamata è necessario come argomento per un'altra, puoi rendere sincrona la richiesta chiamando await() su PendingResult. Questa operazione blocca il thread e restituisce l'oggetto Result al completamento della richiesta. Questo oggetto viene pubblicato come istanza della sottoclasse appropriata, come specificato dall'API che stai utilizzando, ad esempio DriveApi.MetadataBufferResult.

Poiché la chiamata a await() blocca il thread fino a quando non arriva il risultato, la tua app non dovrebbe mai effettuare richieste sincrone alle API di Google nel thread UI. La tua app può creare un nuovo thread utilizzando un oggetto AsyncTask e utilizzare il thread per effettuare la richiesta sincrona.

L'esempio seguente mostra come effettuare una richiesta di file a Google Drive come chiamata sincrona:

private void loadFile(String filename) {
    new GetFileTask().execute(filename);
}

private class GetFileTask extends AsyncTask {
    protected void doInBackground(String filename) {
        Query query = new Query.Builder()
                .addFilter(Filters.eq(SearchableField.TITLE, filename))
                .build();
        // Invoke the query synchronously
        DriveApi.MetadataBufferResult result =
                Drive.DriveApi.query(mGoogleApiClient, query).await();

        // Continue doing other stuff synchronously
        // ...
    }
}

Nota: puoi anche eseguire il codice in un ordine ben definito utilizzando PendingResult.then().

Accedi all'API Wearable

L'API Wearable fornisce un canale di comunicazione per le app eseguite su dispositivi portatili e indossabili. L'API è costituita da un set di oggetti di dati che il sistema può inviare e sincronizzare e da ascoltatori che notificano alle app eventi importanti utilizzando un livello dati. L'API Wearable è disponibile sui dispositivi con Android 4.3 (livello API 18) o versioni successive quando un dispositivo indossabile è connesso e l'app complementare Wear OS è installata sul dispositivo.

Utilizzo dell'API Wearable standalone

Se la tua app utilizza l'API Wearable, ma non altre API di Google, puoi aggiungere questa API chiamando il metodo addApi(). L'esempio seguente mostra come aggiungere l'API Wearable alla tua istanza GoogleApiClient:

GoogleApiClient mGoogleApiClient = new GoogleApiClient.Builder(this)
    .enableAutoManage(this /* FragmentActivity */,
                      this /* OnConnectionFailedListener */)
    .addApi(Wearable.API)
    .build();

Nelle situazioni in cui l'API Wearable non è disponibile, le richieste di connessione che includono l'API Wearable non vanno a buon fine e viene restituito il codice di errore API_UNAVAILABLE.

L'esempio seguente mostra come determinare se è disponibile l'API Wearable:

// Connection failed listener method for a client that only
// requests access to the Wearable API
@Override
public void onConnectionFailed(ConnectionResult result) {
    if (result.getErrorCode() == ConnectionResult.API_UNAVAILABLE) {
        // The Wearable API is unavailable
    }
    // ...
}

Utilizzo dell'API Wearable con altre API di Google

Se la tua app utilizza l'API Wearable oltre ad altre API di Google, chiama il metodo addApiIfAvailable() e passa l'API Wearable per verificare se è disponibile. Puoi utilizzare questo controllo per consentire alla tua app di gestire agevolmente i casi in cui l'API non è disponibile.

L'esempio seguente mostra come accedere all'API Wearable e all'API Drive:

// Create a GoogleApiClient instance
mGoogleApiClient = new GoogleApiClient.Builder(this)
        .enableAutoManage(this /* FragmentActivity */,
                          this /* OnConnectionFailedListener */)
        .addApi(Drive.API)
        .addApiIfAvailable(Wearable.API)
        .addScope(Drive.SCOPE_FILE)
        .build();

Nell'esempio precedente, GoogleApiClient può connettersi correttamente con Google Drive senza connettersi all'API Wearable se non è disponibile. Dopo aver connesso l'istanza GoogleApiClient, assicurati che l'API Wearable sia disponibile prima di effettuare le chiamate API:

boolean wearAvailable = mGoogleApiClient.hasConnectedApi(Wearable.API);

Ignorare gli errori di connessione all'API

Se chiami addApi() e GoogleApiClient non riesce a connettersi correttamente all'API, l'intera operazione di connessione per il client ha esito negativo e attiva il callback onConnectionFailed().

Puoi registrare un errore di connessione API da ignorare utilizzando addApiIfAvailable(). Se un'API aggiunta con addApiIfAvailable() non riesce a connettersi a causa di un errore non recuperabile (ad esempio API_UNAVAILABLE per Wear), l'API viene eliminata da GoogleApiClient e il client procede a connettersi ad altre API. Tuttavia, se una connessione API non va a buon fine con un errore recuperabile (come un intento di risoluzione del consenso OAuth), l'operazione di connessione del client non va a buon fine. Quando utilizzi una connessione gestita automaticamente, GoogleApiClient tenterà di risolvere questi errori quando possibile. Quando utilizzi una connessione gestita manualmente, un elemento ConnectionResult contenente un intent di risoluzione viene inviato al callback onConnectionFailed(). Gli errori di connessione all'API vengono ignorati solo se non esiste una soluzione per l'errore e se l'API è stata aggiunta con addApiIfAvailable(). Per informazioni su come implementare la gestione manuale degli errori di connessione, consulta Gestire gli errori di connessione.

Poiché le API aggiunte con addApiIfAvailable() potrebbero non essere sempre presenti nell'istanza GoogleApiClient connessa, devi proteggere le chiamate a queste API aggiungendo un controllo utilizzando hasConnectedApi(). Per scoprire perché una determinata API non è riuscita a connettersi quando l'intera operazione di connessione è riuscita per il client, chiama getConnectionResult() e ricevi il codice di errore dall'oggetto ConnectionResult. Se il client chiama un'API quando non è connessa al client, la chiamata non va a buon fine con il codice di stato API_NOT_AVAILABLE.

Se l'API che aggiungi tramite addApiIfAvailable() richiede uno o più ambiti, aggiungi questi ambiti come parametri nella chiamata al metodo addApiIfAvailable() anziché utilizzare il metodo addScope(). Gli ambiti aggiunti utilizzando questo approccio potrebbero non essere richiesti se la connessione API non riesce prima di ottenere il consenso OAuth, mentre gli ambiti aggiunti con addScope() sono sempre richiesti.

Connessioni gestite manualmente

La maggior parte di questa guida mostra come utilizzare il metodo enableAutoManage per avviare una connessione gestita automaticamente con errori risolti automaticamente. In quasi tutti i casi, questo è il modo migliore e più semplice per connettersi alle API di Google dalla tua app per Android. Tuttavia, esistono alcune situazioni in cui potresti voler utilizzare una connessione gestita manualmente alle API di Google nella tua app:

• Per accedere alle API di Google al di fuori di un'attività o mantenere il controllo della connessione API
• Per personalizzare la gestione e la risoluzione degli errori di connessione

Questa sezione fornisce esempi di questi e altri casi d'uso avanzati.

Avviare una connessione gestita manualmente

Per avviare una connessione gestita manualmente a GoogleApiClient, devi specificare un'implementazione per le interfacce di callback ConnectionCallbacks e OnConnectionFailedListener. Queste interfacce ricevono callback in risposta al metodo connect() asincrono quando la connessione a Google Play Services va a buon fine, non riesce o viene sospesa.

    mGoogleApiClient = new GoogleApiClient.Builder(this)
            .addApi(Drive.API)
            .addScope(Drive.SCOPE_FILE)
            .addConnectionCallbacks(this)
            .addOnConnectionFailedListener(this)
            .build()

Quando gestisci manualmente una connessione, devi chiamare i metodi connect() e disconnect() nei punti giusti del ciclo di vita della tua app. Nel contesto di un'attività, la best practice consiste nel chiamare connect() nel metodo onStart() delle tue attività e disconnect() nel metodo onStop() delle tue attività. I metodi connect() e disconnect() vengono richiamati automaticamente quando si utilizza una connessione gestita automaticamente.

Se utilizzi GoogleApiClient per connetterti ad API che richiedono l'autenticazione, come Google Drive o Google Play Giochi, è molto probabile che il tuo primo tentativo di connessione non vada a buon fine e la tua app riceverà una chiamata a onConnectionFailed() con l'errore SIGN_IN_REQUIRED perché l'account utente non è stato specificato.

Gestire gli errori di connessione

Quando la tua app riceve una chiamata al callback di onConnectionFailed(), devi chiamare hasResolution() sull'oggetto ConnectionResult fornito. Se restituisce true, la tua app può richiedere all'utente di intraprendere un'azione immediata per risolvere l'errore chiamando startResolutionForResult() sull'oggetto ConnectionResult. Il metodo startResolutionForResult() si comporta come startActivityForResult() in questa situazione e avvia un'attività appropriata al contesto che aiuta l'utente a risolvere l'errore (ad esempio un'attività che aiuta l'utente a selezionare un account).

Se hasResolution() restituisce false, l'app deve chiamare GoogleApiAvailability.getErrorDialog(), trasmettendo il codice di errore a questo metodo. Viene restituito un elemento Dialog fornito da Google Play Services appropriato per l'errore. La finestra di dialogo potrebbe fornire semplicemente un messaggio che spiega l'errore oppure potrebbe anche fornire un'azione per avviare un'attività che possa risolvere l'errore (ad esempio quando l'utente deve installare una versione più recente di Google Play Services).

Ad esempio, il tuo metodo di callback onConnectionFailed() ora dovrebbe avere il seguente aspetto:

public class MyActivity extends Activity
        implements ConnectionCallbacks, OnConnectionFailedListener {

    // Request code to use when launching the resolution activity
    private static final int REQUEST_RESOLVE_ERROR = 1001;
    // Unique tag for the error dialog fragment
    private static final String DIALOG_ERROR = "dialog_error";
    // Bool to track whether the app is already resolving an error
    private boolean mResolvingError = false;

    // ...

    @Override
    public void onConnectionFailed(ConnectionResult result) {
        if (mResolvingError) {
            // Already attempting to resolve an error.
            return;
        } else if (result.hasResolution()) {
            try {
                mResolvingError = true;
                result.startResolutionForResult(this, REQUEST_RESOLVE_ERROR);
            } catch (SendIntentException e) {
                // There was an error with the resolution intent. Try again.
                mGoogleApiClient.connect();
            }
        } else {
            // Show dialog using GoogleApiAvailability.getErrorDialog()
            showErrorDialog(result.getErrorCode());
            mResolvingError = true;
        }
    }

    // The rest of this code is all about building the error dialog

    /* Creates a dialog for an error message */
    private void showErrorDialog(int errorCode) {
        // Create a fragment for the error dialog
        ErrorDialogFragment dialogFragment = new ErrorDialogFragment();
        // Pass the error that should be displayed
        Bundle args = new Bundle();
        args.putInt(DIALOG_ERROR, errorCode);
        dialogFragment.setArguments(args);
        dialogFragment.show(getSupportFragmentManager(), "errordialog");
    }

    /* Called from ErrorDialogFragment when the dialog is dismissed. */
    public void onDialogDismissed() {
        mResolvingError = false;
    }

    /* A fragment to display an error dialog */
    public static class ErrorDialogFragment extends DialogFragment {
        public ErrorDialogFragment() { }

        @Override
        public Dialog onCreateDialog(Bundle savedInstanceState) {
            // Get the error code and retrieve the appropriate dialog
            int errorCode = this.getArguments().getInt(DIALOG_ERROR);
            return GoogleApiAvailability.getInstance().getErrorDialog(
                    this.getActivity(), errorCode, REQUEST_RESOLVE_ERROR);
        }

        @Override
        public void onDismiss(DialogInterface dialog) {
            ((MyActivity) getActivity()).onDialogDismissed();
        }
    }
}

Dopo che l'utente ha completato la finestra di dialogo fornita da startResolutionForResult() o ignorato il messaggio fornito da GoogleApiAvailability.getErrorDialog(), la tua attività riceve il callback di onActivityResult() con il codice risultato RESULT_OK. L'app potrà quindi chiamare di nuovo connect(). Ad esempio:

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    if (requestCode == REQUEST_RESOLVE_ERROR) {
        mResolvingError = false;
        if (resultCode == RESULT_OK) {
            // Make sure the app is not already connected or attempting to connect
            if (!mGoogleApiClient.isConnecting() &&
                    !mGoogleApiClient.isConnected()) {
                mGoogleApiClient.connect();
            }
        }
    }
}

Nel codice riportato sopra, avrai probabilmente notato il valore booleano mResolvingError. Questo tiene traccia dello stato dell'app mentre l'utente risolve l'errore per evitare tentativi ripetitivi di risolvere lo stesso errore. Ad esempio, anche se viene visualizzata la finestra di dialogo del selettore account per aiutare l'utente a risolvere l'errore SIGN_IN_REQUIRED, l'utente può ruotare lo schermo. Questa operazione ricrea la tua attività e fa sì che il metodo onStart() venga richiamato, l'operazione richiama quindi connect(). Viene così eseguita un'altra chiamata a startResolutionForResult(), che crea un'altra finestra di dialogo del selettore account di fronte a quella esistente.

Questo valore booleano serve allo scopo previsto solo se persiste in più istanze di attività. La sezione successiva spiega come mantenere lo stato di gestione degli errori dell'app nonostante altri eventi o azioni utente che si verificano sul dispositivo.

Mantieni lo stato durante la risoluzione di un errore

Per evitare di eseguire il codice in onConnectionFailed() mentre è in corso un tentativo precedente di risolvere un errore, devi mantenere un valore booleano che monitori se l'app sta già tentando di risolvere un errore.

Come mostrato nell'esempio di codice riportato sopra, la tua app deve impostare un valore booleano su true ogni volta che chiama startResolutionForResult() o visualizza la finestra di dialogo da GoogleApiAvailability.getErrorDialog(). Quando la tua app riceve RESULT_OK nel callback di onActivityResult(), imposta il valore booleano su false.

Per tenere traccia del valore booleano nei riavvii dell'attività (ad esempio quando l'utente ruota lo schermo), salva il valore booleano nei dati dell'istanza salvata dell'attività utilizzando onSaveInstanceState():

private static final String STATE_RESOLVING_ERROR = "resolving_error";

@Override
protected void onSaveInstanceState(Bundle outState) {
    super.onSaveInstanceState(outState);
    outState.putBoolean(STATE_RESOLVING_ERROR, mResolvingError);
}

Quindi ripristina lo stato salvato durante onCreate():

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // ...
    mResolvingError = savedInstanceState != null
            && savedInstanceState.getBoolean(STATE_RESOLVING_ERROR, false);
}

Ora puoi eseguire in sicurezza l'app e connetterti manualmente a Google Play Services.