Cette page explique comment utiliser l'API Google Chat et sa documentation de référence.
L'API Google Chat possède des interfaces gRPC et REST, ainsi que des bibliothèques clientes qui les prennent en charge toutes les deux. Si les bibliothèques clientes fournies ne répondent pas à vos besoins, vous pouvez également écrire vos propres bibliothèques clientes qui utilisent l'interface gRPC ou REST.
Bibliothèques clientes
Pour la plupart des développeurs, la méthode recommandée pour appeler l'API Google Chat consiste à utiliser nos bibliothèques clientes Cloud officiellement compatibles avec le langage de votre choix, comme Python, Java ou Node.js.
Si vous codez avec Google Apps Script, utilisez le service Chat avancé au lieu d'installer une bibliothèque cliente.
Noms de type, de méthode et de champs
Selon que vous utilisez des bibliothèques clientes, gRPC ou REST, les noms de type, de méthode et de champ de l'API Google Chat varient légèrement :
- Les bibliothèques clientes Cloud sont organisées par services gRPC et par leurs méthodes. Les bibliothèques clientes de l'API Google sont organisées en tant que services contenant des objets ou des classes qui correspondent à des ressources REST, qui contiennent également des méthodes correspondantes.
- gRPC est organisé par services et par leurs méthodes.
- L'architecture REST est organisée par hiérarchies de ressources et leurs méthodes.
- Les noms de champs gRPC utilisent snake case.
- Les noms de champs REST utilisent la convention typographique camel case, mais le service d'API accepte aussi bien camel case que snake case.
- Les noms de champs de la bibliothèque cliente utilisent soit la casse du titre, soit camel case ou snake case, selon le caractère idiomatique du nom dans le langage concerné.
Protocol Buffers
Que vous utilisiez des bibliothèques clientes, REST ou gRPC, le service sous-jacent est défini à l'aide de Protocol Buffers. En particulier, le service utilise proto3.
Lorsque vous appelez l'API, certains champs de requête ou de réponse peuvent nécessiter une compréhension de base des types connus de Protocol Buffers.
De plus, lorsque vous appelez l'API REST, le comportement de la valeur par défaut pour les Protocol Buffers peut entraîner l'absence de champs dans une réponse JSON. Ces champs sont définis sur la valeur par défaut et ne sont donc pas inclus dans la réponse.
Versions d'API
Les versions d'API suivantes sont disponibles :
- v1: stable.
Version Preview développeur
Dans la documentation, vous pouvez voir des méthodes ou des champs d'API qui ne sont disponibles que via le programme Preview développeur. Pour tester et prévisualiser les dernières fonctionnalités en preview et nous faire part de vos commentaires, rejoignez le programme Preview développeur.