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

הפונקציה מחזירה Document.

בקשת HTTP

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

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

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

פרמטרים
name

string

חובה. שם המשאב המלא של Document, כמו projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

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

אם Document המבוקש לא קיים, מוחזרת שגיאה NOT_FOUND.

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.documents.get

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