Method: projects.locations.dataStores.branches.documents.list

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

חובה. שם המשאב של הענף הראשי, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. כדי להציג מסמכים בענף ברירת המחדל, משתמשים ב-default_branch כמזהה הענף.

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

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

פרמטרים
pageSize

integer

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

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

string

טוקן של דף ListDocumentsResponse.next_page_token שהתקבל מקריאה קודמת של DocumentService.ListDocuments. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.documents.list

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