Method: customers.googleAds.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://googleads.googleapis.com/v16/customers/{customerId}/googleAds: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 specificato, verrà restituita la prima pagina di risultati. Utilizza il valore ottenuto da nextPageToken nella risposta precedente per richiedere la pagina dei risultati successiva.
pageSize

integer

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

boolean

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

boolean

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

Corpo della risposta

Messaggio di risposta per GoogleAdsService.Search.

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

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

object (GoogleAdsRow)

L'elenco di righe che corrispondono alla query.
nextPageToken

string

Token di impaginazione utilizzato per recuperare la pagina successiva dei risultati. Passa i contenuti di questa stringa come attributo pageToken della richiesta successiva. nextPageToken non è stato 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 (GoogleAdsRow)

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.
queryResourceConsumption

string (int64 format)

La quantità di risorse utilizzate per gestire la query.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la pagina Panoramica di OAuth 2.0.