Omówienie interfejsu Google Chat API

Na tej stronie znajdziesz omówienie korzystania z Google Chat API i jego dokumentacji referencyjnej.

Interfejs Google Chat API obsługuje interfejsy gRPC i REST oraz biblioteki klienta, które obsługują oba te interfejsy. Jeśli udostępnione biblioteki klienta nie spełniają Twoich wymagań, możesz napisać własne biblioteki klienta, które korzystają z interfejsu gRPC lub REST.

Biblioteki klienta

Zalecany sposób wywoływania interfejsu Google Chat API przez większość deweloperów to użycie oficjalnie obsługiwanych bibliotek klienta Cloud w wybranym języku, np. Python, Java lub Node.js.

Jeśli kodujesz za pomocą Google Apps Script, zamiast instalować bibliotekę klienta, użyj usługi Google Chat zaawansowanej.

Nazwy typu, metody i polów

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

  • Biblioteki klienta w chmurze są uporządkowane według usług gRPC i ich metod. Biblioteki klienta interfejsu API Google są zorganizowane jako usługi zawierające obiekty lub klasy odpowiadające zasobom REST, które również zawierają odpowiednie metody.
  • gRPC jest uporządkowany według usług i ich metod.
  • Interfejs REST jest uporządkowany według hierarchii zasobów i ich metod.
  • Nazwy pól gRPC są zapisane w odwróconej kolejności.
  • Nazwy pól REST są zapisane w sposób „wielkie litery w środku wyrazu”, ale usługa interfejsu API akceptuje zarówno tę metodę, jak i „małe litery w środku wyrazu”.
  • Nazwy pól w bibliotece klienta są zapisywane WIELKIMI LITERAMI, WIELKIMI LITERAMI Z MAŁYMI LITERAMI lub MAŁYMI LITERAMI Z WIELKIMI LITERAMI w zależności od tego, która nazwa jest idiomatyczna w danym języku.

Bufory protokołu

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

Podczas wywoływania interfejsu API niektóre pola żądania lub odpowiedzi mogą wymagać podstawowej znajomości typów znanych w buforze protokołu.

Ponadto podczas wywoływania interfejsu REST API wartość domyślna dla buforów protokołów może spowodować brak pól w odpowiedzi JSON. Te pola mają wartość domyślną, więc nie są uwzględniane w odpowiedzi.

Wersje interfejsu API

Dostępne są te wersje interfejsu API:

  • v1: stabilna.

wersja przedpremierowa dla programistów

W dokumentacji możesz zobaczyć metody lub pola interfejsu API, które są dostępne tylko w ramach programu podglądu dla deweloperów. Aby przetestować i przejrzeć najnowsze funkcje wersji próbnej oraz podzielić się opinią na ich temat, dołącz do Programu testowania wersji dla programistów.