Package google.cloud.gsuiteaddons.v1

āϏ⧂āϚāĻ•

GSuiteAddOns

Google Workspace āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āĻĒāϰāĻŋāϚāĻžāϞāύāĻžāϰ āϜāĻ¨ā§āϝ āĻāĻ•āϟāĻŋ āĻĒāϰāĻŋāώ⧇āĻŦāĻžāĨ¤

āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ āϤ⧈āϰāĻŋ āĻ•āϰ⧁āύ

rpc CreateDeployment( CreateDeploymentRequest ) returns ( Deployment )

āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āύāĻžāĻŽ āĻāĻŦāĻ‚ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύ āϏāĻš āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āϤ⧈āϰāĻŋ āĻ•āϰ⧇āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϏ⧁āϝ⧋āĻ—

āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ OAuth āϏ⧁āϝ⧋āĻ— āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ āĻŽā§āϛ⧁āύ

rpc DeleteDeployment( DeleteDeploymentRequest ) returns ( Empty )

āĻĒā§āϰāĻĻāĻ¤ā§āϤ āύāĻžāĻŽ āĻĻāĻŋāϝāĻŧ⧇ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āĻŽā§āϛ⧇ āĻĻ⧇āϝāĻŧāĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϏ⧁āϝ⧋āĻ—

āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ OAuth āϏ⧁āϝ⧋āĻ— āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ āĻĒāĻžāύ

rpc GetAuthorization( GetAuthorizationRequest ) returns ( Authorization )

āĻāĻ•āϟāĻŋ āĻĒā§āϰāĻĻāĻ¤ā§āϤ āĻĒā§āϰāĻ•āĻ˛ā§āĻĒ⧇ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϜāĻ¨ā§āϝ āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϤāĻĨā§āϝ āĻĒāĻžāϝāĻŧāĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϏ⧁āϝ⧋āĻ—

āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ OAuth āϏ⧁āϝ⧋āĻ— āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āύāĻŋāϝāĻŧā§‹āϜāĻŋāϤ āĻ•āϰ⧁āύ

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āχāĻ¨ā§āϏāϟāϞ āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ

rpc InstallDeployment( InstallDeploymentRequest ) returns ( Empty )

āĻĒāϰ⧀āĻ•ā§āώāĻžāϰ āϜāĻ¨ā§āϝ āφāĻĒāύāĻžāϰ āĻ…ā§āϝāĻžāĻ•āĻžāωāĻ¨ā§āĻŸā§‡ āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āχāύāĻ¸ā§āϟāϞ āĻ•āϰ⧇āĨ¤ āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āφāĻĒāύāĻžāϰ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻĒāϰ⧀āĻ•ā§āώāĻž āĻ•āϰ⧁āύ āĻĻ⧇āϖ⧁āύ

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϏ⧁āϝ⧋āĻ—

āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ OAuth āϏ⧁āϝ⧋āĻ— āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āϤāĻžāϞāĻŋāĻ•āĻž āĻ¸ā§āĻĨāĻžāĻĒāύ

rpc ListDeployments( ListDeploymentsRequest ) returns ( ListDeploymentsResponse )

āĻāĻ•āϟāĻŋ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āĻĒā§āϰāĻ•āĻ˛ā§āĻĒ⧇ āϏāĻŽāĻ¸ā§āϤ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϤāĻžāϞāĻŋāĻ•āĻž āĻ•āϰ⧇āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϏ⧁āϝ⧋āĻ—

āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ OAuth āϏ⧁āϝ⧋āĻ— āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āĻĒā§āϰāϤāĻŋāĻ¸ā§āĻĨāĻžāĻĒāύ āĻ¸ā§āĻĨāĻžāĻĒāύ

rpc ReplaceDeployment( ReplaceDeploymentRequest ) returns ( Deployment )

āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āύāĻžāĻŽā§‡āϰ āϏāĻžāĻĨ⧇ āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āϤ⧈āϰāĻŋ āĻŦāĻž āĻĒā§āϰāϤāĻŋāĻ¸ā§āĻĨāĻžāĻĒāύ āĻ•āϰ⧇āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϏ⧁āϝ⧋āĻ—

āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ OAuth āϏ⧁āϝ⧋āĻ— āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āφāύāχāύāĻ¸ā§āϟāϞ āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ

rpc UninstallDeployment( UninstallDeploymentRequest ) returns ( Empty )

āĻŦā§āϝāĻŦāĻšāĻžāϰāĻ•āĻžāϰ⧀āϰ āĻ…ā§āϝāĻžāĻ•āĻžāωāĻ¨ā§āϟ āĻĨ⧇āϕ⧇ āĻāĻ•āϟāĻŋ āĻĒāϰ⧀āĻ•ā§āώāĻž āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āφāύāχāύāĻ¸ā§āϟāϞ āĻ•āϰ⧇āĨ¤ āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āφāĻĒāύāĻžāϰ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻĒāϰ⧀āĻ•ā§āώāĻž āĻ•āϰ⧁āύ āĻĻ⧇āϖ⧁āύāĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϏ⧁āϝ⧋āĻ—

āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ OAuth āϏ⧁āϝ⧋āĻ— āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

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

āφāϰāĻ“ āϤāĻĨā§āϝ⧇āϰ āϜāĻ¨ā§āϝ, āĻ…āύ⧁āĻŽā§‹āĻĻāύ āύāĻŋāĻ°ā§āĻĻ⧇āĻļāĻŋāĻ•āĻž āĻĻ⧇āϖ⧁āύāĨ¤

āĻ…ā§āϝāĻžāĻĄāĻ…āύ

āĻāĻ•āϟāĻŋ Google Workspace āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

āĻ•ā§āώ⧇āĻ¤ā§āϰ
common

CommonAddOnManifest

āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύ āϝāĻž āϏāĻŽāĻ¸ā§āϤ Google Workspace āĻ…ā§āϝāĻžāĻĄ-āĻ…āύāϗ⧁āϞāĻŋāϤ⧇ āϏāĻžāϧāĻžāϰāĻŖāĨ¤

gmail

GmailAddOnManifest

āϜāĻŋāĻŽā§‡āχāϞ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

drive

DriveAddOnManifest

āĻĄā§āϰāĻžāχāĻ­ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

calendar

CalendarAddOnManifest

āĻ•ā§āϝāĻžāϞ⧇āĻ¨ā§āĻĄāĻžāϰ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

docs

DocsAddOnManifest

āĻĄāĻ•ā§āϏ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

meet

MeetAddOnManifest

āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύ⧇āϰ āϏāĻžāĻĨ⧇ āĻĻ⧇āĻ–āĻž āĻ•āϰ⧁āύāĨ¤

sheets

SheetsAddOnManifest

āĻĒāĻ¤ā§āϰāĻ• āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

slides

SlidesAddOnManifest

āĻ¸ā§āϞāĻžāχāĻĄ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

httpOptions

HttpOptions

āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ HTTP āĻāĻ¨ā§āĻĄāĻĒāϝāĻŧ⧇āĻ¨ā§āĻŸā§‡ āĻ…āύ⧁āϰ⧋āϧ āĻĒāĻžāĻ āĻžāύ⧋āϰ āĻŦāĻŋāĻ•āĻ˛ā§āĻĒ

āĻ…āύ⧁āĻŽā§‹āĻĻāύ

āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ āĻāĻ¨ā§āĻĄāĻĒāϝāĻŧ⧇āĻ¨ā§āϟ āφāĻšā§āĻŦāĻžāύ āĻ•āϰāĻžāϰ āϏāĻŽāϝāĻŧ āĻŦā§āϝāĻŦāĻšā§ƒāϤ āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϤāĻĨā§āϝāĨ¤

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻāχ āϏāĻŽā§āĻĒāĻĻ⧇āϰ āĻ•ā§āϝāĻžāύ⧋āύāĻŋāĻ•āĻžāϞ āĻĒ⧁āϰ⧋ āύāĻžāĻŽāĨ¤ āωāĻĻāĻžāĻšāϰāĻŖ: projects/123/authorization

serviceAccountEmail

string

āĻĒāϰāĻŋāώ⧇āĻŦāĻž āĻ…ā§āϝāĻžāĻ•āĻžāωāĻ¨ā§āĻŸā§‡āϰ āχāĻŽā§‡āϞ āĻ āĻŋāĻ•āĻžāύāĻž āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āϞāĻŦā§āϝāĻžāĻ• āĻāĻ¨ā§āĻĄāĻĒāϝāĻŧ⧇āĻ¨ā§āĻŸā§‡āϰ āĻ…āύ⧁āϰ⧋āϧāϗ⧁āϞāĻŋ āĻĒā§āϰāĻŽāĻžāĻŖā§€āĻ•āϰāĻŖ āĻ•āϰāϤ⧇ āĻŦā§āϝāĻŦāĻšā§ƒāϤ āĻšāϝāĻŧāĨ¤

oauthClientId

string

OAuth āĻ•ā§āϞāĻžāϝāĻŧ⧇āĻ¨ā§āϟ āφāχāĻĄāĻŋ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ⧇āϰ āĻĒāĻ•ā§āώ⧇ āĻāĻ•āϜāύ āĻŦā§āϝāĻŦāĻšāĻžāϰāĻ•āĻžāϰ⧀āϰ āϜāĻ¨ā§āϝ OAuth āĻ…ā§āϝāĻžāĻ•ā§āϏ⧇āϏ āĻŸā§‹āϕ⧇āύ āĻĒ⧇āϤ⧇ āĻŦā§āϝāĻŦāĻšā§ƒāϤ āĻšāϝāĻŧāĨ¤

āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āĻŸā§‡āϰ āĻ…āύ⧁āϰ⧋āϧ āϤ⧈āϰāĻŋ āĻ•āϰ⧁āύ

āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āϤ⧈āϰāĻŋ āĻ•āϰāϤ⧇ āĻ…āύ⧁āϰ⧋āϧ āĻŦāĻžāĻ°ā§āϤāĻž.

āĻ•ā§āώ⧇āĻ¤ā§āϰ
parent

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āϝ⧇ āĻĒā§āϰāĻ•āĻ˛ā§āĻĒ⧇ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āϤ⧈āϰāĻŋ āĻ•āϰāϤ⧇ āĻšāĻŦ⧇ āϤāĻžāϰ āύāĻžāĻŽāĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ parent āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.create
deploymentId

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āĻāχ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϜāĻ¨ā§āϝ āϝ⧇ ID āĻŦā§āϝāĻŦāĻšāĻžāϰ āĻ•āϰāϤ⧇ āĻšāĻŦ⧇āĨ¤ āϤ⧈āϰāĻŋ āĻ•āϰāĻž āϏāĻŽā§āĻĒāĻĻ⧇āϰ āĻĒ⧁āϰ⧋ āύāĻžāĻŽ āĻšāĻŦ⧇ projects/<project_number>/deployments/<deployment_id> āĨ¤

deployment

Deployment

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āϤ⧈āϰāĻŋ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž (deployment.name āϏ⧇āϟ āĻ•āϰāĻž āϝāĻžāĻŦ⧇ āύāĻž)āĨ¤

āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ āϰāĻŋāϕ⧋āϝāĻŧ⧇āĻ¸ā§āϟ āĻŽā§āϛ⧁āύ

āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āĻŽā§āϛ⧇ āĻĢ⧇āϞāĻžāϰ āϜāĻ¨ā§āϝ āĻ…āύ⧁āϰ⧋āϧ āĻŦāĻžāĻ°ā§āϤāĻž.

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āĻŸā§‡āϰ āϏāĻŽā§āĻĒā§‚āĻ°ā§āĻŖ āϰāĻŋāϏ⧋āĻ°ā§āϏ āύāĻžāĻŽ āĻŽā§āϛ⧇ āĻĢ⧇āϞāϤ⧇ āĻšāĻŦ⧇āĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project/deployments/my_deployment āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ name āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.delete
etag

string

āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āĻŸā§‡āϰ etag āĻŽā§āϛ⧇ āĻĢ⧇āϞāϤ⧇ āĻšāĻŦ⧇āĨ¤ āĻāϟāĻŋ āĻĒā§āϰāĻĻāĻžāύ āĻ•āϰāĻž āĻšāϞ⧇, āĻāϟāĻŋ āĻ…āĻŦāĻļā§āϝāχ āϏāĻžāĻ°ā§āĻ­āĻžāϰ⧇āϰ etag āĻāϰ āϏāĻžāĻĨ⧇ āĻŽā§‡āϞ⧇āĨ¤

āĻ¸ā§āĻĨāĻžāĻĒāύāĻž

āĻāĻ•āϟāĻŋ Google Workspace āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϏāĻŽā§āĻĒāĻĻ⧇āϰ āύāĻžāĻŽāĨ¤ āωāĻĻāĻžāĻšāϰāĻŖ: projects/123/deployments/my_deployment āĨ¤

oauthScopes[]

string

Google OAuth āĻ¸ā§āϕ⧋āĻĒ⧇āϰ āϤāĻžāϞāĻŋāĻ•āĻž āϝāĻžāϰ āϜāĻ¨ā§āϝ āĻāĻ•āϟāĻŋ āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻāĻ¨ā§āĻĄāĻĒāϝāĻŧ⧇āĻ¨ā§āϟ āĻ•āĻžāĻ°ā§āϝāĻ•āϰ āĻ•āϰāĻžāϰ āφāϗ⧇ āĻļ⧇āώ āĻŦā§āϝāĻŦāĻšāĻžāϰāĻ•āĻžāϰ⧀āϰ āĻ•āĻžāĻ› āĻĨ⧇āϕ⧇ āϏāĻŽā§āĻŽāϤāĻŋāϰ āĻ…āύ⧁āϰ⧋āϧ āĻ•āϰāϤ⧇ āĻšāĻŦ⧇āĨ¤

addOns

AddOns

Google Workspace āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ•āύāĻĢāĻŋāĻ—āĻžāϰ⧇āĻļāύāĨ¤

etag

string

āϏāĻžā§āϚāϝāĻŧāĻ¸ā§āĻĨāĻžāύ⧇ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϏāĻ‚āĻ¸ā§āĻ•āϰāϪ⧇āϰ āωāĻĒāϰ āĻ­āĻŋāĻ¤ā§āϤāĻŋ āĻ•āϰ⧇ āĻāχ āĻŽāĻžāύāϟāĻŋ āϏāĻžāĻ°ā§āĻ­āĻžāϰ āĻĻā§āĻŦāĻžāϰāĻž āĻ—āĻŖāύāĻž āĻ•āϰāĻž āĻšāϝāĻŧ āĻāĻŦāĻ‚ āĻāĻ—āĻŋāϝāĻŧ⧇ āϝāĻžāĻ“āϝāĻŧāĻžāϰ āφāϗ⧇ āĻ•ā§āϞāĻžāϝāĻŧ⧇āĻ¨ā§āĻŸā§‡āϰ āĻāĻ•āϟāĻŋ āφāĻĒ-āϟ⧁-āĻĄā§‡āϟ āĻŽāĻžāύ āφāϛ⧇ āϤāĻž āύāĻŋāĻļā§āϚāĻŋāϤ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āφāĻĒāĻĄā§‡āϟ āĻāĻŦāĻ‚ āĻŽā§āϛ⧇ āĻĢ⧇āϞāĻžāϰ āĻ…āύ⧁āϰ⧋āϧ āĻĒāĻžāĻ āĻžāύ⧋ āĻšāϤ⧇ āĻĒāĻžāϰ⧇āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āĻ…āύ⧁āϰ⧋āϧ āĻĒāĻžāύ

Google Workspace āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ…āύ⧁āĻŽā§‹āĻĻāύ āϏāĻ‚āĻ•ā§āϰāĻžāĻ¨ā§āϤ āϤāĻĨā§āϝ āĻĒ⧇āϤ⧇ āĻŽā§‡āϏ⧇āĻœā§‡āϰ āĻ…āύ⧁āϰ⧋āϧ āĻ•āϰ⧁āύāĨ¤

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āϝ⧇ āĻĒā§āϰ⧋āĻœā§‡āĻ•ā§āĻŸā§‡āϰ āϜāĻ¨ā§āϝ Google Workspace āĻ…ā§āϝāĻžāĻĄ-āĻ…āύ āĻ…āύ⧁āĻŽā§‹āĻĻāύ āϏāĻ‚āĻ•ā§āϰāĻžāĻ¨ā§āϤ āϤāĻĨā§āϝ āĻĒ⧇āϤ⧇ āĻšāĻŦ⧇ āϤāĻžāϰ āύāĻžāĻŽāĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project/authorization āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ name āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.authorizations.get

āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ āϰāĻŋāϕ⧋āϝāĻŧ⧇āĻ¸ā§āϟ āĻĒāĻžāύ

āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āĻĒ⧇āϤ⧇ āĻ…āύ⧁āϰ⧋āϧ āĻŦāĻžāĻ°ā§āϤāĻž.

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āĻĄāĻŋāĻĒā§āϞ⧋āϝāĻŧāĻŽā§‡āĻ¨ā§āĻŸā§‡āϰ āĻĒ⧁āϰ⧋ āϰāĻŋāϏ⧋āĻ°ā§āϏ āύāĻžāĻŽ āĻĒ⧇āϤ⧇ āĻšāĻŦ⧇āĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project/deployments/my_deployment āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ name āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

āĻāĻ•āϟāĻŋ āĻĒāϰ⧀āĻ•ā§āώāĻž āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āχāύāĻ¸ā§āϟāϞ āĻ¸ā§āĻĨāĻŋāϤāĻŋ āĻĒ⧇āϤ⧇ āĻ…āύ⧁āϰ⧋āϧ āĻŦāĻžāĻ°ā§āϤāĻž.

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϏāĻŽā§āĻĒā§‚āĻ°ā§āĻŖ āϏāĻŽā§āĻĒāĻĻ⧇āϰ āύāĻžāĻŽāĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project/deployments/my_deployment/installStatus āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ name āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

āĻĒāϰ⧀āĻ•ā§āώāĻžāϰ āϜāĻ¨ā§āϝ āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āχāύāĻ¸ā§āϟāϞ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āĻ…āύ⧁āϰ⧋āϧ āĻŦāĻžāĻ°ā§āϤāĻž.

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āχāύāĻ¸ā§āϟāϞ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϏāĻŽā§āĻĒā§‚āĻ°ā§āĻŖ āϏāĻŽā§āĻĒāĻĻ⧇āϰ āύāĻžāĻŽāĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project/deployments/my_deployment āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ name āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.install

āχāĻ¨ā§āϏāϟāϞ āĻ¸ā§āĻŸā§āϝāĻžāϟāĻžāϏ

āĻāĻ•āϟāĻŋ āĻĒāϰ⧀āĻ•ā§āώāĻž āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āĻ¸ā§āĻĨāĻŋāϤāĻŋ āχāύāĻ¸ā§āϟāϞ āĻ•āϰ⧁āύāĨ¤

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āχāĻ¨ā§āϏāϟāϞ āĻ¸ā§āĻŸā§āϝāĻžāϟāĻžāϏ⧇āϰ āĻ•ā§āϝāĻžāύ⧋āύāĻŋāĻ•āĻžāϞ āϏāĻŽā§āĻĒā§‚āĻ°ā§āĻŖ āϰāĻŋāϏ⧋āĻ°ā§āϏ āύāĻžāĻŽāĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/123/deployments/my_deployment/installStatus āĨ¤

installed

BoolValue

āĻŦā§āϝāĻŦāĻšāĻžāϰāĻ•āĻžāϰ⧀āϰ āϜāĻ¨ā§āϝ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āχāύāĻ¸ā§āϟāϞ āĻ•āϰāĻž āĻĨāĻžāĻ•āϞ⧇ āϏāĻ¤ā§āϝāĨ¤

āϤāĻžāϞāĻŋāĻ•āĻž āĻ¸ā§āĻĨāĻžāĻĒāύ⧇āϰ āĻ…āύ⧁āϰ⧋āϧ

āĻāĻ•āϟāĻŋ āĻĒā§āϰāĻ•āĻ˛ā§āĻĒ⧇āϰ āϜāĻ¨ā§āϝ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϤāĻžāϞāĻŋāĻ•āĻž āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āĻ…āύ⧁āϰ⧋āϧ āĻŦāĻžāĻ°ā§āϤāĻž.

āĻ•ā§āώ⧇āĻ¤ā§āϰ
parent

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āϝ⧇ āĻĒā§āϰāĻ•āĻ˛ā§āĻĒ⧇ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āϤ⧈āϰāĻŋ āĻ•āϰāϤ⧇ āĻšāĻŦ⧇ āϤāĻžāϰ āύāĻžāĻŽāĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ parent āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.list
pageSize

int32

āĻĢ⧇āϰāϤ āĻĻ⧇āĻ“āϝāĻŧāĻžāϰ āϜāĻ¨ā§āϝ āϏāĻ°ā§āĻŦāĻžāϧāĻŋāĻ• āϏāĻ‚āĻ–ā§āϝāĻ• āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāĨ¤ āĻĒāϰāĻŋāώ⧇āĻŦāĻžāϟāĻŋ āĻāχ āĻŽāĻžāύ⧇āϰ āĻĨ⧇āϕ⧇ āĻ•āĻŽ āĻĢ⧇āϰāϤ āĻĻāĻŋāϤ⧇ āĻĒāĻžāϰ⧇āĨ¤ āĻ…āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āĻĨāĻžāĻ•āϞ⧇, āϏāĻ°ā§āĻŦāĻžāϧāĻŋāĻ• 1,000 āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āĻĢ⧇āϰāϤ āĻĻ⧇āĻ“āϝāĻŧāĻž āĻšāϝāĻŧāĨ¤ āϏāĻ°ā§āĻŦāĻžāϧāĻŋāĻ• āϏāĻŽā§āĻ­āĻžāĻŦā§āϝ āĻŽāĻžāύ āĻšāϞ 1,000; 1,000-āĻāϰ āωāĻĒāϰ⧇ āĻŽāĻžāύāϗ⧁āϞāĻŋ 1,000-āĻ āĻĒāϰāĻŋāĻŦāĻ°ā§āϤāĻŋāϤ āĻšāϝāĻŧ⧎

pageToken

string

āĻĒā§‚āĻ°ā§āĻŦāĻŦāĻ°ā§āϤ⧀ ListDeployments āĻ•āϞ āĻĨ⧇āϕ⧇ āĻĒā§āϰāĻžāĻĒā§āϤ āĻāĻ•āϟāĻŋ āĻĒ⧃āĻˇā§āĻ āĻž āĻŸā§‹āϕ⧇āύāĨ¤ āĻĒāϰāĻŦāĻ°ā§āϤ⧀ āĻĒ⧃āĻˇā§āĻ āĻžāϟāĻŋ āĻĒ⧁āύāϰ⧁āĻĻā§āϧāĻžāϰ āĻ•āϰāϤ⧇ āĻāϟāĻŋ āĻĒā§āϰāĻĻāĻžāύ āĻ•āϰ⧁āύāĨ¤

āĻĒ⧇āϜāĻŋāύ⧇āϟāĻŋāĻ‚ āĻ•āϰāĻžāϰ āϏāĻŽāϝāĻŧ, ListDeployments āĻ āĻĒā§āϰāĻĻāĻ¤ā§āϤ āĻ…āĻ¨ā§āϝāĻžāĻ¨ā§āϝ āϏāĻŽāĻ¸ā§āϤ āĻĒā§āϝāĻžāϰāĻžāĻŽāĻŋāϟāĻžāϰ āĻ…āĻŦāĻļā§āϝāχ āĻĒ⧇āϜ āĻŸā§‹āϕ⧇āύ āĻĒā§āϰāĻĻāĻžāύāĻ•āĻžāϰ⧀ āĻ•āϞ⧇āϰ āϏāĻžāĻĨ⧇ āĻŽā§‡āϞ⧇āĨ¤

āϞāĻŋāĻ¸ā§āϟ āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟāϏ āϰ⧇āϏāĻĒāĻ¨ā§āϏ

āϤāĻžāϞāĻŋāĻ•āĻž āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āĻĒā§āϰāϤāĻŋāĻ•ā§āϰāĻŋāϝāĻŧāĻž āĻŦāĻžāĻ°ā§āϤāĻž.

āĻ•ā§āώ⧇āĻ¤ā§āϰ
deployments[]

Deployment

āĻĒā§āϰāĻĻāĻ¤ā§āϤ āĻĒā§āϰāĻ•āĻ˛ā§āĻĒ⧇āϰ āϜāĻ¨ā§āϝ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϤāĻžāϞāĻŋāĻ•āĻžāĨ¤

nextPageToken

string

āĻāĻ•āϟāĻŋ āĻŸā§‹āϕ⧇āύ, āϝāĻž āĻĒāϰāĻŦāĻ°ā§āϤ⧀ āĻĒ⧃āĻˇā§āĻ āĻž āĻĒ⧁āύāϰ⧁āĻĻā§āϧāĻžāϰ āĻ•āϰāϤ⧇ page_token āĻšāĻŋāϏāĻžāĻŦ⧇ āĻĒāĻžāĻ āĻžāύ⧋ āϝ⧇āϤ⧇ āĻĒāĻžāϰ⧇āĨ¤ āϝāĻĻāĻŋ āĻāχ āĻ•ā§āώ⧇āĻ¤ā§āϰāϟāĻŋ āĻŦāĻžāĻĻ āĻĻ⧇āĻ“āϝāĻŧāĻž āĻšāϝāĻŧ, āϤāĻžāĻšāϞ⧇ āĻĒāϰāĻŦāĻ°ā§āϤ⧀ āĻĒ⧃āĻˇā§āĻ āĻž āĻĨāĻžāĻ•āĻŦ⧇ āύāĻžāĨ¤

āĻĒā§āϰāϤāĻŋāĻ¸ā§āĻĨāĻžāĻĒāύ⧇āϰ āĻ…āύ⧁āϰ⧋āϧ

āĻāĻ•āϟāĻŋ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āϤ⧈āϰāĻŋ āĻŦāĻž āĻĒā§āϰāϤāĻŋāĻ¸ā§āĻĨāĻžāĻĒāύ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āĻŦāĻžāĻ°ā§āϤāĻžāϰ āĻ…āύ⧁āϰ⧋āϧ āĻ•āϰ⧁āύāĨ¤

āĻ•ā§āώ⧇āĻ¤ā§āϰ
deployment

Deployment

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āϤ⧈āϰāĻŋ āĻŦāĻž āĻĒā§āϰāϤāĻŋāĻ¸ā§āĻĨāĻžāĻĒāύ.

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϏāĻ‚āĻ¸ā§āĻĨāĻžāύ deployment āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.update

āφāύāχāύāĻ¸ā§āϟāϞ āĻĄāĻŋāĻĒā§āϞāϝāĻŧāĻŽā§‡āĻ¨ā§āϟ āĻ…āύ⧁āϰ⧋āϧ

āĻāĻ•āϟāĻŋ āĻĒāϰ⧀āĻ•ā§āώāĻž āĻ¸ā§āĻĨāĻžāĻĒāύāĻž āφāύāχāύāĻ¸ā§āϟāϞ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āĻŦāĻžāĻ°ā§āϤāĻžāϰ āĻ…āύ⧁āϰ⧋āϧ āĻ•āϰ⧁āύāĨ¤

āĻ•ā§āώ⧇āĻ¤ā§āϰ
name

string

āĻĒā§āϰāϝāĻŧā§‹āϜāύāĨ¤ āχāύāĻ¸ā§āϟāϞ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ āĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϏāĻŽā§āĻĒā§‚āĻ°ā§āĻŖ āϏāĻŽā§āĻĒāĻĻ⧇āϰ āύāĻžāĻŽāĨ¤

āωāĻĻāĻžāĻšāϰāĻŖ: projects/my_project/deployments/my_deployment āĨ¤

āĻ…āύ⧁āĻŽā§‹āĻĻāύ⧇āϰ āϜāĻ¨ā§āϝ āύāĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āϟ āϰāĻŋāϏ⧋āĻ°ā§āϏ name āύāĻŋāĻŽā§āύāϞāĻŋāĻ–āĻŋāϤ IAM āĻ…āύ⧁āĻŽāϤāĻŋ āĻĒā§āϰāϝāĻŧā§‹āϜāύ:

  • gsuiteaddons.deployments.execute