Package apps.extensions.markup

Índice

CalendarClientActionMarkup

Campos
editAttendeesActionMarkup

EditAttendeesActionMarkup

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

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

Uma ação que adiciona dados de videoconferência ao evento do Google Agenda.

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

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

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.

ConferenceDataMarkup

Marcação que define os dados da videoconferência associados a um evento do Google Agenda.

Campos
conferenceId

string

Identificador exclusivo dos dados de videoconferê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

Outros parâmetros de complementos. São permitidos no máximo 300 parâmetros.

error

Error

Se ela for definida, um erro ocorreu durante a criação da videoconferência.

note

string

Notas adicionais (como instruções do administrador, avisos legais) a serem exibidas ao usuário. Pode conter HTML. Comprimento 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 videoconferência.

Campos
type

Type

O tipo do ponto de entrada. Obrigatório.

uri

string

Um URI para participar da videoconferência. Oferece suporte a tel: e http(s): e deve ter no máximo 1.300 caracteres. Obrigatório.

label

string

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

meetingCode

string

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

accessCode

string

Um código de acesso para acessar a conferência. Máximo de 128 caracteres.

passcode

string

Uma senha para acessar a videoconferê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 videoconferê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 pedágio ou sem custo financeiro. Um ponto de entrada pode ter vários recursos.

Recurso

Recursos do ponto de entrada. Alguns recursos podem se aplicar somente a pontos de entrada específicos.

Enums
UNKNOWN_FEATURE Recurso desconhecido.
TOLL Aplicável ao ponto de entrada PHONE. As ligações para um número chamado serão cobradas da parte que fez a chamada. Um número não pode ser chamado e sem custo financeiro ao mesmo tempo.
TOLL_FREE Aplicável ao ponto de entrada PHONE. Para a parte que fez a chamada, uma chamada para um número sem custo financeiro é sem custo financeiro. Um número não pode ser chamado e sem custo financeiro ao mesmo tempo.

Tipo

O tipo do ponto de entrada.

Enums
UNKNOWN Tipo de videoconferê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 de uma conferência.
SIP Uma videoconferência usando o protocolo de início de sessão

Erro

Representa um erro que ocorreu durante a criação da conferência.

Campos
type

Type

O tipo de erro. Obrigatório.

authenticationUrl

string

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

Tipo

Enums
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 videoconferê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 do evento e, se for necessário atualizar ou excluir, são transmitidos para o complemento. 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.

EditAttendeesActionMarkup

Campos
addAttendeeEmails[]

string

Uma lista de participantes a serem adicionados 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 videoconferência a serem adicionados ao evento do Google Agenda.

ChatClientActionMarkup

Esse tipo não tem campos.

Ações processadas pelos clientes do Chat.

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 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. Só preenche os espaços de que o usuário participa.

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.

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

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

OpenCreatedDraftActionMarkup

Campos
draftId

string

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

draftStorageId

string

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

draftThreadServerPermId

string

O código permanente do servidor para a conversa do rascunho. Este campo não é definido em lugar nenhum e é ignorado ao processar OpenCreatedDraftActionMarkup. Forneça e use rascunhoThreadStorageId.

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 várias ações de atualização a serem executadas no corpo do rascunho que o usuário está editando no momento.

updateToRecipients

UpdateToRecipients

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

updateCcRecipients

UpdateCcRecipients

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

updateBccRecipients

UpdateBccRecipients

Se definido, substitui os destinatários Cco existentes do rascunho que o usuário está editando no momento.

updateSubject

UpdateSubject

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

Destinatário

Campos
email

string

UpdateBccRecipients

Campos
bccRecipients[]

Recipient

UpdateBody

Campos
insertContents[]

InsertContent

Um campo repetido com uma série de conteúdo a ser inserido no rascunho que o usuário está editando no momento. O conteúdo pode ter HTML ou texto simples.

type

Type

ContentType

Enums
UNSPECIFIED_CONTENT_TYPE Valor padrão quando nada está 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

O uso de EmailMimeType foi descontinuado. Use ContentType.

Enums
UNSPECIFIED_EMAIL_MIME_TYPE Valor padrão quando nada estiver 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

Enums
UNSPECIFIED_ACTION_TYPE Valor padrão quando nada estiver definido para "Tipo".
IN_PLACE_INSERT Indica que a ação é realizar uma inserção no local. Por padrão, o conteúdo é inserido na posição atual do cursor. Se houver conteúdo selecionado, ele substituirá esse conteú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 é inserir no final do corpo da mensagem.
REPLACE Indica que a ação substitui o corpo da mensagem.

UpdateCcRecipients

Campos
ccRecipients[]

Recipient

UpdateSubject

Campos
subject

string

UpdateToRecipients

Campos
toRecipients[]

Recipient

HostAppActionMarkup

Ações processadas por apps de 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 gerenciadas pelo Drive.

editorAction

EditorClientActionMarkup

Ações gerenciadas pelo Documentos, Planilhas ou Apresentações.

sheetsAction

SheetsClientActionMarkup

Ações gerenciadas pelo Planilhas.

chatAction

ChatClientActionMarkup

Ações processadas pelo Chat.

HostAppDataSourceMarkup

Para um widget SelectionInput que usa um menu de seleção múltipla, uma fonte de dados de um app do Google Workspace. A fonte de dados preenche os itens de seleção do menu de seleção múltipla.

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

Campos
Campo de união data_source. O app Google Workspace que preenche itens para um menu de seleção múltipla. data_source pode ser apenas de um dos tipos a seguir:
chatDataSource

ChatClientDataSourceMarkup

Uma fonte de dados do Google Chat.

SheetsClientActionMarkup

Campos
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 a ser exibida ao usuário se algo deu errado.