Omówienie interfejsu Google Chat API

Na tej stronie znajdziesz informacje o korzystaniu z interfejsu Google Chat API i jego dokumentację dokumentacji.

Interfejs Google Chat API zawiera zarówno gRPC, jak i interfejsy REST, biblioteki klienta, które obsługują oba te typy; Opcjonalnie, jeśli podane biblioteki klienta nie spełniają Twoich wymagań, możesz napisać własne bibliotek klienta korzystających z interfejsu gRPC lub REST.

Biblioteki klienta

Zalecany sposób wywoływania interfejsu Google Chat API przez większość deweloperów jest oficjalnie obsługiwany Biblioteki klienta Cloud na wybrany język, np. Pythona, Java czy Node.js.

Jeśli programujesz za pomocą Google Apps Script, użyj Zaawansowana usługa czatu zamiast instalować bibliotekę klienta.

Nazwy typów, metod i pól

W zależności od tego, czy używasz bibliotek klienta, gRPC czy REST, typ metody i nazwy pól interfejsu Google Chat API różnią się nieco:

  • Biblioteki klienta Cloud są uporządkowane według usług gRPC i ich metod. Biblioteki klienta interfejsów API Google są uporządkowane jako usługi zawierające obiekty lub klasach odpowiadających zasobom REST, które również zawierają odpowiednie .
  • Protokół gRPC jest podzielony według usług i ich metod.
  • Protokół REST jest uporządkowany według hierarchii zasobów i ich metod.
  • W nazwach pól gRPC jest stosowane wielkość liter jak wąż.
  • W nazwach pól REST jest używana wielkość liter wielbłąda, jednak usługa API akceptuje wielbłąda czy węża.
  • Nazwy pól biblioteki klienta mogą zawierać takie same litery jak w nazwie, wielka litera lub wąż, w zależności od tego, która nazwa jest idiomatyczna dla danego języka.

Bufory protokołu

Niezależnie od tego, czy używasz bibliotek klienta, REST czy gRPC, usługa podstawowa zdefiniowane za pomocą buforów protokołów. Przede wszystkim usługa korzysta z proto3.

Podczas wywoływania interfejsu API niektóre pola żądania lub odpowiedzi mogą wymagać zrozumienia dobrze znane typy bufora protokołów.

Dodatkowo przy wywoływaniu interfejsu API REST zachowanie wartości domyślnej protokołu bufory mogą spowodować, że w odpowiedzi JSON brakuje pól. Te pola to są ustawione na wartość domyślną, więc nie zostaną uwzględnione w odpowiedzi.

Wersje interfejsu API

Dostępne są te wersje interfejsu API:

  • v1: stabilny.

wersja przedpremierowa dla programistów

W dokumentacji możesz zobaczyć metody lub pola interfejsu API, które są tylko dostępne w ramach Programu podglądu dla programistów. Aby przetestować, wyświetlić podgląd i udostępnić opinii na temat najnowszych funkcji w wersji testowej, dołącz do Program podglądu dla programistów.