Cerca e seleziona le API di Google

1. Prima di iniziare

Questo codelab mostra come cercare e selezionare le API di Google e visualizzare le metriche API.

Prerequisiti

  • Capacità di navigare nella console Google Cloud.

Obiettivi didattici

Che cosa ti serve

2. Accedere alle API da Cloud Console

  1. Nella console Cloud, seleziona 5854836f11d5d97b.png Menu di navigazione > API e servizi > API e servizi abilitati.

Il menu di navigazione nella console Cloud che mostra

  1. Nella dashboard API e servizi, fai clic su + ABILITA API E SERVIZI per visualizzare le API disponibili.

La dashboard API e servizi che mostra l'opzione ABILITA API E SERVIZI.

Nella pagina API e servizi, puoi cercare le API in diversi modi. Se conosci il nome dell'API, puoi inserirlo nel campo Cerca API e servizi nella parte superiore della pagina. Puoi anche filtrare le API per categoria con i filtri sul lato della pagina.

Un elenco di API risultanti dal campo Cerca API e servizi.

  1. Nel menu CATEGORIA, seleziona Machine learning per visualizzare solo le API di machine learning.

API filtrate per CATEGORIA per mostrare solo le API di machine learning.

  1. Dalle API di machine learning, seleziona API Cloud Natural Language per visualizzare i dettagli di questa API.
  2. Fai clic su ABILITA per abilitare questa API nel progetto appropriato.

Il riquadro dell'API Cloud Natural Language mostra i pulsanti ABILITA e PROVA QUESTA API.

Quando abiliti l'API, viene visualizzata la pagina Panoramica dell'API. Puoi visualizzare le metriche relative al tuo utilizzo di questa API, che contiene pochissime informazioni perché l'hai abilitata di recente.

La pagina Panoramica dell'API selezionata che mostra le metriche per l'API.

In un futuro codelab, scoprirai di più su come creare le credenziali, ma se sei curioso, fai clic su CREA CREDENZIALI e poi rispondi alle domande presentate.

  1. Fai clic su GESTISCI per tornare alla panoramica del passaggio precedente.

Pagina di panoramica dell'API Cloud Natural Language.

  1. Per provare l'API (anche prima di abilitarla), fai clic su PROVA QUESTA API.

In genere, viene visualizzata una pagina della documentazione dell'API. Per alcune API, tuttavia, non esiste un modo immediato per provarle perché hanno molti metodi diversi. Questo è il caso dell'API Cloud Natural Language.

La pagina di riferimento dell'API Cloud Natural Language.

  1. Seleziona il metodo analyzeEntitites.

Dovresti visualizzare una pagina web con i dettagli sui metodi dell'API e un riquadro Prova questa API.

Pagina del metodo analyzeEntities che mostra i dettagli del metodo e un riquadro Prova questa API.

  1. Per provare una query di esempio, aggiungi un oggetto document al campo Corpo della richiesta con questi parametri. Fai clic sulle icone + per espandere le opzioni del campo.
  2. Nel campo content:, inserisci il testo da analizzare.

Questo esempio utilizza Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.

  1. Nel campo type:, seleziona PLAIN_TEXT.

Il corpo della richiesta dovrebbe avere il seguente aspetto:

Il riquadro del corpo della richiesta mostra i parametri del corpo della richiesta.

Per ulteriori informazioni su ogni parametro, consulta la documentazione.

  1. Deseleziona la casella di controllo Google OAuth 2.0 e poi fai clic su Esegui per ottenere una risposta con i dettagli sulle entità.

Risposta 200 con dettagli sulle entità.

  1. Deseleziona la casella di controllo Chiave API e poi fai di nuovo clic su Esegui.

Quando esegui la query questa volta, ricevi un errore come questo perché l'API richiede le credenziali per essere eseguita.

Risposta 403 per la richiesta con credenziali mancanti.

  1. Seleziona la casella di controllo Google OAuth 2.0 e poi fai di nuovo clic su Esegui.

OAuth 2.0 fornisce le autorizzazioni API sul tuo account e mostra un avviso.

Avviso OAuth 2.0 che indica che Explorer API di Google vuole accedere al tuo Account Google.

Se consenti l'accesso, riceverai la stessa risposta che hai ricevuto con le chiavi API. Se utilizzi l'API in un'app e devi concedere l'accesso a persone che conoscono le proprie credenziali, devi utilizzare OAuth 2.0. Se è sufficiente che l'app acceda all'API per l'utente, puoi utilizzare le chiavi API.

3. Visualizzare le metriche API con Esplora metriche

Puoi visualizzare la cronologia delle chiamate per una singola API dalla pagina Panoramica API, come mostrato nel passaggio 6 di Accedere alle API da Cloud Console. Tuttavia, per visualizzare altre metriche per tutto l'utilizzo dell'API, utilizza Esplora metriche.

  1. Nella sezione Operazioni del f6b6844bf5688982.png menu di navigazione, fai clic su Monitoring > Metrics Explorer.

La sezione Operazioni del menu di navigazione in cui sono selezionate le opzioni Monitoraggio ed Esplora metriche.

  1. Nel menu Tipo di risorsa, seleziona API utilizzata come tipo di metrica. Se non lo vedi, deseleziona la casella di controllo Mostra solo attivi.

ca850c4295ef4ec9.png

  1. Nel menu Metrica, seleziona una delle singole metriche per le API, ad esempio Conteggio richieste, per vedere quante API sono state chiamate nel periodo specificato.

Esplora metriche che mostra le metriche delle API utilizzate per il conteggio delle richieste.

  1. Per personalizzare ulteriormente l'output, imposta un aggregatore e regola il periodo di tempo. Esplora metriche che mostra le metriche delle API utilizzate per il conteggio delle richieste con un aggregatore e un periodo di tempo specificati.

4. Utilizzare OAuth 2.0 Playground per provare le API

Puoi anche utilizzare OAuth 2.0 Playground per provare le API di Google. Con OAuth 2.0 Playground, puoi selezionare un'API, autorizzarla, inviare richieste e visualizzare le risposte nella finestra della console di OAuth 2.0 Playground.

  1. Apri OAuth 2.0 Playground.

OAuth 2.0 Playground che mostra un elenco di API che puoi provare.

  1. Fai clic su API Cloud Natural Language > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Autorizza API.

OAuth 2.0 Playground che mostra le API Cloud Natural Language selezionate.

  1. Se necessario, accedi al tuo Account Google e poi fai clic su Consenti per ottenere un codice di autorizzazione.
  2. Fai clic su Exchange authorization code for tokens (Scambio codice di autorizzazione per i token).

Riquadro Scambia codice di autorizzazione per i token, da cui puoi fare clic su Scambia codice di autorizzazione per i token.

Ora puoi effettuare una richiesta dell'API.

  1. Fai clic su Elenca le operazioni possibili per esaminare tutte le possibili chiamate API.

In precedenza hai aperto la pagina informativa del documento analyzeEntities dell'API Natural Language, quindi puoi vedere che l'URL della richiesta HTTP è:

https://language.googleapis.com/v1beta2/documents:analyzeEntities

Si tratta di una richiesta POST.

Configura la richiesta nel riquadro API, da cui puoi selezionare il metodo HTTP, registrare l'URI della richiesta, inserire il corpo della richiesta e inviarla.

  1. Inserisci le informazioni sull'URI della richiesta e aggiungi un corpo della richiesta.

Puoi utilizzare lo stesso corpo utilizzato in Explorer API.

Riquadro del corpo della richiesta.

  1. Fai clic su Chiudi > Invia richiesta.

Dovresti ottenere risultati simili a quelli mostrati in questa immagine:

Il riquadro Richiesta/Risposta OAuth 2.0 dopo la pubblicazione della richiesta.

Puoi sperimentare altre API in OAuth 2.0 Playground.

5. Esegui la pulizia

È una pratica sconsigliata avere una chiave API senza restrizioni per i progetti. Se qualcuno vi accede, può utilizzarlo senza ulteriori necessità di autenticazione.

Per eliminare questa chiave API:

  1. Fai clic su f6b6844bf5688982.png Menu di navigazione > API e servizi > Credenziali.
  2. In Chiavi API, seleziona la chiave da eliminare e poi fai clic su 247adf2e1d1eae4b.png.
  3. Allo stesso modo, anziché preoccuparti che la chiave privata dell'account di servizio non sia protetta, nella sezione Account di servizio, seleziona l'account di servizio da eliminare e poi fai clic su 247adf2e1d1eae4b.png.

6. Complimenti

Complimenti! Hai imparato a cercare e selezionare le API di Google e a visualizzarne le metriche.