אינדקס
GSuiteAddOns
(ממשק)AddOns
(מֶסֶר)Authorization
(מֶסֶר)CreateDeploymentRequest
(מֶסֶר)DeleteDeploymentRequest
(מֶסֶר)Deployment
(מֶסֶר)GetAuthorizationRequest
(מֶסֶר)GetDeploymentRequest
(מֶסֶר)GetInstallStatusRequest
(מֶסֶר)InstallDeploymentRequest
(מֶסֶר)InstallStatus
(מֶסֶר)ListDeploymentsRequest
(מֶסֶר)ListDeploymentsResponse
(מֶסֶר)ReplaceDeploymentRequest
(מֶסֶר)UninstallDeploymentRequest
(מֶסֶר)
תוספי G Suite
שירות לניהול פריסות של תוספים ל-Google Workspace.
CreateDeployment |
---|
יוצרת פריסה עם השם והתצורה שצוינו.
|
DeleteDeployment |
---|
מחיקת הפריסה עם השם הנתון.
|
GetAuthorization |
---|
הפונקציה מקבלת את פרטי ההרשאה לפריסות בפרויקט נתון.
|
GetDeployment |
---|
הפונקציה מקבלת את הפריסה עם השם שצוין.
|
GetInstallStatus |
---|
מקבל את סטטוס ההתקנה של פריסת בדיקה.
|
InstallDeployment |
---|
התקנת פריסה בחשבון לבדיקה. מידע נוסף זמין במאמר בדיקת התוסף
|
ListDeployments |
---|
רשימה של כל הפריסות בפרויקט מסוים.
|
ReplaceDeployment |
---|
יצירה או החלפה של פריסה בשם שצוין.
|
UninstallDeployment |
---|
מסירה את ההתקנה של פריסת הבדיקה מחשבון המשתמש. מידע נוסף זמין במאמר בדיקת התוסף.
|
AddOns
הגדרה של תוסף ל-Google Workspace.
שדות | |
---|---|
common |
הגדרה משותפת לכל התוספים של Google Workspace. |
gmail |
הגדרות אישיות של תוסף ל-Gmail. |
drive |
הגדרה של תוסף ב-Drive. |
calendar |
הגדרות אישיות של תוסף ליומן. |
docs |
תצורת תוסף Docs. |
sheets |
הגדרות אישיות של התוסף ב-Sheets. |
slides |
הגדרות אישיות של התוסף ב-Slides. |
httpOptions |
אפשרויות לשליחת בקשות לתוסף נקודות קצה מסוג HTTP |
הרשאות
פרטי ההרשאות שמשמשים להפעלה של נקודות קצה לפריסה.
שדות | |
---|---|
name |
השם המלא הקנוני של המשאב הזה. לדוגמה: |
serviceAccountEmail |
כתובת האימייל של חשבון השירות ששימש לאימות בקשות לנקודות קצה להתקשרות חזרה של תוספים. |
oauthClientId |
מזהה הלקוח ב-OAuth שמשמש לקבלת אסימוני גישה מסוג OAuth עבור משתמש בשם התוסף. |
CreateDeploymentRequest
שליחת בקשה ליצירת פריסה.
שדות | |
---|---|
parent |
חובה. שם הפרויקט שבו רוצים ליצור את הפריסה. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
deploymentId |
חובה. המזהה שיש להשתמש בו בפריסה הזו. השם המלא של המשאב שנוצר יהיה |
deployment |
חובה. הפריסה ליצירה (לא ניתן להגדיר את deployment.name). |
DeleteDeploymentRequest
שליחת בקשה למחיקת פריסה.
שדות | |
---|---|
name |
חובה. השם המלא של הפריסה שמיועדת למחיקה. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
etag |
ה-etag של הפריסה למחיקה. אם הפרמטר הזה מופעל, הוא צריך להתאים ל-etag של השרת. |
Deployment (פריסה)
פריסה של תוסף Google Workspace
שדות | |
---|---|
name |
השם של משאב הפריסה. דוגמה: |
oauthScopes[] |
רשימת ההיקפים של OAuth של Google שלגביהם יש לבקש הסכמה ממשתמש הקצה לפני הפעלת נקודת קצה (endpoint) של תוסף. |
addOns |
ההגדרות האישיות של התוסף ל-Google Workspace. |
etag |
הערך הזה מחושב על ידי השרת על סמך גרסת הפריסה באחסון, והוא עשוי להישלח בבקשות לעדכון ולמחיקה כדי לוודא שללקוח יש ערך עדכני לפני שימשיך. |
GetAuthorizationRequest
צריך לשלוח הודעה כדי לקבל את פרטי ההרשאה של תוסף Google Workspace.
שדות | |
---|---|
name |
חובה. שם הפרויקט שעבורו רוצים לקבל את פרטי ההרשאה של תוסף Google Workspace. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
GetDeploymentRequest
שליחת בקשה לקבלת פריסה.
שדות | |
---|---|
name |
חובה. השם המלא של הפריסה שצריך לקבל. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
GetInstallStatusRequest
הודעת בקשה לקבלת סטטוס ההתקנה של פריסת בדיקה.
שדות | |
---|---|
name |
חובה. השם המלא של המשאב של הפריסה. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
InstallDeploymentRequest
שליחת בקשה להתקנת פריסה לצורך בדיקה.
שדות | |
---|---|
name |
חובה. השם המלא של הפריסה שיש להתקין. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
InstallStatus
סטטוס ההתקנה של פריסת הבדיקה.
שדות | |
---|---|
name |
השם המלא של המשאב הקנוני בסטטוס ההתקנה של הפריסה. דוגמה: |
installed |
True אם הפריסה מותקנת עבור המשתמש. |
ListDeploymentsRequest
שליחת בקשה להצגת רשימת הפריסות בפרויקט.
שדות | |
---|---|
parent |
חובה. שם הפרויקט שבו רוצים ליצור את הפריסה. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
pageSize |
המספר המקסימלי של פריסות שיש להחזיר. השירות עשוי להחזיר פחות מהערך הזה. אם לא צוין אחרת, יוחזרו עד 1,000 פריסות. הערך המקסימלי האפשרי הוא 1,000. ערכים מעל 1,000 משתנים ל-1,000. |
pageToken |
אסימון דף שהתקבל משיחה קודמת ב- במהלך החלוקה לדפים, כל הפרמטרים האחרים שסיפקתם ל- |
ListDeploymentsResponse
הודעת תגובה לבקשת פריסות ברשימה.
שדות | |
---|---|
deployments[] |
רשימת הפריסות לפרויקט הנתון. |
nextPageToken |
אסימון שניתן לשלוח בתור |
ReplaceDeploymentRequest
צריך לשלוח הודעה ליצירה או להחלפה של פריסה.
שדות | |
---|---|
deployment |
חובה. הפריסה ליצירה או להחלפה. להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|
UninstallDeploymentRequest
צריך לשלוח את ההודעה כדי להסיר את הפריסה לניסיון.
שדות | |
---|---|
name |
חובה. השם המלא של הפריסה שיש להתקין. דוגמה: להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין
|