REST Resource: spaces.messages

{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ]
}

string

Nome do recurso no formato spaces/*/messages/*.

Exemplo: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

object (User)

Apenas saída. O usuário que criou a mensagem. Se o app do Chat for autenticado como um usuário, a saída preencherá o name e o type do usuário.

string (Timestamp format)

O horário em que a mensagem foi criada nos espaços criados no Chat. Este campo é apenas para a saída, exceto quando usado em espaços importados.

string (Timestamp format)

Apenas saída. A hora em que a mensagem foi editada pela última vez por um usuário. Se a mensagem nunca tiver sido editada, este campo estará vazio.

string (Timestamp format)

Apenas saída. A hora em que a mensagem foi excluída no Google Chat. Se a mensagem nunca for excluída, esse campo vai ficar vazio.

string

Corpo da mensagem em texto simples. O primeiro link para uma imagem, vídeo ou página da Web gera um ícone de visualização. Você também pode @mencionar um usuário do Google Chat ou todas as pessoas no espaço.

Para saber mais sobre como criar mensagens de texto, consulte Enviar uma mensagem de texto.

string

Apenas saída. Contém a mensagem text com marcações adicionadas para comunicar a formatação. Esse campo pode não capturar toda a formatação visível na IU, mas inclui o seguinte:

• Sintaxe de marcação para blocos de negrito, itálico, tachado, fontes monoespaçadas e monoespaçadas.
• Menções de usuários usando o formato <users/{user}>.
• Hiperlinks personalizados usando o formato <{url}|{rendered_text}>, em que a primeira string é o URL e a segunda é o texto renderizado. Por exemplo, <http://example.com|custom text>.
• Emoji personalizado no formato :{emoji_name}:, por exemplo, :smile:. Isso não se aplica a emojis Unicode, como U+1F600 para emojis de rosto sorridente.

Saiba mais em Visualizar a formatação do texto enviada em uma mensagem.

object (Card)

Obsoleto: use cardsV2.

Cards avançados, formatados e interativos que você pode usar para mostrar elementos da IU, como textos formatados, botões e imagens clicáveis. Os cards geralmente são exibidos abaixo do corpo de texto simples da mensagem. cards e cardsV2 podem ter um tamanho máximo de 32 KB.

object (CardWithId)

Uma matriz de cards.

Somente apps de chat podem criar cards. Quando o app do Chat é autenticado como usuário, as mensagens não podem conter cards.

Para saber mais sobre cards e como criá-los, consulte Criar IUs dinâmicas, interativas e consistentes com cards.

object (Annotation)

Apenas saída. Anotações associadas ao text nesta mensagem.

object (Thread)

A conversa a que a mensagem pertence. Veja exemplos de uso em Iniciar ou responder a uma conversa.

object (Space)

Se o app do Chat for autenticado como um usuário, a saída preencherá o espaço name.

string

Uma descrição em texto simples dos cards da mensagem, usada quando os cards reais não podem ser exibidos. Por exemplo, notificações em dispositivos móveis.

object (ActionResponse)

Apenas entrada. Parâmetros que um app do Chat pode usar para configurar como a resposta é postada.

string

Apenas saída. Corpo da mensagem em texto simples com todas as menções ao app do Chat removidas.

object (SlashCommand)

Apenas saída. Informações do comando de barra, se aplicável

object (Attachment)

Anexo enviado pelo usuário.

object (MatchedUrl)

Apenas saída. Um URL no spaces.messages.text que corresponde a um padrão de visualização de link. Para mais informações, consulte Links de visualização.

boolean

Apenas saída. Quando true, a mensagem é uma resposta em uma conversa. Quando false, a mensagem aparece na conversa de nível superior do espaço como a primeira mensagem de uma conversa ou como uma mensagem sem respostas agrupadas.

Se o espaço não oferecer suporte para a resposta em conversas, este campo será sempre false.

string

Um nome personalizado para uma mensagem do Chat atribuída na criação. Precisa começar com client- e ter apenas letras minúsculas, números e hifens com até 63 caracteres. Especifique este campo para receber, atualizar ou excluir a mensagem com o valor especificado. A atribuição de um nome personalizado permite que um app do Chat recupere a mensagem sem salvar o name do corpo da resposta retornado ao criar a mensagem. A atribuição de um nome personalizado não substitui o campo name gerado, o nome do recurso da mensagem. Em vez disso, ele define o nome personalizado como o campo clientAssignedMessageId, que pode ser referenciado ao processar operações posteriores, como atualizar ou excluir a mensagem. Para exemplo de uso, consulte Nomear uma mensagem criada.

object (EmojiReactionSummary)

Apenas saída. Lista de resumos de reações com emojis na mensagem.

object (DeletionMetadata)

Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando deleteTime é definido.

object (QuotedMessageMetadata)

Apenas saída. Informações sobre uma mensagem citada por um usuário do Google Chat em um espaço. Os usuários do Google Chat podem citar uma mensagem para respondê-la.

object (AttachedGif)

Apenas saída. imagens GIF anexadas à mensagem.

{
  "cardId": string,
  "card": {
    object (Card)
  }
}

string

Obrigatório se a mensagem tiver vários cards. Identificador exclusivo de um cartão em uma mensagem.

object (Card)

Um cartão. O tamanho máximo é 32 KB.

{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  }
  // End of list of possible types for union field metadata.
}

enum (AnnotationType)

O tipo dessa anotação.

integer

Tamanho da substring no corpo da mensagem de texto simples a que esta anotação corresponde.

integer

Índice inicial (baseado em 0, inclusivo) no corpo da mensagem de texto simples a que esta anotação corresponde.

object (UserMentionMetadata)

Os metadados da menção do usuário.

object (SlashCommandMetadata)

Os metadados para um comando de barra.

{
  "user": {
    object (User)
  },
  "type": enum (Type)
}

object (User)

O usuário mencionou.

enum (Type)

O tipo de menção do usuário.

{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}

object (User)

O app do Chat cujo comando foi invocado.

enum (Type)

O tipo de comando de barra.

string

O nome do comando de barra invocado.

string (int64 format)

O ID do comando de barra invocado.

boolean

Indica se o comando de barra é para uma caixa de diálogo.

{
  "name": string,
  "threadKey": string
}

string

Apenas saída. Nome do recurso da linha de execução.

Exemplo: spaces/{space}/threads/{thread}

string

Opcional. Entrada para criar ou atualizar uma linha de execução. Caso contrário, apenas saída. ID da thread. Suporta até 4.000 caracteres.

Esse ID é exclusivo do app do Chat que o define. Por exemplo, se vários apps de chat criarem uma mensagem usando a mesma chave de conversa, as mensagens serão postadas em conversas diferentes. Para responder em uma conversa criada por uma pessoa ou outro app do Chat, especifique o campo name da conversa.

{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  }
}

enum (ResponseType)

Apenas entrada. O tipo de resposta do app do Chat.

string

Apenas entrada. URL para os usuários autenticar ou configurar. (apenas para tipos de resposta REQUEST_CONFIG).

object (DialogAction)

Apenas entrada. Uma resposta a um evento relacionado a uma caixa de diálogo. Precisa estar acompanhado por ResponseType.Dialog.

{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}

object (ActionStatus)

Apenas entrada. Status de uma solicitação para invocar ou enviar uma caixa de diálogo. Exibe um status e uma mensagem para os usuários, se necessário. Por exemplo, em caso de erro ou sucesso.

object (Dialog)

Apenas entrada. Dialog para a solicitação.

{
  "body": {
    object (Card)
  }
}

object (Card)

Apenas entrada. Corpo da caixa de diálogo, que é renderizado em um modal. Os apps do Google Chat não oferecem suporte às seguintes entidades de cartão: DateTimePicker, OnChangeAction.

{
  "statusCode": enum (Code),
  "userFacingMessage": string
}

enum (Code)

O código de status.

string

A mensagem a ser enviada aos usuários sobre o status da solicitação. Se ela não for definida, uma mensagem genérica baseada no statusCode será enviada.

{
  "commandId": string
}

string (int64 format)

O ID do comando de barra invocado.

{
  "url": string
}

string

Apenas saída. O URL correspondente.

{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}

object (Emoji)

Emoji associado às reações.

integer

É o número total de reações que usam o emoji associado.

{
  "deletionType": enum (DeletionType)
}

enum (DeletionType)

Indica quem excluiu a mensagem.

{
  "name": string,
  "lastUpdateTime": string
}

string

Apenas saída. Nome do recurso da mensagem citada.

Formato: spaces/{space}/messages/{message}

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que a mensagem citada foi criada ou foi atualizada pela última vez.

{
  "uri": string
}

string

Apenas saída. O URL que hospeda a imagem GIF.