Method: projects.locations.collections.list

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

בקשת HTTP


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

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

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

פרמטרים
parent

string

חובה. שם המשאב של מאגר הנתונים ההורה, בפורמט projects/{project}/locations/{location}.

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

פרמטרים
pageSize

integer

המספר המקסימלי של Collections שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא מציינים ערך, יוחזרו לכל היותר 100 Collection.

הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
pageToken

string

טוקן של דף שהתקבל מקריאה קודמת של CollectionService.ListCollections. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-CollectionService.ListCollections חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
filter

string

מסננים את הקולקציות שמוחזרות לפי מקורות נתונים של מחברי נתונים משויכים. לדוגמה: filter = 'dataSource:jira confluence'. אם המסנן ריק, אנחנו מחזירים את כל האוספים בפרויקט ובמיקום.

גוף הבקשה

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

גוף התשובה

הודעת תגובה לשיטה CollectionService.ListCollections.

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

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

object (Collection)

‫Collection שנ'.
nextPageToken

string

טוקן שאפשר לשלוח כ-ListCollectionsRequest.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.collections.list

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