Method: customers.searchAds360.searchStream

Restituisce tutte le righe che corrispondono alla query del flusso di ricerca.

Elenco degli errori generati: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError 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

string

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 (SummaryRowSetting)
}
Campi
query

string

Obbligatorio. La stringa di query.
batchSize

integer

Il numero di righe restituite in ogni batch di risposte del flusso. Se viene richiesto un batch troppo grande, il server potrebbe decidere di limitare ulteriormente il numero di righe restituite.
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 separata dopo la restituzione di 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 (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
Campi
results[]

object (SearchAds360Row)

L'elenco delle righe che corrispondono 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 (SearchAds360Row)

Riga di riepilogo che contiene il riepilogo delle metriche nei risultati. Il riepilogo delle metriche indica l'aggregazione delle metriche in tutti i risultati. L'aggregazione può essere somma, media, tasso e così via.
customColumnHeaders[]

object (CustomColumnHeader)

Le intestazioni delle colonne personalizzate nei risultati.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

Le intestazioni delle metriche personalizzate di conversione nei risultati.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Le intestazioni della dimensione personalizzata di conversione nei risultati.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Le intestazioni delle metriche di conversione degli eventi non elaborati nei risultati.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Le intestazioni delle dimensioni di conversione degli eventi non elaborati nei risultati.
requestId

string

L'ID univoco della richiesta utilizzato a scopo di debug.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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