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

Abfrageparameter

Parameter
filter

string

Optional. Das Filtern der Antwort wird über das Feld „Invitation.target_type“ unterstützt.

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 ausstehender Einladungen für das Konto. 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 in der Übersicht über OAuth 2.0.

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 für das 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 dünnbesetzte Konto, für das diese Einladung bestimmt ist.
targetLocation

object (TargetLocation)

Die Zielregion, für die diese Einladung gilt.

TargetLocation

Stellt einen Zielort für eine ausstehende Einladung dar.

JSON-Darstellung 
{
  "locationName": string,
  "address": 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.

TargetType

Die Art des Ziels, für das eine Einladung gilt.

Enums
TARGET_TYPE_UNSPECIFIED Wird festgelegt, wenn der Zieltyp nicht angegeben ist.
ACCOUNTS_ONLY Listen Sie nur Einladungen für Ziele des Typs "Konto" auf.
LOCATIONS_ONLY Einladungen nur für Ziele des Typs „Standort“ auflisten.