Method: projects.locations.sampleQuerySets.sampleQueries.list

Ruft eine Liste von SampleQuery ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Ressource für die Beispielabfragegruppe, z. B. projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Wenn der Aufrufer keine Berechtigung hat, SampleQuerys unter diesem Beispielabfragesatz aufzulisten, wird unabhängig davon, ob dieser Beispielabfragesatz vorhanden ist oder nicht, ein PERMISSION_DENIED-Fehler zurückgegeben.

Abfrageparameter

Parameter
pageSize

integer

Maximale Anzahl der zurückzugebenden SampleQuery. Wenn nicht angegeben, lautet die Standardeinstellung 100. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.

Wenn dieses Feld negativ ist, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Ein Seitentoken ListSampleQueriesResponse.next_page_token, das von einem vorherigen SampleQueryService.ListSampleQueries-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für SampleQueryService.ListSampleQueries bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode SampleQueryService.ListSampleQueries.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ],
  "nextPageToken": string
}
Felder
sampleQueries[]

object (SampleQuery)

Die SampleQuery.
nextPageToken

string

Ein Token, das als ListSampleQueriesRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.sampleQueries.list

Weitere Informationen finden Sie in der IAM-Dokumentation.