Le chiamate all'API Search Ads 360 Reporting vengono in genere effettuate tramite la libreria client. Per ulteriori informazioni, consulta la sezione Descrizione delle librerie client. Tuttavia, la conoscenza della struttura dei dettagli della richiesta sottostante può essere utile durante i test e il debug.
L'API Search Ads 360 Reporting è un'API gRPC con associazioni REST. Ciò significa che puoi effettuare chiamate all'API in due modi alternativi:
- Metodo preferito
- Utilizza una libreria client:
- Crea il corpo della richiesta come buffer di protocollo.
- Invia la richiesta al server utilizzando HTTP/2.
- Deserializza la risposta in un buffer del protocollo.
- Interpreta i risultati.
- Metodo alternativo facoltativo
- Usa REST:
- Crea il corpo della richiesta come oggetto JSON.
- Invia la richiesta al server utilizzando HTTP 1.1.
- Deserializza la risposta come oggetto JSON.
- Interpreta i risultati.
Per ulteriori informazioni, consulta API Google Cloud.
Le sezioni seguenti si applicano sia ai protocolli gRPC sia a quelli REST.
Nomi delle risorse
La maggior parte degli oggetti nell'API è identificata dalle stringhe dei nomi delle risorse. Queste stringhe fungono anche da URL quando si utilizza l'interfaccia REST.
Consulta Riferimento > REST per ulteriori informazioni sulle risorse supportate e sulla loro rappresentazione del percorso. Lo stesso formato viene utilizzato per altri servizi.
ID composti
Se l'ID di un oggetto non è univoco a livello globale, viene creato un ID composito per quell'oggetto anteponendo il relativo ID principale e una tilde (~).
Ad esempio, poiché un ID annuncio del gruppo di annunci non è univoco a livello globale, viene anteposto l'ID dell'oggetto principale (gruppo di annunci) ottenendo un ID composito univoco.
Esempio: AdGroupId di 123 + ~ + AdGroupAdId di 45678
= ID annuncio del gruppo di annunci composito di 123~45678.
Intestazioni delle richieste
Le intestazioni HTTP (o i metadati gRPC) nelle sezioni seguenti devono essere incluse nel corpo della richiesta.
Autorizzazione
Devi includere un token di accesso OAuth2 nel modulo:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
Il token deve identificare un account amministratore che agisce per conto di un cliente o un inserzionista che gestisce direttamente il proprio account amministratore secondario o cliente. Per saperne di più, consulta Informazioni sugli account amministratore Search Ads 360 e Autenticazione.
Intestazione ID cliente di accesso
L'intestazione login-customer-id è obbligatoria quando si utilizza un account amministratore per accedere a un account amministratore secondario o cliente. Non è necessario quando si accede direttamente a un account amministratore secondario o cliente. Sebbene non sia strettamente necessario, consigliamo di specificare sempre login-customer-id per gli utenti autenticati che hanno accesso a più account. In questo modo si evitano ambiguità e si impedisce di impostare involontariamente il contesto sull'account errato.
La richiesta deve includere l'ID cliente dell'utente autorizzato, senza trattini (-), ad esempio:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
L'impostazione di login-customer-id è equivalente alla scelta di un account nell'interfaccia utente di Search Ads 360 dopo aver eseguito l'accesso o aver fatto clic sull'immagine del profilo in alto a destra.
Intestazioni della risposta
Le seguenti intestazioni (o gRPC trailing-metadata) vengono restituite con il corpo della risposta. Ti consigliamo di registrare questi valori per scopi di debug.
ID richiesta
L'intestazione request-id è una stringa che identifica in modo univoco la richiesta.