Method: customers.searchAds360.search

Restituisce tutte le righe che corrispondono alla query 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:search

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,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Campi
query

string

Obbligatorio. La stringa di query.
pageToken

string

Token della pagina da recuperare. Se non viene specificato, verrà restituita la prima pagina dei risultati. Utilizza il valore ottenuto da nextPageToken nella risposta precedente per richiedere la pagina successiva dei risultati.
pageSize

integer

Numero di elementi da recuperare in una singola pagina. Se viene richiesta una pagina troppo grande, il server potrebbe decidere di limitare ulteriormente il numero di risorse restituite.
validateOnly

boolean

Se true, la richiesta viene convalidata ma non eseguita.
returnTotalResultsCount

boolean

Se true, nella risposta verrà incluso il numero totale di risultati che corrispondono alla query, ignorando la clausola LIMIT. Il valore predefinito è false.
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 che saranno stati restituiti tutti gli altri risultati della query.

Corpo della risposta

Messaggio di risposta per SearchAds360Service.Search.

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

Rappresentazione JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
Campi
results[]

object (SearchAds360Row)

L'elenco delle righe che corrispondono alla query.
nextPageToken

string

Token di paginazione utilizzato per recuperare la pagina successiva dei risultati. Trasmetti il contenuto di questa stringa come attributo pageToken della richiesta successiva. nextPageToken non viene restituito per l'ultima pagina.
totalResultsCount

string (int64 format)

Numero totale di risultati che corrispondono alla query, ignorando la clausola LIMIT.
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, dove 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 delle dimensioni personalizzate 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.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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