Method: projects.locations.sampleQuerySets.sampleQueries.list

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

בקשת HTTP


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

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

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

פרמטרים
parent

string

חובה. שם המשאב של קבוצת שאילתות לדוגמה ברמת ההורה, כמו projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

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

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

פרמטרים
pageSize

integer

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

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

string

טוקן של דף ListSampleQueriesResponse.next_page_token שהתקבל מקריאה קודמת של SampleQueryService.ListSampleQueries. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

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

גוף הבקשה

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

גוף התשובה

הודעת תגובה לשיטה SampleQueryService.ListSampleQueries.

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

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

object (SampleQuery)

‫SampleQuery שנ'.
nextPageToken

string

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.sampleQueries.list

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