Method: customers.googleAds.searchStream

Restituisce tutte le righe che corrispondono alla query dello stream di ricerca.

Elenco degli errori generati: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

Richiesta HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
customerId

string

Obbligatorio. L'ID del cliente a cui viene eseguita la query.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Campi
query

string

Obbligatorio. La stringa di query.
summaryRowSetting

enum (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 in una risposta da sola dopo che sono stati restituiti tutti gli altri risultati della query.

Corpo della risposta

Messaggio di risposta per GoogleAdsService.SearchStream.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
Campi
results[]

object (GoogleAdsRow)

L'elenco delle righe corrispondenti alla query.
fieldMask

string (FieldMask format)

FieldMask che rappresenta i campi richiesti dall'utente.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

Riga di riepilogo contenente il riepilogo delle metriche nei risultati. Riepilogo delle metriche significa aggregazione delle metriche in tutti i risultati. L'aggregazione può essere somma, media, percentuale e così via.
requestId

string

L'ID univoco della richiesta utilizzato per il debug.
queryResourceConsumption

string (int64 format)

La quantità di risorse consumate per l'esecuzione della query. queryResourceConsumption per la riga Riepilogo e le risposte diverse da Riepilogo vengono restituite separatamente nelle rispettive righe. queryResourceConsumption per le risposte diverse da Riepilogo viene restituito nell'ultimo batch di risultati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/adwords

Per ulteriori informazioni, consulta la sezione OAuth 2.0 Overview.

SummaryRowSetting

Enum che descrive le impostazioni della riga di riepilogo dei resi.

Enum
UNSPECIFIED Non specificato.
UNKNOWN Rappresenta i valori sconosciuti della riga di riepilogo del reso.
NO_SUMMARY_ROW Non restituire la riga di riepilogo.
SUMMARY_ROW_WITH_RESULTS Restituisce la riga di riepilogo insieme ai risultati. La riga di riepilogo verrà restituita solo nell'ultimo batch (che non conterrà risultati).
SUMMARY_ROW_ONLY Restituisce solo la riga di riepilogo e non restituisce risultati.