Method: approvals.start

מתחיל תהליך אישור לקובץ. מידע נוסף מופיע במאמר בנושא ניהול אישורים.

בקשת HTTP

POST https://www.googleapis.com/drive/v3/files/{fileId}/approvals:start

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

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

פרמטרים
fileId

string

חובה. המזהה של הקובץ שבו נוצר האישור.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "reviewerEmails": [
    string
  ],
  "dueTime": string,
  "lockFile": boolean,
  "message": string,
  "fileContentChangeBehavior": enum (FileContentChangeBehavior)
}
שדות
reviewerEmails[]

string

חובה. כתובות האימייל של המשתמשים שהוגדרו לבדיקת האישור.
dueTime

string (Timestamp format)

אופציונלי. המועד האחרון לאישור.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
lockFile

boolean

אופציונלי. האם לנעול את הקובץ כשמתחילים את תהליך האישור.
message

string

אופציונלי. הודעה לשליחה לבודקים כשמודיעים להם על בקשת האישור.
fileContentChangeBehavior

enum (FileContentChangeBehavior)

אופציונלי. ההתנהגות של האישור כשהתוכן של הקובץ משתנה.

גוף התשובה

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata

חלק מההיקפים מוגבלים ונדרשת הערכת אבטחה כדי שהאפליקציה תוכל להשתמש בהם. מידע נוסף זמין במדריך ההרשאות.