Console
    Contact Us Start free

    Method: projects.locations.evaluations.list

    Gets a list of Evaluation s.

    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 Evaluation s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

    Query parameters

    Parameters
    pageSize

    integer

    Optional. Maximum number of Evaluation s 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

    Optional. 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 Evaluation s.
    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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: