Method: accounts.invitations.list

Listet ausstehende Einladungen für das angegebene Konto auf.

HTTP-Anfrage

GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name des Kontos, aus dem die Liste der Einladungen abgerufen wird. accounts/{account_id}/invitations

Suchparameter

Parameter
filter

string

Optional. Die Antwort kann über das Feld „Invitation.target_type“ gefiltert werden.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für AccessControl.ListInvitations.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Felder
invitations[]

object (Invitation)

Eine Sammlung von Einladungen, die für das Konto ausstehen. Die Anzahl der hier aufgeführten Einladungen darf 1.000 nicht überschreiten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

Einladung

Stellt eine ausstehende Einladung dar.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Erforderlich. Der Ressourcenname für die Einladung. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Nur Ausgabe. Die eingeladene Rolle im Konto.
targetType

enum (TargetType)

Nur Ausgabe. Gibt an, welche Zieltypen in der Antwort angezeigt werden sollen.
Union-Feld target. Gibt das Ziel an, für das diese Einladung gilt. Für target ist nur einer der folgenden Werte zulässig:
targetAccount

object (Account)

Das spärlich gefüllte Konto, für das diese Einladung gilt.
targetLocation

object (TargetLocation)

Der Zielstandort, für den diese Einladung gilt.

TargetLocation

Stellt einen Zielstandort für eine ausstehende Einladung dar.

JSON-Darstellung 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
Felder
locationName

string

Der Name des Standorts, zu dem der Nutzer eingeladen wird.
address

string

Die Adresse des Standorts, zu dem der Nutzer eingeladen wird. Nicht immer ausgefüllt.
placeId

string

Nur Ausgabe. Die Orts-ID des Standorts, zu dem der Nutzer eingeladen wird. Nicht immer ausgefüllt.

TargetType

Der Zieltyp, für den eine Einladung gilt.

Enums
TARGET_TYPE_UNSPECIFIED Wird festgelegt, wenn der Zieltyp nicht angegeben ist.
ACCOUNTS_ONLY Listet nur Einladungen für Ziele vom Typ „Konto“ auf.
LOCATIONS_ONLY Listet nur Einladungen für Ziele vom Typ „Standort“ auf.