Method: accounts.reports.search

Recupera un report definito da una query di ricerca. La risposta potrebbe contenere meno righe rispetto a quelle specificate da pageSize. Utilizza nextPageToken per determinare se sono necessarie altre righe.

Richiesta HTTP

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. ID dell'account che effettua la chiamata. Deve essere un account autonomo o un subaccount AMC. Formato: accounts/{account}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Campi
query

string

Obbligatorio. Query che definisce un report da recuperare.

Per informazioni dettagliate su come creare una query, consulta la guida Linguaggio di query. Per l'elenco completo delle tabelle e dei campi disponibili, consulta la sezione Campi disponibili.
pageSize

integer

Facoltativo. Numero di ReportRows da recuperare in una singola pagina. Il valore predefinito è 1000. I valori superiori a 5000 vengono forzati a 5000.
pageToken

string

Facoltativo. Token della pagina da recuperare. Se non è specificato, viene restituita la prima pagina di risultati. Per richiedere la pagina di risultati successiva, devi utilizzare il valore ottenuto da nextPageToken nella risposta precedente.

Corpo della risposta

Messaggio di risposta per il metodo ReportService.Search.

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

Rappresentazione JSON 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Campi
results[]

object (ReportRow)

Righe corrispondenti alla query di ricerca.
nextPageToken

string

Token che può essere inviato come pageToken per recuperare la pagina successiva. Se questo attributo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.