- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
Restituisce tutte le righe che corrispondono alla query dello stream di ricerca.
Elenco degli errori generati: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError
Richiesta HTTP
POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
customerId |
obbligatorio. L'ID del cliente su cui viene eseguita la query. |
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"query": string,
"batchSize": integer,
"summaryRowSetting": enum ( |
Campi | |
---|---|
query |
obbligatorio. La stringa di query. |
batchSize |
Il numero di righe restituite in ogni batch di risposte in modalità flusso. Quando viene richiesto un batch troppo grande, il server può decidere di limitare ulteriormente il numero di righe restituite. |
summaryRowSetting |
Determina se verrà restituita una riga di riepilogo. Per impostazione predefinita, la riga di riepilogo non viene restituita. Se richiesta, la riga di riepilogo verrà inviata da sola in una risposta dopo che saranno stati restituiti tutti gli altri risultati della query. |
Corpo della risposta
Messaggio di risposta per SearchAds360Service.SearchStream
.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "results": [ { object ( |
Campi | |
---|---|
results[] |
L'elenco di righe che corrispondono alla query. |
fieldMask |
FieldMask che rappresenta i campi richiesti dall'utente. Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: |
summaryRow |
Riga di riepilogo che contiene il riepilogo delle metriche nei risultati. Con il riepilogo delle metriche si intende l'aggregazione delle metriche su tutti i risultati; in questo caso, l'aggregazione potrebbe essere somma, media, tasso e così via. |
customColumnHeaders[] |
Le intestazioni delle colonne personalizzate nei risultati. |
conversionCustomMetricHeaders[] |
Le intestazioni delle metriche personalizzate di conversione nei risultati. |
conversionCustomDimensionHeaders[] |
Le intestazioni della dimensione personalizzata di conversione nei risultati. |
rawEventConversionMetricHeaders[] |
Le intestazioni delle metriche di conversione degli eventi non elaborate nei risultati. |
rawEventConversionDimensionHeaders[] |
Le intestazioni delle dimensioni di conversione degli eventi non elaborate nei risultati. |
requestId |
L'ID univoco della richiesta utilizzato per il debug. |
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/doubleclicksearch