Method: projects.locations.evaluations.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/evaluations
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent location resource name, such as projects/{project}/locations/{location}. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
|
Query parameters
| Parameters |
pageSize |
integer
Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
pageToken |
string
A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
Request body
The request body must be empty.
Response body
Response message for EvaluationService.ListEvaluations method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"evaluations": [
{
object (Evaluation)
}
],
"nextPageToken": string
} |
| Fields |
evaluations[] |
object (Evaluation)
The Evaluations.
|
nextPageToken |
string
A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
discoveryengine.evaluations.list
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This API endpoint retrieves a list of Evaluations from a specified parent location using a GET HTTP request."],["The `parent` path parameter is required to identify the location, and a `PERMISSION_DENIED` error is returned if the caller lacks the necessary permissions."],["Optional query parameters `pageSize` and `pageToken` can be used to control the number of Evaluations returned per page and navigate through multiple pages of results, respectively."],["The request body for listing Evaluations must be empty, and the response body includes an array of Evaluation objects and a `nextPageToken` for pagination."],["Accessing this API requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope and the `discoveryengine.evaluations.list` IAM permission on the parent resource."]]],[]]
