Zasób: subskrypcja
Zapis JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Pola | |
---|---|
name |
Opcjonalnie. Stałe. Identyfikator. Nazwa zasobu subskrypcji. Format: |
uid |
Tylko dane wyjściowe. Przypisany przez system unikalny identyfikator subskrypcji. |
targetResource |
To pole jest wymagane. Stałe. Zasób Google Workspace monitorowany pod kątem zdarzeń w postaci pełnej nazwy zasobu. Więcej informacji o zasobach docelowych i obsługiwanych przez nie zdarzeniach znajdziesz w artykule Obsługiwane zdarzenia Google Workspace. Użytkownik może autoryzować Twoją aplikację do utworzenia tylko jednej subskrypcji dla danego zasobu docelowego. Jeśli aplikacja spróbuje utworzyć kolejną subskrypcję z tymi samymi danymi logowania użytkownika, żądanie zwróci błąd |
eventTypes[] |
To pole jest wymagane. Stałe. Lista nieuporządkowana. Pole do tworzenia subskrypcji. W przeciwnym razie tylko dane wyjściowe. Co najmniej 1 typ zdarzeń do otrzymywania dotyczących zasobu docelowego. Sformatowane zgodnie ze specyfikacją CloudEvents. Obsługiwane typy zdarzeń zależą od zasobu docelowego Twojej subskrypcji. Więcej informacji znajdziesz w artykule Obsługiwane zdarzenia Google Workspace. Domyślnie otrzymujesz też informacje o zdarzeniach związanych z cyklem życia subskrypcji. Nie musisz określać w tym polu zdarzeń cyklu życia. Jeśli określisz typ zdarzenia, który nie istnieje dla zasobu docelowego, żądanie zwróci kod stanu HTTP |
payloadOptions |
Opcjonalnie. Opcje dotyczące danych do uwzględnienia w ładunku zdarzenia. Obsługiwane tylko w przypadku wydarzeń w Google Chat. |
notificationEndpoint |
To pole jest wymagane. Stałe. Punkt końcowy, w którym subskrypcja dostarcza zdarzenia, takie jak temat Pub/Sub. |
state |
Tylko dane wyjściowe. Stan subskrypcji. Określa, czy subskrypcja może odbierać zdarzenia i dostarczać je do punktu końcowego powiadomień. |
suspensionReason |
Tylko dane wyjściowe. Błąd powodujący zawieszenie subskrypcji. Aby ponownie aktywować subskrypcję, rozwiąż błąd i wywołaj metodę |
authority |
Tylko dane wyjściowe. Użytkownik, który autoryzował utworzenie subskrypcji. Format: W przypadku użytkowników Google Workspace wartość |
createTime |
Tylko dane wyjściowe. Godzina utworzenia subskrypcji. |
updateTime |
Tylko dane wyjściowe. Data ostatniej aktualizacji subskrypcji. |
reconciling |
Tylko dane wyjściowe. Jeśli |
etag |
Opcjonalnie. Ta suma kontrolna jest obliczana przez serwer na podstawie wartości innych pól i może być wysyłana przy żądaniach aktualizacji w celu sprawdzenia, czy klient ma aktualną wartość, zanim przejdziesz dalej. |
Pole sumy Maksymalny czas wygaśnięcia zależy od tego, czy subskrypcja uwzględnia w ładunkach zdarzeń dane zasobów (określone w polu
Po wygaśnięciu subskrypcji jest ona automatycznie usuwana. Zdarzenia cyklu życia są wysyłane do Aby zapobiec wygaśnięciu subskrypcji, możesz przedłużyć jej datę ważności przy użyciu metody |
|
expireTime |
Wartość domyślna nie jest pusta. Sygnatura czasowa wygaśnięcia subskrypcji w strefie czasowej UTC. Zawsze wyświetlane na wyjściu, niezależnie od tego, jakie dane zostały użyte. |
ttl |
Tylko wejście. Czas życia danych (TTL) lub czas trwania subskrypcji. Jeśli wartość nie jest określona lub ustawiona na |
PayloadOptions
Opcje dotyczące danych do uwzględnienia w ładunku zdarzenia. Obsługiwane tylko w przypadku wydarzeń w Google Chat.
Zapis JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
Pola | |
---|---|
includeResource |
Opcjonalnie. Określa, czy ładunek zdarzenia zawiera dane o zmienionym zasobie. Na przykład w przypadku zdarzenia, w którym została utworzona wiadomość w Google Chat, sprawdź, czy ładunek zawiera dane o zasobie |
fieldMask |
Opcjonalnie. Jeśli Jeśli określisz pole, które nie istnieje dla tego zasobu, system zignoruje to pole. |
NotificationEndpoint
Punkt końcowy, w którym subskrypcja dostarcza zdarzenia.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
pubsubTopic |
Stałe. Temat Cloud Pub/Sub, do którego wysyłane są zdarzenia subskrypcji. Format: Temat musisz utworzyć w tym samym projekcie Google Cloud, w którym tworzysz tę subskrypcję. Gdy temat odbiera zdarzenia, są one kodowane jako wiadomości Cloud Pub/Sub. Szczegółowe informacje znajdziesz w artykule Powiązanie protokołu Google Cloud Pub/Sub dla CloudEvents. |
Stan
Możliwe stany subskrypcji.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Wartość domyślna. Ta wartość nie jest używana. |
ACTIVE |
Subskrypcja jest aktywna i może odbierać oraz dostarczać zdarzenia do swojego punktu końcowego powiadomień. |
SUSPENDED |
Subskrypcja nie może odbierać zdarzeń z powodu błędu. Aby zidentyfikować błąd, zapoznaj się z polem . |
DELETED |
Subskrypcja została usunięta. |
ErrorType
Możliwe błędy dotyczące subskrypcji.
Wartości w polu enum | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Wartość domyślna. Ta wartość nie jest używana. |
USER_SCOPE_REVOKED |
Autoryzowany użytkownik anulował przypisanie co najmniej 1 zakresu OAuth. Więcej informacji o autoryzacji w Google Workspace znajdziesz w artykule Konfigurowanie ekranu zgody OAuth. |
RESOURCE_DELETED |
Docelowy zasób subskrypcji już nie istnieje. |
USER_AUTHORIZATION_FAILURE |
Użytkownik, który autoryzował utworzenie subskrypcji, nie ma już dostępu do jej docelowego zasobu. |
ENDPOINT_PERMISSION_DENIED |
Aplikacja Google Workspace nie ma dostępu do dostarczania zdarzeń do punktu końcowego powiadomień subskrypcji. |
ENDPOINT_NOT_FOUND |
Punkt końcowy powiadomień subskrypcji nie istnieje lub nie można go znaleźć w projekcie Google Cloud, w którym subskrypcja została utworzona. |
ENDPOINT_RESOURCE_EXHAUSTED |
W punkcie końcowym powiadomienia subskrypcji nie odebrano zdarzeń z powodu niewystarczającego limitu lub osiągnięcia ograniczenia liczby żądań. |
OTHER |
Wystąpił niezidentyfikowany błąd. |
Metody |
|
---|---|
|
Tworzy subskrypcję Google Workspace. |
|
Usuwa subskrypcję Google Workspace. |
|
Pobiera szczegółowe informacje o subskrypcji Google Workspace. |
|
Wyświetla listę subskrypcji Google Workspace. |
|
aktualizuje lub odnawia subskrypcję Google Workspace; |
|
Ponowne aktywowanie zawieszonego abonamentu Google Workspace. |