Esegui esempi di codice

L'Explorer API di Google genera dinamicamente esempi di codice. Questi esempi di codice sono progettati per essere copiati ed eseguiti localmente. Per visualizzare gli esempi, fai clic su Schermo intero nel riquadro laterale Explorer API. La figura seguente mostra l'Explorer API a schermo intero espanso:

Riquadro a schermo intero dell'Explorer API per l'API Google Libri
Figura 2: riquadro a schermo intero dell'Explorer API per l'API Google Libri.

Per impostazione predefinita, Explorer API mostra come utilizzare cURL per eseguire la tua richiesta. Alcune API potrebbero mostrare anche esempi per altri linguaggi, come JavaScript, Java e Python.

Esegui esempi di codice in locale

Le seguenti schede spiegano i prerequisiti e i passaggi per eseguire gli esempi di codice. Per eseguire gli esempi di codice, devi generare e utilizzare le tue credenziali di autorizzazione. Per una spiegazione su come creare un progetto e generare credenziali, consulta la documentazione specifica dell'API di Google.

Le credenziali sono una delle seguenti, a seconda del tipo di dati (pubblici o privati) a cui accede il metodo:

  • Per i dati pubblici, la credenziale è una chiave API.

  • Per i dati privati, la credenziale è un file client_secret.json contenente l'ID client OAuth 2.0 e il client secret oppure un token di accesso OAuth 2.0.

URL

Configura

  1. Segui le istruzioni nella documentazione dell'API per creare o selezionare un progetto per la tua app e abilitare l'API.
  2. In Cloud Console, crea una chiave API.
  3. In Cloud Console, crea una credenziale ID client OAuth per un'applicazione web e utilizza https://developers.google.com/oauthplayground come URI di reindirizzamento.
  4. In OAuth 2.0 Playground, fai clic su Configurazione OAuth 2.0 .
  5. Seleziona Utilizza le tue credenziali.
  6. Inserisci l'ID client e il client secret generati nel passaggio 3.
  7. Nel campo ambiti, digita l'ambito da utilizzare con il metodo e fai clic su Autorizza API.
  8. (Facoltativo) Se viene visualizzata una schermata di accesso, seleziona l'account da utilizzare.
  9. (Facoltativo) Se viene visualizzata una schermata di autorizzazione, fai clic su Accetta.
  10. Fai clic su Codice di autorizzazione di Exchange per i token. Viene restituito un token.
  11. Nell'esempio di codice cURL, sostituisci [YOUR_API_KEY] con la chiave API generata nel passaggio 2: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
  12. Nell'esempio di codice cURL, sostituisci [YOUR_ACCESS_TOKEN] con il token di accesso generato nel passaggio 10: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

Esegui l'esempio di codice

Dalla riga di comando, esegui il comando cURL. Il comando dovrebbe essere simile al seguente:

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

Configura

  1. Segui le istruzioni nella documentazione dell'API per creare o selezionare un progetto per la tua app e abilitare l'API.
  2. In Cloud Console, crea una chiave API.
  3. In Cloud Console, crea una credenziale ID client OAuth per un'applicazione web e imposta le origini JavaScript autorizzate per identificare l'URL da cui invierai richieste, ad esempio http://localhost.
  4. Copia l'esempio di codice completo in un file locale accessibile al tuo server web, ad esempio /var/www/html/example.html.

  5. Nell'esempio di codice, trova la riga che imposta la chiave API o l'ID client e sostituisci il valore con i valori generati nei passaggi 2 e 3:

    • Chiave API: gapi.client.setApiKey(YOUR_API_KEY);
    • ID client OAuth 2.0: gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

Esegui l'esempio di codice

  1. Apri il file nel browser, ad esempio http://localhost/example.html. Ti consigliamo di utilizzare un browser con una console di debug, ad esempio Google Chrome.
  2. (Facoltativo) Se viene visualizzata una schermata di accesso, seleziona l'account da utilizzare.
  3. (Facoltativo) Se viene visualizzata una schermata di autorizzazione, fai clic su Accetta. La console di debug dovrebbe mostrare la risposta del metodo come oggetto JSON.

Java

Prerequisiti

  • Java 1.7 o versioni successive.
  • Gradle 7 o superiore.

Configura

  1. Segui le istruzioni nella documentazione dell'API per creare o selezionare un progetto per la tua app e abilitare l'API.
  2. A seconda del tipo di dati a cui accede il metodo, crea una chiave API (dati pubblici) o un ID client OAuth 2.0 (dati privati).
  3. Imposta il tipo di applicazione su App desktop.
  4. Se hai creato un ID client OAuth 2.0, scarica il file JSON contenente le credenziali OAuth 2.0. Il nome di questo file è simile a client_secret_CLIENTID.json, dove CLIENTID è l'ID client del tuo progetto.

  5. Nella directory di lavoro, esegui i comandi seguenti per creare una nuova struttura di progetto:

    $ gradle init --type basic
$ mkdir -p src/main/java src/main/resources

  6. Se hai creato un ID client OAuth 2.0 nel passaggio 2, rinomina il file JSON che hai scaricato in client_secret.json.

  7. Salva il file rinominato nella directory src/main/resources che hai creato nel passaggio 5.

  8. Nella directory di lavoro, apri il file build.gradle e sostituiscine i contenuti con il seguente:

    apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    API_SPECIFIC_DEPENDENCY
}

  9. Nel file build.gradle, sostituisci la riga API_SPECIFIC_DEPENDENCY con un'istruzione per compilare il codice per l'API che stai chiamando. Di seguito è riportato un esempio per l'API YouTube Analytics:

    compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'

    L'istruzione segue questo modello:

    compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'

Dove:

  • API_NAME è il nome dell'API elencato su GitHub per l'API. Per trovare il nome, fai clic sul link della versione accanto alla tua API nella pagina API di Google supportate. Il link della versione naviga su GitHub. Il nome API si trova nella parte superiore centrale della pagina ed è preceduto da googleapis/google-apis-services-. Ad esempio, per la versione v3 dell'API Drive, API_NAME è drive.
  • API_VERSION è la versione indicata per l'API sotto il nome dell'API nella pagina delle API di Google supportate.
  • REVISION è il numero di revisione elencato nel riferimento JavaDoc per l'API. Il riferimento JavaDoc è disponibile all'indirizzo https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
  • CL_VERSION è la versione della libreria client. Questo valore compare anche nel riferimento JavaDoc.
  • Dalla directory di lavoro, copia l'esempio di codice da Explorer API a src/main/java/ApiExample.java. (Il nome della classe in ogni esempio è ApiExample, quindi non è necessario modificare il file build.gradle per eseguire diversi esempi.

Esegui l'esempio di codice

Utilizza il comando seguente per eseguire l'esempio:

  gradle -q run

L'esempio deve eseguire la richiesta API e stampare la risposta in STDOUT. Puoi anche controllare il servizio che stai chiamando per vedere gli effetti delle richieste che scrivono i dati.

Node.js

Prerequisiti

  • Node.js

  • Libreria client delle API di Google per Node.js:

    • Se non hai ancora installato la libreria client, esegui il comando:
    npm install googleapis --save
    • Se in precedenza hai installato la libreria client, ti consigliamo di aggiornarla per assicurarti di avere le classi più aggiornate per la libreria che stai testando. Per aggiornare la libreria client, esegui questo comando:
    npm update googleapis --save

Configura

  1. Segui le istruzioni nella documentazione dell'API per creare o selezionare un progetto per la tua app e abilitare l'API.
  2. A seconda del tipo di dati a cui accede il metodo, crea una chiave API (dati pubblici) o un ID client OAuth 2.0 (dati privati).
  3. Imposta il tipo di applicazione su App desktop.
  4. Se hai creato un ID client OAuth 2.0, scarica il file JSON contenente le credenziali OAuth 2.0. Il nome di questo file è simile a client_secret_CLIENTID.json, dove CLIENTID è l'ID client del tuo progetto.
  5. Copia l'esempio di codice in un file locale e modificalo per identificare correttamente la chiave API o il file dei client secret. Nell'esempio, la chiave-valore dell'API è YOUR_API_KEY e la posizione del file dei client secret è YOUR_CLIENT_SECRET_FILE.json.

Esegui l'esempio di codice

Utilizza il comando seguente per eseguire l'esempio:

  node sample.js

La maggior parte degli esempi stampa una risposta API (o altro) a STDOUT.

PHP

Prerequisiti

  • PHP 5.4 o versioni successive con l'interfaccia a riga di comando (CLI) e l'estensione JSON.
  • Lo strumento di gestione delle dipendenze Composer è stato installato a livello globale.

  • Libreria client delle API di Google per PHP:

    • Se non hai ancora installato la libreria client, esegui il comando:

      composer require google/apiclient:^2.0

    • Se in precedenza hai installato la libreria client, ti consigliamo di aggiornarla per assicurarti di disporre delle classi più aggiornate per la libreria che stai testando. Per aggiornare la libreria client, esegui questo comando:

      composer update google/apiclient --with-dependencies

Esegui l'esempio di codice

Utilizza il comando seguente per eseguire l'esempio:

  php sample.php

La maggior parte degli esempi stampa una risposta API (o altro) a STDOUT.

Python

Prerequisiti

  • Python 2.7 o Python 3.5+
  • Lo strumento di gestione dei pacchetti pip

  • La libreria client delle API di Google per Python:

    pip install --upgrade google-api-python-client

  • Le librerie google-auth-oauthlib e google-auth-httplib2 per l'autorizzazione dell'utente:

    pip install --upgrade google-auth-oauthlib google-auth-httplib2

Configura

  1. Segui le istruzioni nella documentazione dell'API per creare o selezionare un progetto per la tua app e abilitare l'API.
  2. A seconda del tipo di dati a cui accede il metodo, crea una chiave API (dati pubblici) o un ID client OAuth 2.0 (dati privati).
  3. Imposta il tipo di applicazione su App desktop.
  4. Se hai creato un ID client OAuth 2.0, scarica il file JSON contenente le credenziali OAuth 2.0. Il nome di questo file è simile a client_secret_CLIENTID.json, dove CLIENTID è l'ID client del tuo progetto.
  5. Copia l'esempio di codice in un file locale e modificalo per identificare correttamente la chiave API o il file dei client secret. Nell'esempio, la chiave-valore dell'API è YOUR_API_KEY e la posizione del file dei client secret è YOUR_CLIENT_SECRET_FILE.json.

Esegui l'esempio di codice

Utilizza il comando seguente per eseguire l'esempio:

  python sample.py

La maggior parte degli esempi stampa una risposta API (o altro) a STDOUT.

Ruby

Prerequisiti

  • Ruby 2.0 o versioni successive

  • La libreria client delle API di Google per Ruby:

    gem install google-api-client`

Configura

  1. Segui le istruzioni nella documentazione dell'API per creare o selezionare un progetto per la tua app e abilitare l'API.
  2. A seconda del tipo di dati a cui accede il metodo, crea una chiave API (dati pubblici) o un ID client OAuth 2.0 (dati privati).
  3. Imposta il tipo di applicazione su App desktop.
  4. Se hai creato un ID client OAuth 2.0, scarica il file JSON contenente le credenziali OAuth 2.0. Il nome di questo file è simile a client_secret_CLIENTID.json, dove CLIENTID è l'ID client del tuo progetto.
  5. Copia l'esempio di codice in un file locale e modificalo per identificare correttamente la chiave API o il file dei client secret. Nell'esempio, la chiave-valore dell'API è YOUR_API_KEY e la posizione del file dei client secret è YOUR_CLIENT_SECRET_FILE.json.

Esegui l'esempio di codice

Utilizza il comando seguente per eseguire l'esempio:

  ruby sample.rb

La maggior parte degli esempi stampa una risposta API (o altro) a STDOUT.

Risolvere i problemi di esempio

La finestra di dialogo di autorizzazione non viene visualizzata

Explorer API utilizza un popup per concedere l'accesso ai dati privati. Se il tuo browser blocca i popup, questo non verrà visualizzato e non sarai in grado di concedere l'accesso.

Se fai clic su "Consenti" nella schermata di autorizzazione e non accade nulla, prova a modificare le impostazioni popup del browser in modo da attivare i popup.

Errore 401 o 403

Se riscontri un errore 401 o 403 durante il test di un campione, è probabile che si sia verificato uno dei seguenti problemi:

  • L'API non è abilitata per il tuo progetto. Consulta le istruzioni per la tua API su come creare un progetto e abilitare un'API.
  • Stai utilizzando il tipo di autorizzazione errato (chiave API anziché OAuth 2.0).
  • Stai utilizzando OAuth 2.0, ma hai un ambito troppo limitato.
  • Quando configuri la chiave API, configuri anche delle limitazioni per impedire l'utilizzo non autorizzato delle tue credenziali. Tuttavia, la richiesta non soddisfa tali restrizioni. Per ulteriori informazioni, consulta Utilizzo delle limitazioni delle chiavi API.

Hai ricevuto un avviso sui contenuti misti

Se utilizzi Google Cloud Endpoints e esegui l'endpoint in un server di sviluppo, il browser potrebbe mostrare un avviso relativo ai contenuti misti. Questo avviso si verifica perché Explorer API viene caricato tramite HTTPS, ma quando l'API viene eseguita localmente è ospitata su HTTP.

Per nascondere questo avviso utilizzando Chrome, avvia una sessione di Chrome con flag speciali come segue:

path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port

Ad esempio:

/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080

Dovresti nascondere questo avviso solo a scopo di test locale.

Solo JavaScript: gapi non è definito

Un "gapi non è definito" si verifica un errore quando il codice JavaScript tenta di chiamare la libreria client delle API di Google per JavaScript prima che la libreria sia stata caricata. Assicurati che il codice che fa riferimento alla variabile gapi non venga chiamato fino al caricamento della libreria client.