Method: projects.locations.evaluations.list

Ruft eine Liste der Evaluations ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Standortressource, z. B. projects/{project}/locations/{location}.

Wenn der Aufrufer nicht berechtigt ist, Evaluations für diesen Standort aufzulisten, unabhängig davon, ob dieser Standort vorhanden ist oder nicht, wird der Fehler PERMISSION_DENIED zurückgegeben.

Suchparameter

Parameter
pageSize

integer

Optional. Maximale Anzahl der zurückzugebenden Evaluation. Wenn sie nicht angegeben wird, wird der Wert standardmäßig auf 100 gesetzt. 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

Optional. Ein ListEvaluationsResponse.next_page_token-Seitentoken, das von einem vorherigen EvaluationService.ListEvaluations-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für EvaluationService.ListEvaluations 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 EvaluationService.ListEvaluations.

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

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

object (Evaluation)

Die Evaluations.
nextPageToken

string

Ein Token, das als ListEvaluationsRequest.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.evaluations.list

Weitere Informationen finden Sie in der IAM-Dokumentation.