Package google.cloud.gsuiteaddons.v1

אינדקס

GSuiteAddOns

שירות לניהול פריסות של תוספים ל-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

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

תוספים

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

שדות
common

CommonAddOnManifest

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

GmailAddOnManifest

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

DriveAddOnManifest

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

CalendarAddOnManifest

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

DocsAddOnManifest

הגדרת התוסף של Docs.
sheets

SheetsAddOnManifest

הגדרה של תוסף Sheets.
slides

SlidesAddOnManifest

הגדרת התוסף ל-Slides.
httpOptions

HttpOptions

אפשרויות לשליחת בקשות לנקודות קצה (endpoint) של HTTP בתוסף

אישור

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

שדות
name

string

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

string

כתובת האימייל של חשבון השירות שמשמש לאימות בקשות לנקודות קצה של שיחות חזרה (callbacks) של התוסף.
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 של השרת.

פריסה

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

שדות
name

string

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

string

רשימת היקפי ההרשאות של OAuth של Google שנדרשת עבורן הסכמה ממשתמשי הקצה לפני הפעלה של נקודת קצה של תוסף.
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