Package apps.extensions.markup

Índice

CalendarClientActionMarkup

Campos
editAttendeesActionMarkup

EditAttendeesActionMarkup

Uma ação que adiciona convidados ao evento do Google Agenda.
editConferenceDataActionMarkup

EditConferenceDataActionMarkup

Uma ação que adiciona dados de videoconferência ao evento da agenda do Google. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.
addAttachmentsActionMarkup

AddAttachmentsActionMarkup

Uma ação que adiciona anexos ao evento do Google Agenda.
createConferenceDataActionMarkup

CreateConferenceDataActionMarkup

Uma ação que mostra dados de conferência ao criar um evento da agenda.
createConferenceSettingUrlActionMarkup

CreateConferenceSettingUrlActionMarkup

Uma ação que gera o URL de configuração de criação de conferência.
calendarSubscriptionActionMarkup

CalendarSubscriptionActionMarkup

Uma ação que gerencia uma inscrição em uma agenda. Compatível apenas com a criação de assinaturas em complementos de endpoints HTTP. Não relevante para complementos do Apps Script.

AddAttachmentsActionMarkup

Campos
addonAttachments[]

AddonAttachment

AddonAttachment

Campos
resourceUrl

string
title

string

Título do anexo.
mimeType

string

Tipo MIME do conteúdo em resourceUrl.
iconUrl

string

Link para o ícone do recurso.

CalendarSubscriptionActionMarkup

Campos
operation

Operation

A operação a ser executada. No momento, apenas CREATE é aceito.
calendarId

string

O ID da agenda em que você quer se inscrever.

Operação

Tipos enumerados
OPERATION_UNSPECIFIED
CREATE

ConferenceDataMarkup

Marcação que define os dados de videoconferência associados a um evento da agenda do Google. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.

Campos
conferenceId

string

Identificador exclusivo desses dados de conferência. Máximo de 512 caracteres.
entryPoints[]

EntryPointMarkup

Pontos de entrada para a conferência. São permitidos no máximo 300 pontos de entrada.
parameters[]

Parameter

Parâmetros extras do complemento. São permitidos no máximo 300 parâmetros.
error

Error

Se definido, significa que ocorreu um erro durante a criação da conferência.
note

string

Observações adicionais (como instruções do administrador, avisos legais) para mostrar ao usuário. Pode conter HTML. O tamanho máximo é de 2.048 caracteres.
conferenceSolutionId

string

Um identificador da solução de videoconferência. Precisa corresponder a um valor do campo calendar.conferenceSolution.id da implantação.

EntryPointMarkup

Uma forma de participar da conferência. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.

Campos
type

Type

O tipo do ponto de entrada. Obrigatório.
uri

string

Um URI para participar da conferência. Aceita tel: e http(s): e pode ter no máximo 1.300 caracteres. Obrigatório.
label

string

O rótulo do ponto de entrada a ser mostrado ao usuário. Máximo de 512 caracteres.
meetingCode

string

Um código da reunião para acessar a conferência. Máximo de 128 caracteres.
accessCode

string

Um código de acesso para entrar na conferência. Máximo de 128 caracteres.
passcode

string

Uma senha para acessar a conferência. Máximo de 128 caracteres.
password

string

Uma senha para acessar a conferência. Máximo de 128 caracteres.
pin

string

Um PIN para acessar a conferência. Máximo de 128 caracteres.
regionCode

string

O código regional CLDR/ISO 3166 do país associado a este ponto de entrada. Aplicável apenas a Type.PHONE.
features[]

Feature

Recursos do ponto de entrada, como ser pago ou sem custo financeiro. Um ponto de entrada pode ter vários recursos.

Recurso

Recursos do ponto de entrada. Alguns recursos podem ser aplicados apenas a pontos de entrada específicos.

Tipos enumerados
UNKNOWN_FEATURE Recurso desconhecido.
TOLL Aplicável ao ponto de entrada PHONE. Uma chamada para um número tarifado é cobrada da pessoa que fez a ligação. Um número não pode ser tarifado e sem custo financeiro ao mesmo tempo.
TOLL_FREE Aplicável ao ponto de entrada PHONE. Para quem liga, uma chamada para um número para chamada sem custo financeiro não tem custo financeiro. Um número não pode ser tarifado e sem custo financeiro ao mesmo tempo.

Tipo

O tipo do ponto de entrada. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.

Tipos enumerados
UNKNOWN Tipo de conferência desconhecido.
VIDEO Uma videoconferência.
PHONE Uma conferência por telefone.
MORE Usado para fornecer um link com mais informações sobre como participar da conferência.
SIP Uma conferência usando o Session Initiation Protocol

Erro

Representa um erro que ocorreu durante a criação da conferência. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.

Campos
type

Type

O tipo de erro. Obrigatório.
authenticationUrl

string

Se o tipo de erro for AUTHENTICATION, o complemento poderá fornecer um URL para que os usuários façam login. Máximo de 1.300 caracteres.

Tipo

Tipos enumerados
UNKNOWN Erro desconhecido.
AUTHENTICATION Um erro de autenticação.
TEMPORARY Um erro temporário.
PERMANENT Um erro permanente.
PERMISSION_DENIED O usuário não tem permissão para realizar alguma ação no sistema de videoconferência de terceiros.
CONFERENCE_SOLUTION_FORBIDDEN O usuário não tem permissão para usar a solução de conferência selecionada, mas pode usar outras soluções oferecidas pelo complemento.

Parâmetro

Parâmetros específicos da solução que são mantidos com os dados de eventos e, se uma atualização ou exclusão for necessária, são transmitidos para o complemento. Por exemplo: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

Campos
key

string

A chave do parâmetro. Máximo de 50 caracteres. Obrigatório.
value

string

O valor do parâmetro. Máximo de 1.024 caracteres. Obrigatório.

CreateConferenceDataActionMarkup

Campos
createConferenceData

ConferenceDataMarkup

Os dados da videoconferência a serem adicionados a um evento da agenda do Google ao criar.

CreateConferenceSettingUrlActionMarkup

Campos
settingsUrl

string

O URI de uma página de configurações gerada pelo complemento.

EditAttendeesActionMarkup

Campos
addAttendeeEmails[]

string

Uma lista de participantes para adicionar ao evento do Google Agenda.

EditConferenceDataActionMarkup

Campos

Campo de união conference.

conference pode ser apenas de um dos tipos a seguir:
conferenceData

ConferenceDataMarkup

Os dados da conferência a serem adicionados ao evento da agenda do Google. Os complementos de videoconferência de terceiros só podem ser criados no Apps Script.

ChatClientDataSourceMarkup

Para um widget SelectionInput que usa um menu de seleção múltipla, uma fonte de dados do Google Chat. A fonte de dados preenche os itens de seleção do menu de seleção múltipla. Por exemplo, um usuário pode selecionar os espaços do Google Chat de que participa.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Campos
Campo de união source. A fonte de dados do Google Chat. source pode ser apenas de um dos tipos a seguir:
spaceDataSource

SpaceDataSource

Espaços do Google Chat de que o usuário participa.

SpaceDataSource

Uma fonte de dados que preenche os espaços do Google Chat como itens de seleção para um menu de seleção múltipla. Preenche apenas os espaços de que o usuário é membro.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Campos
defaultToCurrentSpace

bool

Se definido como true, o menu de seleção múltipla vai selecionar o espaço atual do Google Chat como um item por padrão.

ChatDataActionMarkup

Cria ou atualiza uma mensagem no Google Chat. Para mais detalhes, consulte Criar interfaces do Google Chat.

Campos
Campo de união action. Uma ação do Google Chat. action pode ser apenas de um dos tipos a seguir:
createMessageAction

CreateMessageAction

Envia uma mensagem como um app de chat do Google Chat.
updateMessageAction

UpdateMessageAction

Atualiza a mensagem de um app do Google Chat.
updateInlinePreviewAction

UpdateInlinePreviewAction

Para visualizar links, adicione um ou mais cards à mensagem de um usuário do Google Chat.

CreateMessageAction

O app de chat envia uma mensagem. Para mais detalhes, consulte Enviar mensagens do Google Chat.

Campos
message

Message

A mensagem do Google Chat.

UpdateInlinePreviewAction

O app de chat mostra uma prévia de um link em uma mensagem adicionando ou atualizando um ou mais cards. Para mais detalhes, consulte Visualizar links em mensagens do Google Chat.

Campos
cardsV2[]

CardWithId

Uma matriz de um ou mais cards.

UpdateMessageAction

O app de chat atualiza texto ou cards em uma mensagem. Para mais detalhes, consulte Enviar mensagens do Google Chat.

Campos
message

Message

A mensagem atualizada.

DriveClientActionMarkup

Campos
requestFileScope

RequestFileScope

RequestFileScope

Campos
itemId

string

EditorClientActionMarkup

Campos

Campo de união action.

action pode ser apenas de um dos tipos a seguir:
requestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

Esse tipo não tem campos.

GmailClientActionMarkup

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
taskAction

TaskActionMarkup
updateDraftActionMarkup

UpdateDraftActionMarkup
openCreatedDraftActionMarkup

OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup

AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

Campos
type

AddonComposeUiActionType

AddonComposeUiActionType

Tipos enumerados
UNSPECIFIED Padrão. Quando não especificado, nenhuma ação é realizada.
DISMISS Dispensa a interface do complemento.

OpenCreatedDraftActionMarkup

Campos
draftId

string

O ID do rascunho recém-criado no formato "r123".
draftStorageId

string

O ID de armazenamento do servidor em formato hexadecimal, por exemplo,"15e9fa622ce1029d".
draftThreadServerPermId

string

O ID permanente do servidor para a conversa do rascunho. Esse campo não é definido em nenhum lugar e é ignorado ao processar OpenCreatedDraftActionMarkup. Forneça e use draftThreadStorageId.
draftThreadId

string

O ID da conversa que contém o rascunho recém-criado. Por exemplo, "15e9fa622ce1029d".

TaskActionMarkup

Campos
reloadTasks

bool

UpdateDraftActionMarkup

Campos
updateBody

UpdateBody

Um campo que contém uma série de ações de atualização a serem realizadas no corpo do rascunho que o usuário está editando.
updateToRecipients

UpdateToRecipients

Se definido, substitui os destinatários "Para" do rascunho que o usuário está editando.
updateCcRecipients

UpdateCcRecipients

Se definido, substitui os destinatários em Cc do rascunho que o usuário está editando.
updateBccRecipients

UpdateBccRecipients

Se definido, substitui os destinatários em Cco do rascunho que o usuário está editando.
updateSubject

UpdateSubject

Se definido, substitui o assunto atual do rascunho que o usuário está editando.

Destinatário

Campos
email

string

UpdateBccRecipients

Campos
bccRecipients[]

Recipient

UpdateBody

Campos
insertContents[]

InsertContent

Um campo repetido que contém uma série de conteúdos a serem inseridos no rascunho que o usuário está editando. O conteúdo pode ter HTML ou texto simples.
type

Type

ContentType

Tipos enumerados
UNSPECIFIED_CONTENT_TYPE Valor padrão quando nada é definido para ContentType.
TEXT Especifica que o conteúdo está em texto simples.
MUTABLE_HTML Especifica que o conteúdo está em HTML e é mutável (pode ser editado).
IMMUTABLE_HTML Especifica que o conteúdo está em HTML e é imutável (não pode ser editado).

EmailMimeType

EmailMimeType foi descontinuado. Use ContentType.

Tipos enumerados
UNSPECIFIED_EMAIL_MIME_TYPE Valor padrão quando nada é definido para EmailMimeType.
PLAIN_TEXT Especifica que o conteúdo inserido está em texto simples.
HTML Especifica que o conteúdo inserido está em HTML.

InsertContent

Campos
content

string

O conteúdo a ser inserido.
mimeType
(deprecated)

EmailMimeType
contentType

ContentType

O tipo de conteúdo inserido.

Tipo

Tipos enumerados
UNSPECIFIED_ACTION_TYPE Valor padrão quando nada é definido para "Tipo".
IN_PLACE_INSERT Indica que a ação é para realizar uma inserção no lugar. Por padrão, o conteúdo é inserido na posição atual do cursor. Se houver conteúdo selecionado, ele será substituído.
INSERT_AT_START Indica que a ação é inserir no início do corpo da mensagem.
INSERT_AT_END Indica que a ação é para inserir no final do corpo da mensagem.
REPLACE Indica que esta ação deve substituir o corpo da mensagem.

UpdateCcRecipients

Campos
ccRecipients[]

Recipient

UpdateSubject

Campos
subject

string

UpdateToRecipients

Campos
toRecipients[]

Recipient

HostAppActionMarkup

Ações processadas por apps host individuais.

Campos

Campo de união action.

action pode ser apenas de um dos tipos a seguir:
gmailAction

GmailClientActionMarkup

Ações processadas pelo Gmail.
calendarAction

CalendarClientActionMarkup

Ações gerenciadas pelo Google Agenda.
driveAction

DriveClientActionMarkup

Ações processadas pelo Drive.
editorAction

EditorClientActionMarkup

Ações processadas pelos apps Documentos, Planilhas ou Apresentações.
sheetsAction

SheetsClientActionMarkup

Ações processadas pelo Planilhas.

HostAppDataActionMarkup

Define como atualizar os dados do Google Workspace.

Campos
Campo de união action. A ação do complemento para um determinado aplicativo host do Google Workspace. action pode ser apenas de um dos tipos a seguir:
chatDataAction

ChatDataActionMarkup

Uma ação do Google Chat que cria ou atualiza texto ou cards em uma mensagem.

HostAppDataSourceMarkup

Uma fonte de dados de um aplicativo do Google Workspace. A fonte de dados preenche os itens disponíveis para um widget.

Campos
Campo de união data_source. O aplicativo do Google Workspace que preenche os itens disponíveis para um widget. data_source pode ser apenas de um dos tipos a seguir:
chatDataSource

ChatClientDataSourceMarkup

Uma fonte de dados do Google Chat.

SheetsClientActionMarkup

Próximo ID: 5.

Campos

Campo de união action.

action pode ser apenas de um dos tipos a seguir:
customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

O resultado de um usuário executando uma função personalizada.

Campos
Campo de união result. O resultado da execução da função personalizada. result pode ser apenas de um dos tipos a seguir:
value

Value

O valor resultante da execução da função personalizada.
errorMessage

string

A mensagem de erro para mostrar ao usuário se algo deu errado.