Method: accounts.invitations.list

Zawiera 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

string

Wymagane. Nazwa konta, z którego pobierana jest lista zaproszeń. accounts/{account_id}/invitations

Parametry zapytania

Parametry
filter

string

Opcjonalnie: Filtrowanie odpowiedzi jest obsługiwane w polu Invitation.target_type.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat z odpowiedzią dla AccessControl.ListInvitations.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Pola
invitations[]

object (Invitation)

Zbiór oczekujących zaproszeń na koncie. Podana 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 (AdminRole),
  "targetType": enum (TargetType),

  // Union field target can be only one of the following:
  "targetAccount": {
    object (Account)
  },
  "targetLocation": {
    object (TargetLocation)
  }
  // End of list of possible types for union field target.
}
Pola
name

string

Wymagane. Nazwa zasobu zaproszenia. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Tylko dane wyjściowe. Zaproszona rola na koncie.
targetType

enum (TargetType)

Tylko dane wyjściowe. Określa typy celów, które powinny się pojawić w odpowiedzi.
Pole sumy target. Wskazuje cel, do którego jest przeznaczone to zaproszenie. target może mieć tylko jedną z tych wartości:
targetAccount

object (Account)

Mało zapełnione konto, którego dotyczy to zaproszenie.
targetLocation

object (TargetLocation)

Lokalizacja docelowa, do której jest przeznaczone to zaproszenie.

TargetLocation

Reprezentuje lokalizację docelową dla oczekującego zaproszenia.

Zapis JSON 
{
  "locationName": string,
  "address": string
}
Pola
locationName

string

Nazwa lokalizacji, do której użytkownik został zaproszony.
address

string

Adres lokalizacji, do której użytkownik został zaproszony.

TargetType

Typ elementu docelowego, do którego jest kierowane zaproszenie.

Wartości w polu enum
TARGET_TYPE_UNSPECIFIED Ustaw, gdy typ celu nie jest określony.
ACCOUNTS_ONLY Wyświetlaj zaproszenia tylko do grup docelowych typu Konto.
LOCATIONS_ONLY Wyświetlaj zaproszenia tylko w przypadku elementów docelowych typu Lokalizacja.