- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Zaproszenie
- TargetLocation
- TargetType
Wyświetla listę oczekujących zaproszeń dla określonego konta.
Żądanie HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
parent |
To pole jest wymagane. Nazwa konta, z którego pobierana jest lista zaproszeń. |
Parametry zapytania
Parametry | |
---|---|
filter |
Opcjonalnie. Filtrowanie odpowiedzi jest obsługiwane w polu Invitation.target_type. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Komunikat z odpowiedzią na AccessControl.ListInvites.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"invitations": [
{
object ( |
Pola | |
---|---|
invitations[] |
Kolekcja oczekujących zaproszeń dla konta. Wymieniona tutaj liczba zaproszeń nie może przekraczać 1000. |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/business.manage
Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.
Zaproszenie
Reprezentuje oczekujące zaproszenie.
Zapis JSON |
---|
{ "name": string, "role": enum ( |
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa zasobu zaproszenia. |
role |
Tylko dane wyjściowe. Zaproszona rola na koncie. |
targetType |
Tylko dane wyjściowe. Określa, które typy celów powinny pojawiać się w odpowiedzi. |
Pole sumy target . Wskazuje cel tego zaproszenia. target może mieć tylko jedną z tych wartości: |
|
targetAccount |
Rzadko zapełnione konto, którego dotyczy to zaproszenie. |
targetLocation |
Lokalizacja docelowa to zaproszenie. |
TargetLocation
Reprezentuje lokalizację docelową dla oczekującego zaproszenia.
Zapis JSON |
---|
{ "locationName": string, "address": string } |
Pola | |
---|---|
locationName |
Nazwa lokalizacji, do której użytkownik został zaproszony. |
address |
Adres lokalizacji, do której użytkownik został zaproszony. |
TargetType
Typ elementu docelowego, dla którego jest przeznaczone zaproszenie.
Wartości w polu enum | |
---|---|
TARGET_TYPE_UNSPECIFIED |
Ustaw, gdy typ wartości docelowej jest nieokreślony. |
ACCOUNTS_ONLY |
Pokaż zaproszenia tylko dla grup docelowych typu Konto. |
LOCATIONS_ONLY |
Wyświetlaj zaproszenia tylko w przypadku grup docelowych typu Lokalizacja. |