Visão geral da API Google Chat

Esta página fornece uma visão geral de como usar a API Google Chat e a referência dela na documentação do Google Cloud.

A API Google Chat tem gRPC e REST (links em inglês) e bibliotecas de cliente compatíveis com ambos. Opcionalmente, se as bibliotecas de cliente fornecidas não atenderem às suas necessidades, crie seu próprio bibliotecas de cliente que usam a interface gRPC ou REST.

Bibliotecas de cliente

A maneira recomendada para a maioria dos desenvolvedores chamar a API Google Chat é com nossa plataforma Bibliotecas de cliente do Cloud para sua linguagem preferida, como Python, Java ou Node.js.

Se você estiver codificando com o Google Apps Script, use a Serviço avançado do Chat em vez de instalar uma biblioteca de cliente.

Tipo, método e nomes de campos

Dependendo do tipo de biblioteca que você usa, gRPC ou REST, e nomes de campos da API Google Chat variam um pouco:

  • As bibliotecas de cliente do Cloud são organizadas pelos serviços gRPC e seus métodos. As bibliotecas de cliente das APIs do Google são organizadas como serviços que contêm objetos ou que correspondem aos recursos REST, que também contêm métodos.
  • O gRPC é organizado por serviços e seus métodos.
  • O REST é organizado por hierarquias de recursos e seus métodos.
  • Os nomes de campo do gRPC usam snake-case.
  • Os nomes dos campos REST usam letras concatenadas, embora o serviço da API aceite letras concatenadas ou snake-case.
  • Os nomes de campo da biblioteca de cliente usam letras maiúsculas e minúsculas de título, CamelCase ou Snake Case, dependendo do nome idiomático do idioma.

buffers de protocolo

Não importa se você usa bibliotecas de cliente, REST ou gRPC, o serviço subjacente definidos por buffers de protocolo. Especificamente, o serviço usa o proto3.

Ao chamar a API, alguns campos de solicitação ou resposta podem exigir uma compreensão de tipos conhecidos de buffer de protocolo.

Além disso, ao chamar a API REST, valor padrão do protocolo buffers podem resultar em campos ausentes em uma resposta JSON. Esses campos são definido como o valor padrão, portanto, não são incluídos na resposta.

Versões da API

As seguintes versões da API estão disponíveis:

  • v1: estável.

Prévia para desenvolvedores

Na documentação, você pode ver métodos ou campos da API que são apenas disponível no Programa de prévia para desenvolvedores. Para testar, visualizar e oferecer feedback sobre os recursos em fase de pré-lançamento mais recentes, participe do Programa de prévia para desenvolvedores.