דף זה תורגם על ידי Cloud Translation API.

Package google.cloud.gsuiteaddons.v1

אינדקס

GSuiteAddOns (ממשק)
AddOns (הודעה)
Authorization (הודעה)
CreateDeploymentRequest (הודעה)
DeleteDeploymentRequest (הודעה)
Deployment (הודעה)
GetAuthorizationRequest (הודעה)
GetDeploymentRequest (הודעה)
GetInstallStatusRequest (הודעה)
InstallDeploymentRequest (הודעה)
InstallStatus (הודעה)
ListDeploymentsRequest (הודעה)
ListDeploymentsResponse (הודעה)
ReplaceDeploymentRequest (הודעה)
UninstallDeploymentRequest (הודעה)

GSuiteAddOns

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

CreateDeployment

CreateDeployment
`rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)` יצירת פריסה עם השם והתצורה שצוינו. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

DeleteDeployment

DeleteDeployment
`rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)` מחיקה של הפריסה עם השם שצוין. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

מחיקה של הפריסה עם השם שצוין.

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

GetAuthorization

GetAuthorization
`rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)` הפונקציה מקבלת את פרטי ההרשאה לפריסות בפרויקט נתון. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

GetDeployment

GetDeployment
`rpc GetDeployment(GetDeploymentRequest) returns (Deployment)` אחזור הפריסה עם השם שצוין. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

אחזור הפריסה עם השם שצוין.

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

GetInstallStatus

GetInstallStatus
`rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)` הפונקציה מקבלת את סטטוס ההתקנה של פריסה לבדיקה. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

InstallDeployment

InstallDeployment
`rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)` התקנה של פריסה בחשבון לצורך בדיקה. מידע נוסף זמין במאמר בדיקת התוסף היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

ListDeployments

ListDeployments
`rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)` הצגת רשימה של כל הפריסות בפרויקט מסוים. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

ReplaceDeployment

ReplaceDeployment
`rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)` יצירת פריסה או החלפת פריסה בשם שצוין. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

UninstallDeployment

UninstallDeployment
`rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)` הפקודה מסירה פריסה לצורך בדיקה מהחשבון של המשתמש. מידע נוסף זמין במאמר בדיקת התוסף. היקפי הרשאה נדרש היקף ההרשאות הבא של OAuth: `https://www.googleapis.com/auth/cloud-platform` מידע נוסף זמין בOAuth 2.0 Overview.

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.

AddOns

הגדרה של תוסף ל-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` כתובת האימייל של חשבון השירות שמשמש לאימות בקשות לנקודות קצה של קריאה חוזרת (callback) של התוסף.
`oauthClientId`	`string` מזהה הלקוח ב-OAuth שמשמש לקבלת אסימוני גישה של OAuth למשתמש בשם התוסף.

name

string

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

serviceAccountEmail

string

כתובת האימייל של חשבון השירות שמשמש לאימות בקשות לנקודות קצה של קריאה חוזרת (callback) של התוסף.

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).

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 של השרת.

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`

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`

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`

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`

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 אם הפריסה מותקנת עבור המשתמש.

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` חייבים להתאים לקריאה שסיפקה את אסימון הדף.

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` כדי לאחזר את הדף הבא. אם השדה הזה לא יצוין, לא יהיו דפים נוספים.

deployments[]

Deployment

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

nextPageToken

string

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

ReplaceDeploymentRequest

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

שדות

שדות
`deployment`	`Deployment` חובה. הפריסה שרוצים ליצור או להחליף. כדי לקבל הרשאה, נדרשת ההרשאה הבאה ב-IAM למשאב שצוין `deployment`: `gsuiteaddons.deployments.update`

deployment

Deployment

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

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

gsuiteaddons.deployments.update

UninstallDeploymentRequest

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

שדות

שדות
`name`	`string` חובה. השם המלא של המשאב של הפריסה שרוצים להתקין. דוגמה: `projects/my_project/deployments/my_deployment` כדי לקבל הרשאה, נדרשת ההרשאה הבאה ב-IAM למשאב שצוין `name`: `gsuiteaddons.deployments.execute`

name

string

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

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

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

gsuiteaddons.deployments.execute