Per procedere, assicurati di aver completato i passaggi descritti in Prerequisiti e che abbiamo approvato il tuo progetto per l'accesso alle API Business Profile.
Abilita le API
Esistono otto API associate a Profilo dell'attività che devono essere attivate 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 attivare l'API manualmente seguendo i passaggi che seguono.
Per attivare un'API per il tuo progetto:
- 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 attivare non è visibile nell'elenco, utilizza la ricerca per trovarla.
- Seleziona l'API che vuoi attivare, poi fai clic sul pulsante Attiva.
- 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 attivo per il tuo account nella tua organizzazione Google Workspace. Quando utilizzi le API GBP, viene visualizzato l'errore "403 - PERMISSION DENIED" (Errore 403: autorizzazione negata) se Profilo dell'attività su Google è disattivato per il tuo account nell'organizzazione Google Workspace.
Richiedere un ID client OAuth 2.0
Poiché la tua app accede a dati protetti e non pubblici, devi disporre di un ID client OAuth 2.0. In questo modo, la tua app può richiedere l'autorizzazione per accedere ai dati sulla posizione della tua organizzazione per conto degli utenti dell'app.
L'applicazione deve inviare un token OAuth 2.0 con qualsiasi richiesta delle API Business Profile che accede ai dati utente privati.
Se non l'hai ancora fatto, vai alla sezione "Credenziali" della console API Google e fai clic su Crea credenziali > ID client OAuth per creare le credenziali OAuth 2.0. Dopo aver creato le credenziali, puoi visualizzare il tuo ID client nella pagina Credenziali. Fai clic sull'ID cliente per visualizzare i dettagli, ad esempio il segreto client, gli URI di reindirizzamento, l'indirizzo delle origini JavaScript e l'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 fornisce un approccio pratico 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 dei verbi HTTP per recuperare e modificare le rappresentazioni dei dati memorizzati da Google.
Un sistema RESTful memorizza le risorse in un data store. Un client invia una richiesta al server affinché esegua un'azione specifica, ad esempio creare, recuperare, aggiornare o eliminare una risorsa, e il server esegue l'azione e invia una risposta. Questa risposta è spesso sotto forma di representation della risorsa specificata.
Nelle API RESTful di Google, il client specifica un'azione con un verbo HTTP, ad esempio
GET, POST, PUT o DELETE. Il client specifica
una risorsa tramite un URI (Uniform Resource Identifier) univoco a livello globale del seguente formato:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Poiché tutte le risorse dell'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.
Potresti trovare utili le
definizioni dei metodi nella documentazione degli standard HTTP 1.1. Sono incluse le specifiche per GET, POST, PUT e
DELETE.
REST nelle API Business Profile
Le operazioni delle API Business Profile vengono mappate direttamente ai verbi HTTP REST.
Il formato specifico per le API Business Profile è mostrato nel seguente URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
L'insieme completo di URI utilizzati per ogni operazione supportata nelle API è riportato nella documentazione di riferimento delle API Business Profile.
I percorsi delle risorse variano in base all'endpoint.
Ad esempio, il percorso della risorsa di un account è visualizzato come 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 Business Profile restituiscono i dati in formato JSON.
JavaScript Object Notation (JSON) è un formato di dati comune e indipendente dal linguaggio che fornisce una semplice rappresentazione di testo di strutture di dati arbitrarie. Per ulteriori informazioni, visita la pagina json.org.
Utilizzare Oauth Playground per effettuare una semplice richiesta HTTP
Puoi utilizzare OAuth 2.0 Playground per fare esperimenti con le API Business Profile. Poiché le API Business Profile non sono API pubbliche, devi eseguire alcuni passaggi aggiuntivi per utilizzarle in Playground. Per procedere, è necessario un ID client per un'applicazione web.
- Vai alla console API di Google e apri il progetto. Se non hai un ID client OAuth per le applicazioni web, creane uno subito:
- Nell'elenco a discesa Crea credenziali, seleziona ID client OAuth.
- In Tipo di applicazione, fai clic su Applicazione web.
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 apporta 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 Business Profile nel campo Inserisci i tuoi ambiti:
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 URI richiesta:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Fai clic su Invia richiesta. La risposta deve mostrare lo stato
200 OK.
Per saperne di più su come effettuare vari tipi di richieste, consulta il riferimento alle API Business Profile.
Librerie client
Le librerie client delle API Business Profile supportano la funzionalità delle API Business Profile. Forniscono funzionalità comuni a tutte le API Google, come il trasporto HTTP, la gestione degli errori, l'autenticazione e l'analisi di JSON.
Per scaricare le librerie client, consulta Librerie.