Method: projects.locations.sampleQuerySets.sampleQueries.list

Recupera un elenco di SampleQuery.

Richiesta HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa del set di query di esempio padre, ad esempio projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Se il chiamante non dispone dell'autorizzazione per elencare i SampleQuery in questo insieme di query di esempio, indipendentemente dall'esistenza o meno di questo insieme di query di esempio, viene restituito un errore PERMISSION_DENIED.

Parametri di query

Parametri
pageSize

integer

Il numero massimo di SampleQuery da restituire. Se non specificato, il valore predefinito è 100. Il valore massimo consentito è 1000. I valori superiori a 1000 verranno forzati a 1000.

Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.
pageToken

string

Un token di pagina ListSampleQueriesResponse.next_page_token, ricevuto da una precedente chiamata SampleQueryService.ListSampleQueries. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a SampleQueryService.ListSampleQueries devono corrispondere alla chiamata che ha fornito il token di pagina. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per il metodo SampleQueryService.ListSampleQueries.

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

Rappresentazione JSON 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ],
  "nextPageToken": string
}
Campi
sampleQueries[]

object (SampleQuery)

Gli anni SampleQuery.
nextPageToken

string

Un token che può essere inviato come ListSampleQueriesRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.sampleQueries.list

Per saperne di più, consulta la documentazione di IAM.