Method: accounts.invitations.list

Répertorie les invitations en attente pour le compte spécifié.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom du compte à partir duquel la liste d'invitations est extraite. accounts/{account_id}/invitations

Paramètres de requête

Paramètres
filter

string

Facultatif. Le filtrage de la réponse est possible via le champ Invitation.target_type.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour AccessControl.ListInvitations.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Champs
invitations[]

object (Invitation)

Ensemble d'invitations en attente pour le compte. Le nombre d'invitations répertoriées ici ne peut pas dépasser 1 000.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Invitation

Représente une invitation en attente.

Représentation 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.
}
Champs
name

string

Obligatoire. Nom de ressource de l'invitation. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Uniquement en sortie. Rôle invité sur le compte.
targetType

enum (TargetType)

Uniquement en sortie. Spécifie les types de cibles à afficher dans la réponse.
Champ d'union target. Indique la cible de cette invitation. target ne peut être qu'un des éléments suivants :
targetAccount

object (Account)

Compte partiellement rempli auquel cette invitation est destinée.
targetLocation

object (TargetLocation)

Emplacement cible auquel cette invitation est destinée.

TargetLocation

Représente une zone géographique cible pour une invitation en attente.

Représentation JSON 
{
  "locationName": string,
  "address": string
}
Champs
locationName

string

Nom de l'établissement auquel l'utilisateur est invité.
address

string

Adresse de l'établissement auquel l'utilisateur est invité.

TargetType

Type de cible auquel une invitation est destinée.

Enums
TARGET_TYPE_UNSPECIFIED Défini lorsque le type de cible n'est pas spécifié.
ACCOUNTS_ONLY Afficher les invitations uniquement pour les cibles de type Compte.
LOCATIONS_ONLY Afficher les invitations uniquement pour les cibles de type "Zone géographique".