Fare richieste dirette

Ti invitiamo a utilizzare il client librerie ed esempi per la tua implementazione. Tuttavia, se la tua integrazione con l'API ha esigenze speciali, come l'utilizzo di una lingua non supportata, effettuare richieste dirette, come descritto di seguito.

Stile di chiamata

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 mediante un verbo HTTP come POST, GET, PUT o DELETE. La risorsa viene specificata tramite un URI globalmente univoco con il 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.

Potrebbero esserti utili le definizioni dei metodi riportate nella documentazione sugli standard HTTP 1.1. includono le specifiche per GET, POST, PUT e DELETE.

REST nell'API AdSense Management

Le operazioni supportate mappano direttamente ai verbi HTTP REST, come descritto in Operazioni dell'API AdSense Management.

Il formato specifico per gli URI dell'API di gestione di AdSense è:

https://adsense.googleapis.com/v2/resourceID?parameters

dove resourceID è l'identificatore di un annuncio cliente, unità pubblicitaria, canale URL, canale personalizzato o la raccolta dei report. parameters sono i parametri da applicare a la query.

Il formato delle estensioni del percorso resourceID consente di identificare la risorsa su cui stai attualmente operando, esempio:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

Il set completo di URI utilizzati per ogni operazione supportata nell'API è riassunta nel documento di riferimento per l'API AdSense Management documento.

Ecco un paio di esempi di come funziona nell'API AdSense Management.

Elenca client pubblicitari:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

Elenca le unità pubblicitarie nel client di annunci ca-pub-1234567890123456:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

Formato dei dati

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

Autorizzazione delle richieste

Tieni presente che AdSense non supporta gli account di servizio, ma devono utilizzare il flusso Applicazione installata.

Ogni richiesta inviata dall'applicazione all'API AdSense Management deve includere un token di autorizzazione. Il token, inoltre, identifica l'applicazione per Google.

Informazioni sui protocolli di autorizzazione

La tua applicazione deve utilizzare il protocollo OAuth 2.0 per autorizzare le richieste. Non sono supportati altri protocolli di autorizzazione. Se la tua applicazione utilizza la funzionalità Accedi con Google, alcuni aspetti dell'autorizzazione vengono gestiti per te.

Autorizzazione delle richieste con OAuth 2.0

Tutte le richieste all'API AdSense Management devono essere autorizzate da un utente autenticato.

Questa procedura è facilitata da un ID client OAuth.

Ottenere un ID client OAuth

In alternativa, creane una nella pagina Credenziali.

I dettagli della procedura di autorizzazione, o "flusso", per il protocollo OAuth 2.0 variano a seconda del tipo di applicazione che stai scrivendo. La seguente procedura generale si applica a tutti i tipi di applicazione:

  1. Quando la tua applicazione vuole accedere ai dati dell'utente, chiede a Google un particolare ambito di accesso.
  2. Google mostra una schermata di consenso all'utente, chiedendo di autorizzare l'applicazione a richiedere dei dati.
  3. Se l'utente approva, Google fornisce alla tua applicazione un token di accesso di breve durata.
  4. L'applicazione richiede i dati utente, allegando il token di accesso alla richiesta.
  5. Se Google ritiene validi la richiesta e il token, restituisce i dati richiesti.

Alcuni flussi includono passaggi aggiuntivi, come l'uso di token di aggiornamento per acquisire nuovi token di accesso. Per informazioni dettagliate sui flussi per vari tipi di applicazioni, consulta la documentazione relativa al protocollo OAuth 2.0 di Google.

Ecco le informazioni relative all'ambito OAuth 2.0 per l'API AdSense Management:

Ambito Significato
https://www.googleapis.com/auth/adsense Accesso in lettura/scrittura ai dati AdSense.
https://www.googleapis.com/auth/adsense.readonly Accesso in sola lettura ai dati di AdSense.

Per richiedere l'accesso utilizzando il protocollo OAuth 2.0, l'applicazione richiede le informazioni relative all'ambito e le informazioni che Google fornisce quando registri la tua applicazione (ad esempio l'ID client e il client secret).

Suggerimento: le librerie client delle API di Google possono gestire parte del processo di autorizzazione per te. Sono disponibili per una varietà di linguaggi di programmazione; consulta la pagina delle librerie e dei campioni per maggiori dettagli.

Invio di una richiesta

Il passaggio finale consiste nell'effettuare la richiesta API. Consulta le documentazione di riferimento per specifici informazioni.