Per procedere, assicurati di aver completato i passaggi descritti in Prerequisiti e di aver approvato l'accesso alle API di Profilo dell'attività per il tuo progetto.
Abilita le API
Esistono otto API associate a Profilo dell'attività che devono essere abilitate nella console API di Google:
- API Google My Business
- API My Business Account Management
- API My Business Lodging
- API My Business Place Actions
- API My Business Notifications
- API My Business Verifications
- API My Business Business Information
- API My Business Q&A
Abilita un'API
Se hai completato tutti i prerequisiti e ti è stato concesso l'accesso all'API, ma non riesci ancora a utilizzare la scorciatoia fornita, puoi abilitare l'API manualmente seguendo questa procedura.
Per abilitare un'API per il tuo progetto, segui questi passaggi:
- Apri la libreria API nella console API di Google. Se richiesto, seleziona un progetto o creane uno nuovo. La libreria API elenca tutte le API disponibili, raggruppate per famiglia di prodotti e popolarità.
- Se l'API che vuoi abilitare non è visibile nell'elenco, utilizza la ricerca per trovarla.
- Seleziona l'API da abilitare e fai clic sul pulsante Abilita.
- Se richiesto, abilita la fatturazione.
- Se richiesto, accetta i Termini di servizio dell'API.
Se sei un utente di Google Workspace, verifica che Profilo dell'attività su Google sia attivato per il tuo account nella tua organizzazione Google Workspace. Se il Profilo dell'attività su Google è disattivato per il tuo account nella tua organizzazione Google Workspace, riceverai il messaggio "errore 403 - PERMISSION DENIED".
Richiedere un ID client OAuth 2.0
Poiché la tua app accede a dati protetti e non pubblici, è necessario un ID client OAuth 2.0. Ciò consente alla tua app di richiedere l'autorizzazione ad accedere ai dati sulla posizione dell'organizzazione per conto degli utenti dell'app.
La tua applicazione deve inviare un token OAuth 2.0 con qualsiasi richiesta delle API Profilo dell'attività che accede ai dati privati degli utenti.
Se non l'hai ancora fatto, vai alla sezione "Credenziali" della console API di Google e fai clic su Crea credenziali > ID client OAuth per creare le tue credenziali OAuth 2.0. Dopo aver creato le credenziali, potrai visualizzare il tuo ID client nella pagina Credenziali. Fai clic sull'ID client per dettagli quali client secret, URI di reindirizzamento, indirizzo origini JavaScript e indirizzo email.
Apprendere le nozioni di base di REST
Esistono due modi per richiamare le API:
- Invia una richiesta HTTP e analizza le risposte.
- Utilizza le librerie client.
Se decidi di non utilizzare le librerie client, devi conoscere le nozioni di base di REST.
REST è uno stile di architettura software che offre un approccio comodo e coerente per richiedere e modificare i dati.
Il termine REST è l'abbreviazione di "Representational State Transfer". Nel contesto delle API di Google, si riferisce all'utilizzo di verbi HTTP per recuperare e modificare le rappresentazioni dei dati archiviati da Google.
Un sistema RESTful archivia le risorse in un datastore. Un client invia al server una richiesta per eseguire una determinata azione, come creare, recuperare, aggiornare o eliminare una risorsa, e il server esegue l'azione e invia una risposta. Questa risposta è spesso sotto forma di rappresentazione della risorsa specificata.
Nelle API RESTful di Google, il client specifica un'azione con un verbo HTTP, come
GET, POST, PUT o DELETE. Il client specifica una risorsa tramite un URI (Uniform Resource Identifier) univoco globale con il seguente formato:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Poiché tutte le risorse API hanno URI univoci accessibili tramite HTTP, REST consente la memorizzazione nella cache dei dati ed è ottimizzato per funzionare con l'infrastruttura distribuita del web.
Potrebbero esserti utili le definizioni dei metodi riportate nella documentazione degli standard HTTP 1.1. Includono le specifiche per GET, POST, PUT e
DELETE.
REST nelle API di Profilo dell'attività
Le operazioni delle API Profilo dell'attività vengono mappate direttamente ai verbi HTTP REST.
Il formato specifico per le API Profilo dell'attività è mostrato nel seguente URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Il set completo di URI utilizzati per ogni operazione supportata nelle API viene visualizzato nella documentazione di riferimento delle API di Profilo dell'attività.
I percorsi delle risorse variano in base all'endpoint.
Ad esempio, il percorso della risorsa per un account è quello visualizzato nell'esempio seguente:
accounts/accountId
Il percorso della risorsa per una località viene visualizzato nel seguente formato:
locations/locationId
Apprendere le nozioni di base di JSON
Le API Profilo dell'attività restituiscono i dati in formato JSON.
JSON (JavaScript Object Notation) è un formato di dati comune e indipendente dal linguaggio che fornisce una semplice rappresentazione testuale di strutture di dati arbitrarie. Per maggiori informazioni, visita il sito json.org.
Utilizzare Oauth Playground per effettuare una semplice richiesta HTTP
Puoi utilizzare OAuth 2.0 Playground per sperimentare le API di Profilo dell'attività. Poiché le API di Profilo dell'attività non sono API pubbliche, per utilizzarle in Playground sono necessari alcuni passaggi aggiuntivi. Per continuare, un'applicazione web deve disporre di un ID client.
- Vai alla console API di Google e apri il tuo progetto. Se non hai un ID client OAuth per le applicazioni web, creane uno ora:
- Nell'elenco a discesa Crea credenziali, seleziona ID client OAuth.
- In Tipo di applicazione, fai clic su Web Application.
Aggiungi quanto segue come URI di reindirizzamento valido:
https://developers.google.com/oauthplayground
- Fai clic su Crea.
- Copia l'ID client negli appunti.
- Vai a OAuth 2.0 Playground.
- Fai clic sull'icona a forma di ingranaggio per aprire le opzioni di configurazione e apportare le seguenti modifiche:
- Imposta Flusso OAuth su Lato client.
- Seleziona Utilizza le tue credenziali OAuth.
- Incolla il tuo ID client OAuth.
- Chiudi le opzioni di configurazione.
In "Passaggio 1 - Seleziona e autorizza le API ", incolla il seguente ambito per le API di Profilo dell'attività nel campo Inserisci gli ambiti personalizzati:
https://www.googleapis.com/auth/business.manage
- Fai clic su Autorizza API.
- Fai clic su Accetta quando richiesto.
-
In "Passaggio 2 - Configura la richiesta all'API", incolla il seguente URI nel campo URI della richiesta:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Fai clic su Invia la richiesta. La risposta dovrebbe mostrare lo stato
200 OK.
Per saperne di più su come effettuare vari tipi di richieste, consulta il Riferimento alle API del profilo dell'attività.
Librerie client
Le librerie client delle API di Profilo dell'attività supportano la funzionalità di queste API. Forniscono funzionalità comuni a tutte le API di Google, come trasporto HTTP, gestione degli errori, autenticazione e analisi JSON.
Per scaricare le librerie client, consulta Librerie.