Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Nesta página, você terá uma visão geral de como usar a API Google Chat e a documentação de referência dela.
A API Google Chat tem interfaces gRPC e REST, além de bibliotecas de cliente que oferecem suporte a ambas. Se as bibliotecas de cliente fornecidas não atenderem às suas necessidades, você poderá escrever suas próprias bibliotecas que usam a interface gRPC ou REST.
Bibliotecas de cliente
A maneira recomendada para a maioria dos desenvolvedores chamar a API Google Chat
é com as bibliotecas de cliente do Cloud
oficialmente compatíveis
para sua linguagem preferida, como Python, Java ou Node.js.
Se você estiver programando com o Google Apps Script, use o
serviço avançado do Chat
em vez de instalar uma biblioteca de cliente.
Tipo, método e nomes de campos
Dependendo de você usar bibliotecas de cliente, gRPC ou REST, o tipo, o método e os nomes dos campos da API Google Chat variam um pouco:
As bibliotecas de cliente do Cloud são organizadas por serviços gRPC e seus métodos.
As bibliotecas de cliente da API do Google são organizadas como serviços que contêm objetos ou classes correspondentes a recursos REST, que também contêm métodos correspondentes.
O gRPC é organizado por serviços e métodos.
O REST é organizado por hierarquias de recursos e seus métodos.
Os nomes dos campos do gRPC usam maiúsculas e minúsculas.
Os nomes dos campos REST usam letras concatenadas, mas o serviço da API aceita maiúsculas e minúsculas.
Os nomes dos campos das bibliotecas de cliente usam maiúsculas ou minúsculas e a concatenação de texto,
dependendo do nome idiomático da linguagem.
buffers de protocolo
Se você estiver usando bibliotecas de cliente, REST ou gRPC, o serviço subjacente será
definido usando buffers de protocolo. Em particular, o serviço usa proto3.
Além disso, ao chamar a API REST, o comportamento do valor padrão para buffers de protocolo pode resultar em campos ausentes em uma resposta JSON. Esses campos são definidos como o valor padrão e, portanto, não são incluídos na resposta.
Versões da API
As seguintes versões de API estão disponíveis:
v1: estável.
Prévia para desenvolvedores
Na documentação, você pode encontrar métodos ou campos da API que só estão disponíveis no Programa de prévia para desenvolvedores. Para testar, visualizar e dar feedback sobre os recursos mais recentes, participe do Programa de prévia para desenvolvedores.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-29 UTC."],[[["\u003cp\u003eThis page offers guidance on utilizing the Google Chat API and navigating its reference documentation, including gRPC and REST interfaces.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers are encouraged to use the provided client libraries for Python, Java, Node.js, or the Advanced Chat service for Google Apps Script.\u003c/p\u003e\n"],["\u003cp\u003eType, method, and field names may vary slightly depending on whether you are using client libraries, gRPC, or REST, with details provided on their respective conventions.\u003c/p\u003e\n"],["\u003cp\u003eThe Google Chat API is built upon protocol buffers, specifically proto3, which may require a basic understanding for certain request and response fields.\u003c/p\u003e\n"],["\u003cp\u003eStable API version v1 is currently available, with access to developer preview features obtainable through the Developer Preview Program.\u003c/p\u003e\n"]]],["The Google Chat API offers gRPC and REST interfaces, with corresponding client libraries or the option to create custom ones. Developers can use Cloud Client Libraries, or the Advanced Chat service with Google Apps Script. Type, method, and field names vary across libraries, gRPC, and REST. The API relies on protocol buffers (proto3), which can impact JSON responses due to default value behavior. The current stable version is v1, with a Developer Preview program for testing new features.\n"],null,["# Google Chat API overview\n\nThis page provides an overview of how to use Google Chat API and its reference\ndocumentation.\n\nGoogle Chat API has both [gRPC](/workspace/chat/api/reference/rpc) and\n[REST](/workspace/chat/api/reference/rest) interfaces, and\n[client libraries](/workspace/chat/libraries) that support both. Optionally, if\nthe provided client libraries don't meet your needs, you can write your own\nclient libraries that use the gRPC or REST interface.\n\nClient libraries\n----------------\n\nThe recommended way for most developers to call the Google Chat API\nis with our officially supported\n[Cloud Client Libraries](/workspace/chat/libraries)\nfor your preferred language, like Python, Java, or Node.js.\n\nIf you're coding with Google Apps Script, use the\n[Advanced Chat service](/apps-script/advanced/chat)\ninstead of installing a client library.\n\nType, method, and field names\n-----------------------------\n\nDepending on whether you're using client libraries, gRPC, or REST, the type,\nmethod, and field names for the Google Chat API vary somewhat:\n\n- Cloud Client Libraries are arranged by gRPC services and their methods. Google API Client Libraries are arranged as services that contain objects or classes that correspond with REST resources, which also contain corresponding methods.\n- gRPC is arranged by services and their methods.\n- REST is arranged by resource hierarchies and their methods.\n- gRPC field names use snake case.\n- REST field names use camel case, though the API service will accept either camel case or snake case.\n- Client library field names use either title case, camel case or snake case, depending on which name is idiomatic for the language.\n\nProtocol buffers\n----------------\n\nWhether you are using client libraries, REST, or gRPC, the underlying service is\ndefined using [protocol buffers](/protocol-buffers). In particular, the service\nuses [proto3](/protocol-buffers/docs/proto3).\n\nWhen calling the API, some request or response fields can require a basic\nunderstanding of\n[protocol buffer well-known types](/protocol-buffers/docs/reference/google.protobuf).\n\nIn addition, when calling the REST API, the\n[default value](/protocol-buffers/docs/proto3#default) behavior for protocol\nbuffers may result in missing fields in a JSON response. These fields are\nset to the default value, so they are not included in the response.\n\nAPI versions\n------------\n\nThe following API versions are available:\n\n- **v1**: Stable.\n\nDeveloper Preview\n-----------------\n\nIn the documentation, you might see API methods or fields that are only\navailable through the Developer Preview Program. To test and preview and offer\nfeedback on the latest preview features, join the\n[Developer Preview Program](/workspace/preview).\n\nRelated topics\n--------------\n\n- [Call the Google Chat API](/workspace/chat/api-overview)"]]