Prerequisiti

Questo documento descrive le operazioni da eseguire prima di scrivere la prima applicazione client.

Crea un account Google

Per utilizzare questa API devi avere un Account Google. Per richiamare quel metodo, il tuo account deve disporre dell'autorizzazione Search Console appropriata per una determinata proprietà. Ad esempio, per eseguire searchAnalytics.query devi disporre delle autorizzazioni di lettura per quella proprietà.

Prova Google Search Console

Questa documentazione dell'API presuppone che tu abbia utilizzato Google Search Console e che tu conosca i concetti della programmazione web e i formati dei dati web.

Se non hai utilizzato Google Search Console, prova l'interfaccia utente prima di iniziare a programmare. Ogni API rappresenta la funzionalità di un report in Search Console. Prima di utilizzare un'API, è necessario leggere la documentazione del report equivalente per comprendere i dati ricevuti.

Creare un progetto e le credenziali per il client

Prima di poter inviare richieste a Google Search Console, devi comunicare a Google il tuo client e attivare l'accesso all'API. A tale scopo, utilizza la console API di Google per creare un progetto, ovvero una raccolta denominata di impostazioni e informazioni relative all'accesso all'API, e registra la tua applicazione.

Tutte le API Search Console ad eccezione dell'API Testing Tools richiedono credenziali OAuth2. Le guide rapide di Python e Java forniscono dettagli su come creare un progetto e ottenere le credenziali per il client.

Nozioni di base su REST

Esistono due modi per richiamare l'API:

  • Inviare richieste HTTP e analizzarne le risposte.
  • Utilizzare le librerie client.

Se decidi di non utilizzare le librerie client, è necessario che tu conosca le nozioni di base di REST.

Nozioni di base su REST

REST è un tipo di architettura software che fornisce un approccio pratico e coerente per la richiesta e la modifica dei dati.

Il termine REST è l'acronimo 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 archiviati da Google.

In un sistema RESTful, le risorse vengono archiviate in un datastore. Un client invia una richiesta affinché il server esegua una determinata azione (ad esempio la creazione, il recupero, l'aggiornamento o l'eliminazione di una risorsa) e il server esegue l'azione e invia una risposta, spesso sotto forma di rappresentazione della risorsa specificata.

Nelle API RESTful di Google, il client specifica un'azione utilizzando un verbo HTTP come POST, GET, PUT o DELETE. Specifica una risorsa mediante un URI univoco a livello globale nel seguente formato:

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

Poiché tutte le risorse dell'API dispongono di URI univoci accessibili tramite HTTP, REST consente la memorizzazione dei dati nella cache ed è ottimizzato per operare con l'infrastruttura distribuita del Web.

Potresti trovare utili le definizioni dei metodi nella documentazione degli standard HTTP 1.1, in cui sono incluse le specifiche per GET, POST, PUT e DELETE.

REST nell'API Google Search Console

Le operazioni dell'API Google Search Console vengono mappate direttamente ai verbi HTTP REST.

Il formato della maggior parte degli URI dell'API Google Search Console è simile al seguente:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

L'insieme completo di URI e verbi utilizzati per ogni metodo è riportato nella panoramica Riferimento API di Google Search Console.

Nozioni di base su JSON

L'API Google Search Console restituisce i dati in formato JSON.

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