Package google.cloud.gsuiteaddons.v1

אינדקס

תוספי G Suite

שירות לניהול פריסות של תוספים ל-Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

יוצרת פריסה עם השם והתצורה שצוינו.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

מחיקת הפריסה עם השם הנתון.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

הפונקציה מקבלת את פרטי ההרשאה לפריסות בפרויקט נתון.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

הפונקציה מקבלת את הפריסה עם השם שצוין.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

מקבל את סטטוס ההתקנה של פריסת בדיקה.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

התקנת פריסה בחשבון לבדיקה. מידע נוסף זמין במאמר בדיקת התוסף

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

רשימה של כל הפריסות בפרויקט מסוים.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

יצירה או החלפה של פריסה בשם שצוין.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

מסירה את ההתקנה של פריסת הבדיקה מחשבון המשתמש. מידע נוסף זמין במאמר בדיקת התוסף.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, ניתן לעיין במדריך ההרשאות.

AddOns

הגדרה של תוסף ל-Google Workspace.

שדות
common

CommonAddOnManifest

הגדרה משותפת לכל התוספים של Google Workspace.
gmail

GmailAddOnManifest

הגדרות אישיות של תוסף ל-Gmail.
drive

DriveAddOnManifest

הגדרה של תוסף ב-Drive.
calendar

CalendarAddOnManifest

הגדרות אישיות של תוסף ליומן.
docs

DocsAddOnManifest

תצורת תוסף Docs.
sheets

SheetsAddOnManifest

הגדרות אישיות של התוסף ב-Sheets.
slides

SlidesAddOnManifest

הגדרות אישיות של התוסף ב-Slides.
httpOptions

HttpOptions

אפשרויות לשליחת בקשות לתוסף נקודות קצה מסוג HTTP

הרשאות

פרטי ההרשאות שמשמשים להפעלה של נקודות קצה לפריסה.

שדות
name

string

השם המלא הקנוני של המשאב הזה. לדוגמה: projects/123/authorization
serviceAccountEmail

string

כתובת האימייל של חשבון השירות ששימש לאימות בקשות לנקודות קצה להתקשרות חזרה של תוספים.
oauthClientId

string

מזהה הלקוח ב-OAuth שמשמש לקבלת אסימוני גישה מסוג OAuth עבור משתמש בשם התוסף.

CreateDeploymentRequest

שליחת בקשה ליצירת פריסה.

שדות
parent

string

חובה. שם הפרויקט שבו רוצים ליצור את הפריסה.

דוגמה: projects/my_project

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין parent:

  • gsuiteaddons.deployments.create
deploymentId

string

חובה. המזהה שיש להשתמש בו בפריסה הזו. השם המלא של המשאב שנוצר יהיה projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

חובה. הפריסה ליצירה (לא ניתן להגדיר את deployment.name).

DeleteDeploymentRequest

שליחת בקשה למחיקת פריסה.

שדות
name

string

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

דוגמה: projects/my_project/deployments/my_deployment

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין name:

  • gsuiteaddons.deployments.delete
etag

string

ה-etag של הפריסה למחיקה. אם הפרמטר הזה מופעל, הוא צריך להתאים ל-etag של השרת.

Deployment (פריסה)

פריסה של תוסף Google Workspace

שדות
name

string

השם של משאב הפריסה. דוגמה: projects/123/deployments/my_deployment
oauthScopes[]

string

רשימת ההיקפים של OAuth של Google שלגביהם יש לבקש הסכמה ממשתמש הקצה לפני הפעלת נקודת קצה (endpoint) של תוסף.
addOns

AddOns

ההגדרות האישיות של התוסף ל-Google Workspace.
etag

string

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

GetAuthorizationRequest

צריך לשלוח הודעה כדי לקבל את פרטי ההרשאה של תוסף Google Workspace.

שדות
name

string

חובה. שם הפרויקט שעבורו רוצים לקבל את פרטי ההרשאה של תוסף Google Workspace.

דוגמה: projects/my_project/authorization

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין name:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

שליחת בקשה לקבלת פריסה.

שדות
name

string

חובה. השם המלא של הפריסה שצריך לקבל.

דוגמה: projects/my_project/deployments/my_deployment

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

הודעת בקשה לקבלת סטטוס ההתקנה של פריסת בדיקה.

שדות
name

string

חובה. השם המלא של המשאב של הפריסה.

דוגמה: projects/my_project/deployments/my_deployment/installStatus

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין name:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

שליחת בקשה להתקנת פריסה לצורך בדיקה.

שדות
name

string

חובה. השם המלא של הפריסה שיש להתקין.

דוגמה: projects/my_project/deployments/my_deployment

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין name:

  • gsuiteaddons.deployments.install

InstallStatus

סטטוס ההתקנה של פריסת הבדיקה.

שדות
name

string

השם המלא של המשאב הקנוני בסטטוס ההתקנה של הפריסה.

דוגמה: projects/123/deployments/my_deployment/installStatus
installed

BoolValue

True אם הפריסה מותקנת עבור המשתמש.

ListDeploymentsRequest

שליחת בקשה להצגת רשימת הפריסות בפרויקט.

שדות
parent

string

חובה. שם הפרויקט שבו רוצים ליצור את הפריסה.

דוגמה: projects/my_project

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין parent:

  • gsuiteaddons.deployments.list
pageSize

int32

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

string

אסימון דף שהתקבל משיחה קודמת ב-ListDeployments. צריך לספק אותו כדי לאחזר את הדף הבא.

במהלך החלוקה לדפים, כל הפרמטרים האחרים שסיפקתם ל-ListDeployments חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListDeploymentsResponse

הודעת תגובה לבקשת פריסות ברשימה.

שדות
deployments[]

Deployment

רשימת הפריסות לפרויקט הנתון.
nextPageToken

string

אסימון שניתן לשלוח בתור page_token לאחזור הדף הבא. אם השדה הזה יושמט, לא יופיעו דפים נוספים.

ReplaceDeploymentRequest

צריך לשלוח הודעה ליצירה או להחלפה של פריסה.

שדות
deployment

Deployment

חובה. הפריסה ליצירה או להחלפה.

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

צריך לשלוח את ההודעה כדי להסיר את הפריסה לניסיון.

שדות
name

string

חובה. השם המלא של הפריסה שיש להתקין.

דוגמה: projects/my_project/deployments/my_deployment

להרשאה נדרשת הרשאת ה-IAM הבאה במשאב שצוין name:

  • gsuiteaddons.deployments.execute