Configurazione di base

Per continuare, assicurati di aver completato i passaggi descritti in Prerequisiti e che abbiamo approvato il tuo progetto per Profilo dell'attività Accesso alle API.

Abilita le API

Esistono otto API associate a Profilo dell'attività che devono essere abilitate nell'API di Google Console:

  • 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 le persone hanno ricevuto l'accesso all'API, ma non è ancora possibile per utilizzare la scorciatoia fornita, puoi abilitare l'API manualmente seguendo questi passaggi.

Per abilitare un'API per il tuo progetto, segui questi passaggi:

  1. Apri la libreria API nella console API di Google. Se richiesto, seleziona progetto o crearne uno nuovo. Nella Libreria API sono elencate tutte le opzioni disponibili API raggruppate per famiglia di prodotti e popolarità.
  2. Se l'API che vuoi abilitare non è visibile nell'elenco, utilizza la ricerca per a trovarlo.
  3. Seleziona l'API da abilitare e fai clic su Abilita. .
  4. Se richiesto, abilita la fatturazione.
  5. 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é l'app accede a dati protetti e non pubblici, è necessario ID client OAuth 2.0. In questo modo la tua app richiede ad accedere ai dati sulla posizione della tua organizzazione per conto degli utenti dell'app.

La tua applicazione deve inviare un token OAuth 2.0 con qualsiasi richiesta API Profilo dell'attività che accede a dati utente privati.

Se non l'hai ancora fatto, vai alla sezione "Credenziali" sezione del Console API di Google e fai clic su Crea le credenziali > ID client OAuth per creare le tue credenziali OAuth 2.0. Dopo aver le credenziali create, puoi vedere il tuo ID client nella pagina Credenziali. Fai clic sull' ID client per dettagli come client secret, URI di reindirizzamento, indirizzo origini JavaScript ed 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 alle richiedere e modificare i dati.

Il termine REST è l'abbreviazione di "Trasferimento dello stato rappresentativo." Nel contesto delle API di Google, si riferisce all'uso di verbi HTTP per recuperare e modificare le rappresentazioni dei dati memorizzati da Google.

Un sistema RESTful archivia le risorse in un datastore. Un client invia una richiesta server 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 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 tramite un URI (Uniform Resource Identifier) univoco a livello globale con il seguente formato:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

Poiché tutte le risorse API hanno URI univoci accessibili tramite HTTP, REST abilita la memorizzazione nella cache dei dati ottimizzate per funzionare con l'infrastruttura distribuita del web.

Potresti trovare definizioni dei metodi nella documentazione degli standard HTTP 1.1 utile. 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

L'insieme completo di URI utilizzati per ogni operazione supportata nelle API viene visualizzato nelle API di Profilo dell'attività di riferimento.

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.

JavaScript Object Notation (JSON) è un formato di dati comune e indipendente dal linguaggio che fornisce una semplice rappresentazione testuale di strutture di dati arbitrarie. Per ulteriori informazioni, vedi json.org.

Utilizzare Oauth Playground per effettuare una semplice richiesta HTTP

Puoi utilizzare lo OAuth 2.0 Playground per sperimentare con le API di Profilo dell'attività. Poiché le API di Profilo dell'attività non sono API pubbliche, ma per utilizzarle in Playground devi eseguire alcuni passaggi aggiuntivi. Tu occorre un ID client per un'applicazione web per continuare.

  1. Vai alla console API di Google. e apriamo il tuo progetto. Se non hai un ID client OAuth per le applicazioni web, creane uno ora:
    1. Nell'elenco a discesa Crea credenziali, seleziona ID client OAuth.
    2. In Tipo di applicazione, fai clic su Web Application.
    3. Aggiungi quanto segue come URI di reindirizzamento valido:

       https://developers.google.com/oauthplayground
       
    4. Fai clic su Crea.
  2. Copia l'ID client negli appunti.
  3. Vai a OAuth 2.0 Playground.
  4. Fai clic sull'icona a forma di ingranaggio per aprire le opzioni di configurazione e apportare le seguenti modifiche:
    1. Imposta Flusso OAuth su Lato client.
    2. Seleziona Utilizza le tue credenziali OAuth.
    3. Incolla il tuo ID client OAuth.
  5. Chiudi le opzioni di configurazione.
  6. In "Passaggio 1 - Seleziona & autorizzare le API" e incolla il seguente ambito Le API di Profilo dell'attività nel campo Inserisci i tuoi ambiti:

    https://www.googleapis.com/auth/business.manage
    
  7. Fai clic su Autorizza API.
  8. Fai clic su Accetta quando richiesto.
  9. In "Passaggio 2 - Configura la richiesta all'API", incolla il seguente URI Campo URI della richiesta:

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
    
  10. Fai clic su Invia la richiesta. La risposta dovrebbe mostrare lo stato 200 OK.

Per ulteriori informazioni su come effettuare vari tipi di richieste, consulta consulta il Riferimento alle API di Profilo dell'attività.

Librerie client

Le librerie client delle API di Profilo dell'attività supportano la funzionalità di queste API. Forniscono comuni a tutte le API di Google, come trasporto HTTP, gestione degli errori, autenticazione, e JSON.

Per scaricare le librerie client, consulta Librerie.