Method: projects.locations.sampleQuerySets.list

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

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

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

פרמטרים
pageSize

integer

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

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

string

טוקן של דף ListSampleQuerySetsResponse.next_page_token שהתקבל מקריאה קודמת של SampleQuerySetService.ListSampleQuerySets. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

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

גוף הבקשה

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

גוף התשובה

הודעת תגובה לשיטה SampleQuerySetService.ListSampleQuerySets.

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

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

object (SampleQuerySet)

בשנות ה-SampleQuerySet.
nextPageToken

string

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.sampleQuerySets.list

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