Intestazioni per l'autorizzazione e HTTP

Nota: se non hai mai utilizzato l'API Google Ads, ti consigliamo di leggere prima la guida introduttiva, che spiega come configurare l'account ed effettuare la prima chiamata API. Assicurati di seguire la scheda curl.

Quando chiami l'API Google Ads, hai bisogno sia delle credenziali OAuth 2.0 sia di un token sviluppatore. Se effettui chiamate API con un account amministratore Google Ads, devi anche specificare un'intestazione login-customer-id con ogni richiesta. Questa pagina descrive come impostare questi valori e documenta diverse intestazioni HTTP aggiuntive specifiche dell'API che vengono inviate e ricevute quando si utilizza l'interfaccia REST.

Credenziali OAuth 2.0

L'API Google Ads utilizza OAuth 2.0 per autorizzare le richieste API. Sono supportati sia il flusso di autenticazione utente OAuth 2.0 sia il flusso dell'account di servizio . Per maggiori dettagli, consulta OAuth 2.0 nell'API Google Ads.

Se non hai mai utilizzato le API di Google, puoi utilizzare gcloud CLI o OAuth 2.0 Playground per sperimentare con le credenziali OAuth 2.0 e l'API Google Ads prima di scrivere il codice per la tua app.

Ti consigliamo di utilizzare una delle librerie OAuth 2.0 disponibili all'indirizzo https://oauth.net/code/ per implementare i flussi di lavoro di autorizzazione OAuth 2.0. Tuttavia, abbiamo elencato le istruzioni curl nel caso in cui tu debba implementarle autonomamente.

Service account

Segui i passaggi per configurare un progetto Google Cloud per l'API Google Ads. Registra l'indirizzo email del service account e la chiave del service account. Poi, segui le istruzioni comuni nella guida ai service account per configurare il service account in modo che acceda al tuo account Google Ads.

Autenticazione degli utenti

Segui i passaggi per configurare un progetto della console Google Cloud per l' API Google Ads. Registra l'ID client e il client secret. Poi, segui le istruzioni del flusso dell'app desktop o le istruzioni del flusso dell'app web per generare un token di aggiornamento e un token di accesso. Il scope da utilizzare per l'accesso all'API Google Ads è https://www.googleapis.com/auth/adwords.

Generare nuovi token di accesso

Service account

Quando hai l'indirizzo email del service account e la chiave del service account, segui la guida Utilizzare OAuth 2.0 per le applicazioni server-to-server per generare un set di attestazioni JWT, che può quindi essere scambiato per ottenere un token di accesso OAuth 2.0. Assicurati di selezionare la scheda HTTP/REST mentre segui la guida. L'ambito OAuth 2.0 da utilizzare per l'accesso all'API Google Ads è https://www.googleapis.com/auth/adwords.scope Inoltre, puoi saltare il parametro sub quando crei il set di rivendicazioni JWT, perché i passaggi di configurazione concedono al service account l'accesso diretto all'account Google Ads, evitando così la necessità di impersonare un utente Google Ads.

Poi, utilizzi il token di accesso nell'intestazione HTTP Authorization di ogni chiamata API all'API Google Ads:

GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

Autenticazione degli utenti

Una volta che hai un ID client, un client secret e un token di aggiornamento OAuth 2.0, puoi generare un nuovo token di accesso da utilizzare nelle chiamate API con lo strumento a riga di comando curl:

Nota: La versione v3 nell'URL dell'endpoint OAuth non è correlata alla versione dell'API Google Ads e non deve essere modificata durante la migrazione alle versioni più recenti dell'API Google Ads.

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Poi, utilizzi il token di accesso restituito dalla richiesta curl nell'intestazione HTTP Authorization di ogni chiamata API all'API Google Ads:

GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

Intestazioni delle richieste

Le seguenti sezioni descrivono le intestazioni HTTP richieste o utilizzate quando si effettuano richieste all'API Google Ads.

Token sviluppatore

L'API Google Ads richiede anche un token sviluppatore per effettuare chiamate all'API. Se hai già un token sviluppatore, puoi trovarlo andando all'indirizzo https://ads.google.com/aw/apicenter. Se ti viene richiesto, accedi al tuo account amministratore Google Ads. Se non ne hai uno, segui le istruzioni per registrarti e ottenere un token sviluppatore.

Devi includere il valore del token sviluppatore nell'intestazione HTTP developer-token di ogni chiamata API all'API Google Ads:

GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

ID cliente di accesso

Per le chiamate API Google Ads effettuate da un amministratore a un account cliente (ovvero quando accedi come amministratore per effettuare chiamate API a uno dei suoi account cliente), devi anche fornire l'intestazione HTTP login-customer-id. Questo valore rappresenta l'ID cliente Google Ads dell'amministratore che effettua la chiamata API.

L'inclusione di questa intestazione equivale a scegliere un account nell'interfaccia utente di Google Ads dopo aver eseguito l'accesso o aver fatto clic sulla tua immagine del profilo nell'angolo in alto a destra della pagina. Quando specifichi l'ID cliente, assicurati di rimuovere eventuali trattini (—). Ad esempio: 1234567890, non 123-456-7890. Per saperne di più sull'ID cliente di accesso, consulta la guida al modello di accesso a Google Ads.

GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

Punto chiave: se non stai autorizzando come account amministratore, in altre parole se le tue credenziali OAuth 2.0 sono per un utente dell'account cliente Google Ads di destinazione direttamente, non devi fornire un'intestazione login-customer-id header.

ID cliente collegato

L'intestazione ID cliente collegato viene utilizzata dai partner (ad esempio fornitori di analisi di app di terze parti o partner di dati) quando agiscono su un account Google Ads collegato. Per maggiori dettagli, consulta la guida alla struttura delle chiamate API.

Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: PARTNER_CUSTOMER_ID
linked-customer-id: ADVERTISER_CUSTOMER_ID

Intestazioni della risposta

Le seguenti intestazioni vengono restituite nelle risposte HTTP dell'API.

ID richiesta

request-id è una stringa che identifica in modo univoco la richiesta API. Quando esegui il debug o la risoluzione dei problemi relativi a chiamate API specifiche, request-id è un identificatore importante da tenere a portata di mano quando contatti l'assistenza per gli sviluppatori di Google.

Suggerimento: per visualizzare le intestazioni delle risposte, inclusa google-ads-request-id, quando utilizzi curl, aggiungi il flag -i o --include al comando.

request-id: 2a5Cj89VV7CNhya1DZjjrC