Package apps.extensions.markup

Index

• CalendarClientActionMarkup (message)
• CalendarClientActionMarkup.AddAttachmentsActionMarkup (message)
• CalendarClientActionMarkup.AddAttachmentsActionMarkup.AddonAttachment (message)
• CalendarClientActionMarkup.ConferenceDataMarkup (message)
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup (message)
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Feature (enum)
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Type (enum)
• CalendarClientActionMarkup.ConferenceDataMarkup.Error (message)
• CalendarClientActionMarkup.ConferenceDataMarkup.Error.Type (enum)
• CalendarClientActionMarkup.ConferenceDataMarkup.Parameter (message)
• CalendarClientActionMarkup.EditAttendeesActionMarkup (message)
• CalendarClientActionMarkup.EditConferenceDataActionMarkup (message)
• ChatClientDataSourceMarkup (message)
• ChatClientDataSourceMarkup.SpaceDataSource (message)
• DriveClientActionMarkup (message)
• DriveClientActionMarkup.RequestFileScope (message)
• EditorClientActionMarkup (message)
• EditorClientActionMarkup.RequestFileScopeForActiveDocument (message)
• GmailClientActionMarkup (message)
• GmailClientActionMarkup.AddonComposeUiActionMarkup (message)
• GmailClientActionMarkup.AddonComposeUiActionMarkup.AddonComposeUiActionType (enum)
• GmailClientActionMarkup.OpenCreatedDraftActionMarkup (message)
• GmailClientActionMarkup.TaskActionMarkup (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup.Recipient (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBccRecipients (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.ContentType (enum)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.EmailMimeType (enum)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.InsertContent (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.Type (enum)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateCcRecipients (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateSubject (message)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateToRecipients (message)
• HostAppActionMarkup (message)
• HostAppDataSourceMarkup (message)
• SheetsClientActionMarkup (message)
• SheetsClientActionMarkup.CustomFunctionReturnValueMarkup (message)

CalendarClientActionMarkup

Fields
editAttendeesActionMarkup	EditAttendeesActionMarkup An action that adds attendees to the Google Calendar event.
editConferenceDataActionMarkup	EditConferenceDataActionMarkup An action that adds conference data to the Google Calendar event. Third-party conferencing add-ons can only be built in Apps Script.
addAttachmentsActionMarkup	AddAttachmentsActionMarkup An action that adds attachments to the Google Calendar event.

AddAttachmentsActionMarkup

Fields
addonAttachments[]	AddonAttachment

AddonAttachment

Fields
resourceUrl	string
title	string Title of the attachment.
mimeType	string MIME type of the content in resourceUrl.
iconUrl	string Link to the resource's icon.

ConferenceDataMarkup

Markup that defines conference data associated to a Google Calendar event. Third-party conferencing add-ons can only be built in Apps Script.

Fields
conferenceId	string Unique identifier for this conference data. Maximum 512 characters long.
entryPoints[]	EntryPointMarkup Entry points to the conference. Maximum 300 entry points are allowed.
parameters[]	Parameter Additional add-on parameters. Maximum 300 parameters are allowed.
error	Error If set, it means an error occurred during conference creation.
note	string Additional notes (such as instructions from the administrator, legal notices) to display to the user. Can contain HTML. Max length 2048 characters.
conferenceSolutionId	string An identifier of the conferencing solution. Must match a value from the deployment's calendar.conferenceSolution.id field.

EntryPointMarkup

A way to join the conference. Third-party conferencing add-ons can only be built in Apps Script.

Fields
type	Type The type of the entry point. Required.
uri	string A URI for joining the conference. Supports tel: and http(s): and should be at most 1300 characters long. Required.
label	string The label of the entry point to display to the user. Maximum 512 characters long.
meetingCode	string A meeting code for accessing the conference. Maximum 128 characters long.
accessCode	string An access code for accessing the conference. Maximum 128 characters long.
passcode	string A passcode for accessing the conference. Maximum 128 characters long.
password	string A password for accessing the conference. Maximum 128 characters long.
pin	string A PIN for accessing the conference. Maximum 128 characters long.
regionCode	string The CLDR/ISO 3166 region code for the country associated with this entry point. Applicable only to Type.PHONE.
features[]	Feature Features of the entry point, such as being toll or toll-free. One entry point can have multiple features.

Feature

Features of the entry point. Some features might apply only to specific entry points.

Enums
UNKNOWN_FEATURE	Unknown feature.
TOLL	Applies to PHONE entry point. A call to a toll number is charged to the calling party. A number can't be toll and toll-free at the same time.
TOLL_FREE	Applies to PHONE entry point. For the calling party, a call to a toll-free number is free of charge. A number can't be toll and toll-free at the same time.

Type

The type of the entry point. Third-party conferencing add-ons can only be built in Apps Script.

Enums
UNKNOWN	Unknown conference type.
VIDEO	A video conference.
PHONE	A phone conference.
MORE	Used to provide a link to further conference joining information.
SIP	A conference using Session Initiation Protocol

Error

Represents an error that occurred during conference creation. Third-party conferencing add-ons can only be built in Apps Script.

Fields
type	Type The type of error. Required.
authenticationUrl	string If the error type is AUTHENTICATION, the add-on can provide a URL allowing users to log in. Maximum 1300 characters long.

Type

Enums
UNKNOWN	Unknown error.
AUTHENTICATION	An authentication error.
TEMPORARY	A temporary error.
PERMANENT	A permanent error.
PERMISSION_DENIED	The user isn't allowed to perform some action in the third-party conferencing system.
CONFERENCE_SOLUTION_FORBIDDEN	The user isn't allowed to use the selected conference solution (but might be allowed to use other solutions offered by the add-on).

Parameter

Solution-specific parameters that are persisted with the event data and, if an update or delete is needed, are passed to the add-on. For example: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

Fields
key	string The key of the parameter. Maximum 50 characters long. Required.
value	string The value of the parameter. Maximum 1024 characters long. Required.

EditAttendeesActionMarkup

Fields
addAttendeeEmails[]	string A list of attendees to add to the Google Calendar event.

EditConferenceDataActionMarkup

Fields
Union field conference. conference can be only one of the following:
conferenceData	ConferenceDataMarkup The conference data to add to the Google Calendar event. Third-party conferencing add-ons can only be built in Apps Script.

ChatClientDataSourceMarkup

For a SelectionInput widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of.

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

Fields
Union field source. The Google Chat data source. source can be only one of the following:
spaceDataSource	SpaceDataSource Google Chat spaces that the user is a member of.

SpaceDataSource

A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of.

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

Fields
defaultToCurrentSpace	bool If set to true, the multiselect menu selects the current Google Chat space as an item by default.

DriveClientActionMarkup

Fields
requestFileScope	RequestFileScope

RequestFileScope

Fields
itemId	string

EditorClientActionMarkup

Fields
Union field action. action can be only one of the following:
requestFileScopeForActiveDocument	RequestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

This type has no fields.

GmailClientActionMarkup

Fields
Union field type. type can be only one of the following:
taskAction	TaskActionMarkup
updateDraftActionMarkup	UpdateDraftActionMarkup
openCreatedDraftActionMarkup	OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup	AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

Fields
type	AddonComposeUiActionType

AddonComposeUiActionType

Enums
UNSPECIFIED	Default. When unspecified, no action is taken.
DISMISS	Dismisses the add-on compose UI.

OpenCreatedDraftActionMarkup

Fields
draftId	string The ID of the newly created draft in the form "r123".
draftStorageId	string The server storage ID in hex format, for example,"15e9fa622ce1029d".
draftThreadServerPermId	string The server permanent ID for the draft's thread. This field isn't set anywhere, and it's ignored when processing OpenCreatedDraftActionMarkup. Supply and use draftThreadStorageId instead.
draftThreadId	string The ID of the thread containing the newly created draft, for example, "15e9fa622ce1029d".

TaskActionMarkup

Fields
reloadTasks	bool

UpdateDraftActionMarkup

Fields
updateBody	UpdateBody A field that contains a series of update actions to perform on the draft body that the user is currently editing.
updateToRecipients	UpdateToRecipients If set, replaces the existing To recipients of the draft the user is currently editing.
updateCcRecipients	UpdateCcRecipients If set, replaces the existing Cc recipients of the draft the user is currently editing.
updateBccRecipients	UpdateBccRecipients If set, replaces the existing Bcc recipients of the draft the user is currently editing.
updateSubject	UpdateSubject If set, replaces the existing subject of the draft the user is currently editing.

Recipient

Fields
email	string

UpdateBccRecipients

Fields
bccRecipients[]	Recipient

UpdateBody

Fields
insertContents[]	InsertContent A repeated field that contains a series of content to insert into the draft that the user is currently editing. The content can contain HTML content or plain text content.
type	Type

ContentType

Enums
UNSPECIFIED_CONTENT_TYPE	Default value when nothing is set for ContentType.
TEXT	Specifies that the content is in plain text.
MUTABLE_HTML	Specifies that the content is in HTML and is mutable (can be edited).
IMMUTABLE_HTML	Specifies that the content is in HTML and is immutable (cannot be edited).

EmailMimeType

EmailMimeType is deprecated. Please use ContentType.

Enums
UNSPECIFIED_EMAIL_MIME_TYPE	Default value when nothing is set for EmailMimeType.
PLAIN_TEXT	Specifies that the inserted content is in plain text.
HTML	Specifies that the inserted content is in HTML.

InsertContent

Fields
content	string The content to be inserted.
mimeType (deprecated)	EmailMimeType This item is deprecated!
contentType	ContentType The type of inserted content.

Type

Enums
UNSPECIFIED_ACTION_TYPE	Default value when nothing is set for Type.
IN_PLACE_INSERT	Indicates this action is to perform an in-place insertion. By default the content is inserted at the current cursor position, if there is selected content, it replaces the selected content.
INSERT_AT_START	Indicates this action is to perform insert at the start of the message body.
INSERT_AT_END	Indicates this action is to perform insert at the end of the message body.
REPLACE	Indicates this action is to replace the message body.

UpdateCcRecipients

Fields
ccRecipients[]	Recipient

UpdateSubject

Fields
subject	string

UpdateToRecipients

Fields
toRecipients[]	Recipient

HostAppActionMarkup

Actions handled by individual host apps.

Fields
Union field action. action can be only one of the following:
gmailAction	GmailClientActionMarkup Actions handled by Gmail.
calendarAction	CalendarClientActionMarkup Actions handled by Calendar.
driveAction	DriveClientActionMarkup Actions handled by Drive.
editorAction	EditorClientActionMarkup Actions handled by Docs, Sheets, or Slides.
sheetsAction	SheetsClientActionMarkup Actions handled by Sheets.

HostAppDataSourceMarkup

For a SelectionInput widget that uses a multiselect menu, a data source from a Google Workspace application. The data source populates selection items for the multiselect menu.

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

Fields
Union field data_source. The Google Workspace application that populates items for a multiselect menu. data_source can be only one of the following:
chatDataSource	ChatClientDataSourceMarkup A data source from Google Chat.

SheetsClientActionMarkup

Fields
customFunctionReturnValueMarkup	CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

The result of a user running a custom function.

Fields
Union field result. The result of the custom function execution. result can be only one of the following:
value	Value The value that resulted from running the custom function.
errorMessage	string The error message to show to the user if something went wrong.