Method: spaces.messagePins.list

Lista as mensagens fixadas em um espaço. Os usuários podem fixar mensagens importantes nos espaços para facilitar o acesso. Para mais informações, consulte Fixar ou remover uma conversa no Google Chat.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

Solicitação HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messagePins

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O espaço pai que tem a coleção de itens fixados. Formato: spaces/{space}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de fixações de mensagens retornadas. O serviço pode retornar menos mensagens do que esse valor. O valor máximo é 100. Se você usar um valor maior que 100, ele será mudado automaticamente para 100. Se não for especificado, no máximo 100 mensagens fixadas serão retornadas. Valores negativos retornam um erro INVALID_ARGUMENT.

pageToken

string

Opcional. Um token de página recebido de uma chamada anterior para listar fixações de mensagens. Forneça esse parâmetro para recuperar a página seguinte.

Na paginação, todos os outros parâmetros fornecidos precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para listar fixações de mensagens.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
Campos
messagePins[]

object (MessagePin)

As mensagens fixadas do espaço especificado.

nextPageToken

string

É possível enviar um token como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

Para mais informações, consulte o guia de autorização.