Na tej stronie znajdziesz omówienie interfejsu Google Chat API i jego dokumentacji referencyjnej.
Interfejs Google Chat API ma interfejsy gRPC i REST oraz biblioteki klienta, które obsługują oba te interfejsy. Opcjonalnie, jeśli udostępnione biblioteki klienta nie spełniają Twoich potrzeb, możesz napisać własne biblioteki klienta, które korzystają z interfejsu gRPC lub REST.
Biblioteki klienta
Zalecanym sposobem wywoływania interfejsu Google Chat API dla większości deweloperów jest korzystanie z naszych oficjalnie obsługiwanych bibliotek klienta Cloud w wybranym języku, np. Python, Java lub Node.js.
Jeśli piszesz kod w Google Apps Script, użyj zaawansowanej usługi Chat zamiast instalować bibliotekę klienta.
Typ, metoda i nazwy pól
W zależności od tego, czy używasz bibliotek klienta, gRPC czy REST, typ, metoda 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 interfejsu API Google są uporządkowane 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.
- REST jest uporządkowany według hierarchii zasobów i ich metod.
- Nazwy pól gRPC są zapisywane w formacie snake case.
- Nazwy pól REST używają notacji camel case, ale usługa API akceptuje zarówno notację camel case, jak i snake case.
- Nazwy pól biblioteki klienta są zapisywane w formacie Jak nazwy własne, camel case lub snake case, w zależności od tego, który z nich jest typowy dla danego języka.
Bufory protokołu
Niezależnie od tego, czy używasz bibliotek klienta, REST czy gRPC, podstawowa usługa jest zdefiniowana za pomocą buforów protokołu. Usługa korzysta w szczególności z proto3.
Podczas wywoływania interfejsu API niektóre pola żądania lub odpowiedzi mogą wymagać podstawowej znajomości dobrze znanych typów bufora protokołu.
Dodatkowo podczas wywoływania interfejsu REST API wartość domyślna buforów protokołu może powodować brakujące pola 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 Developer Preview. Aby testować najnowsze funkcje w wersji przedpremierowej, wyświetlać ich podgląd i przesyłać na ich temat opinie, dołącz do Programu testowania wersji przedpremierowych dla programistów.