Method: accounts.invitations.list

Wyświetla listę oczekujących zaproszeń na określone konto.

Żą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 za pomocą pola Invitation.target_type.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat 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 konto. Liczba zaproszeń wymienionych tutaj 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 sekcji OAuth 2.0 Overview.

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, które typy celów mają się pojawiać w odpowiedzi.
Pole zbiorcze target. Wskazuje cel, do którego odnosi się to zaproszenie. target może mieć tylko jedną z tych wartości:
targetAccount

object (Account)

Słabo wypełnione konto, do którego odnosi się to zaproszenie.
targetLocation

object (TargetLocation)

Lokalizacja docelowa, do której odnosi się to zaproszenie.

TargetLocation

Reprezentuje lokalizację docelową dla oczekującego zaproszenia.

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

string

Nazwa lokalizacji, do której zapraszany jest użytkownik.
address

string

Adres lokalizacji, do której zapraszany jest użytkownik. Nie zawsze wypełnione.
placeId

string

Tylko dane wyjściowe. Identyfikator miejsca lokalizacji, do której zapraszany jest użytkownik. Nie zawsze wypełnione.

TargetType

Typ celu, do którego odnosi się zaproszenie.

Wartości w polu enum
TARGET_TYPE_UNSPECIFIED Ustawione, gdy typ celu nie jest określony.
ACCOUNTS_ONLY Wyświetlaj zaproszenia tylko do celów typu Konto.
LOCATIONS_ONLY Wyświetlaj zaproszenia tylko do celów typu Lokalizacja.