Google Workspace Add-ons V1 Client - Class AddOns (0.2.3)

Reference documentation and code samples for the Google Workspace Add-ons V1 Client class AddOns.

A Google Workspace Add-on configuration.

Generated from protobuf message google.cloud.gsuiteaddons.v1.AddOns

Namespace

Google \ Cloud \ GSuiteAddOns \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ common Google\Apps\Script\Type\CommonAddOnManifest

Configuration that is common across all Google Workspace Add-ons.
↳ gmail Google\Apps\Script\Type\Gmail\GmailAddOnManifest

Gmail add-on configuration.
↳ drive Google\Apps\Script\Type\Drive\DriveAddOnManifest

Drive add-on configuration.
↳ calendar Google\Apps\Script\Type\Calendar\CalendarAddOnManifest

Calendar add-on configuration.
↳ docs Google\Apps\Script\Type\Docs\DocsAddOnManifest

Docs add-on configuration.
↳ sheets Google\Apps\Script\Type\Sheets\SheetsAddOnManifest

Sheets add-on configuration.
↳ slides Google\Apps\Script\Type\Slides\SlidesAddOnManifest

Slides add-on configuration.
↳ http_options Google\Apps\Script\Type\HttpOptions

Options for sending requests to add-on HTTP endpoints

getCommon

Configuration that is common across all Google Workspace Add-ons.

Returns
Type Description
Google\Apps\Script\Type\CommonAddOnManifest|null

hasCommon

clearCommon

setCommon

Configuration that is common across all Google Workspace Add-ons.

Parameter
Name Description
var Google\Apps\Script\Type\CommonAddOnManifest
Returns
Type Description
$this

getGmail

Gmail add-on configuration.

Returns
Type Description
Google\Apps\Script\Type\Gmail\GmailAddOnManifest|null

hasGmail

clearGmail

setGmail

Gmail add-on configuration.

Parameter
Name Description
var Google\Apps\Script\Type\Gmail\GmailAddOnManifest
Returns
Type Description
$this

getDrive

Drive add-on configuration.

Returns
Type Description
Google\Apps\Script\Type\Drive\DriveAddOnManifest|null

hasDrive

clearDrive

setDrive

Drive add-on configuration.

Parameter
Name Description
var Google\Apps\Script\Type\Drive\DriveAddOnManifest
Returns
Type Description
$this

getCalendar

Calendar add-on configuration.

Returns
Type Description
Google\Apps\Script\Type\Calendar\CalendarAddOnManifest|null

hasCalendar

clearCalendar

setCalendar

Calendar add-on configuration.

Parameter
Name Description
var Google\Apps\Script\Type\Calendar\CalendarAddOnManifest
Returns
Type Description
$this

getDocs

Docs add-on configuration.

Returns
Type Description
Google\Apps\Script\Type\Docs\DocsAddOnManifest|null

hasDocs

clearDocs

setDocs

Docs add-on configuration.

Parameter
Name Description
var Google\Apps\Script\Type\Docs\DocsAddOnManifest
Returns
Type Description
$this

getSheets

Sheets add-on configuration.

Returns
Type Description
Google\Apps\Script\Type\Sheets\SheetsAddOnManifest|null

hasSheets

clearSheets

setSheets

Sheets add-on configuration.

Parameter
Name Description
var Google\Apps\Script\Type\Sheets\SheetsAddOnManifest
Returns
Type Description
$this

getSlides

Slides add-on configuration.

Returns
Type Description
Google\Apps\Script\Type\Slides\SlidesAddOnManifest|null

hasSlides

clearSlides

setSlides

Slides add-on configuration.

Parameter
Name Description
var Google\Apps\Script\Type\Slides\SlidesAddOnManifest
Returns
Type Description
$this

getHttpOptions

Options for sending requests to add-on HTTP endpoints

Returns
Type Description
Google\Apps\Script\Type\HttpOptions|null

hasHttpOptions

clearHttpOptions

setHttpOptions

Options for sending requests to add-on HTTP endpoints

Parameter
Name Description
var Google\Apps\Script\Type\HttpOptions
Returns
Type Description
$this