Method: projects.locations.evaluations.list

מקבל רשימה של Evaluation.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם משאב המיקום של ההורה, למשל projects/{project}/locations/{location}.

אם למבצע הקריאה אין הרשאה להציג רשימה של Evaluation במיקום הזה, בלי קשר לשאלה אם המיקום הזה קיים או לא, מוחזרת שגיאה PERMISSION_DENIED.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של Evaluations שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא 100. הערך המקסימלי המותר הוא 1,000. ערכים מעל 1,000 יומרו ל-1,000.

אם הערך בשדה הזה הוא שלילי, תוחזר שגיאת INVALID_ARGUMENT.

pageToken

string

זה שינוי אופציונלי. טוקן של דף ListEvaluationsResponse.next_page_token שהתקבל מקריאה קודמת של EvaluationService.ListEvaluations. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-EvaluationService.ListEvaluations חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה לשיטה EvaluationService.ListEvaluations.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "evaluations": [
    {
      object (Evaluation)
    }
  ],
  "nextPageToken": string
}
שדות
evaluations[]

object (Evaluation)

בשנות ה-Evaluation.

nextPageToken

string

טוקן שאפשר לשלוח כ-ListEvaluationsRequest.page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.evaluations.list

מידע נוסף מופיע במאמרי העזרה בנושא IAM.