Na tej stronie znajdziesz omówienie korzystania z interfejsu Google Chat API i jego dokumentacji.
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 programistów jest korzystanie z oficjalnie obsługiwanych bibliotek klienta Cloud w preferowanym języku, np. Python, Java lub Node.js.
Jeśli kodujesz w Google Apps Script, zamiast instalować bibliotekę klienta, użyj usługi Zaawansowany Chat.
Nazwy typów, metod i pól
W zależności od tego, czy używasz bibliotek klienta, gRPC czy REST, nazwy typów, metod i pól w interfejsie Google Chat API nieco się różnią:
- 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, które zawierają obiekty lub klasy odpowiadające zasobom REST, a także odpowiadające im 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 są zapisywane w formacie camel case, ale usługa API akceptuje zarówno format camel case, jak i snake case.
- Nazwy pól biblioteki klienta są zapisywane w formacie title case, camel case lub snake case, w zależności od tego, który format jest idiomatyczny dla danego języka.
Bufory protokołu
Niezależnie od tego, czy używasz bibliotek klienta, REST czy gRPC, usługa bazowa jest definiowana 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 buforów protokołu.
Ponadto podczas wywoływania interfejsu REST API domyślne zachowanie wartości buforów protokołu może powodować brak niektórych pól w odpowiedzi JSON. Te pola są ustawione na wartość domyślną, dlatego 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 wersji przedpremierowej dla programistów. Aby testować i sprawdzać najnowsze funkcje w wersji przedpremierowej oraz przesyłać opinie na ich temat, dołącz do programu wersji przedpremierowej dla programistów.