- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Invitation
- TargetLocation
- TargetType
Liste 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 |
Obligatoire. Nom du compte à partir duquel la liste des invitations est récupérée. |
Paramètres de requête
Paramètres | |
---|---|
filter |
Facultatif. Vous pouvez filtrer la réponse à l'aide du 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 ( |
Champs | |
---|---|
invitations[] |
Ensemble d'invitations en attente pour le compte. Le nombre d'invitations indiqué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 ( |
Champs | |
---|---|
name |
Obligatoire. Nom de ressource de l'invitation. |
role |
Uniquement en sortie. Rôle invité pour le compte. |
targetType |
Uniquement en sortie. Spécifie les types de cibles devant apparaître dans la réponse. |
Champ d'union target . Indique la cible pour laquelle cette invitation est destinée. target ne peut être qu'un des éléments suivants : |
|
targetAccount |
Compte faiblement renseigné auquel cette invitation est destinée. |
targetLocation |
Zone géographique cible pour laquelle cette invitation est destinée. |
TargetLocation
Représente un emplacement cible pour une invitation en attente.
Représentation JSON |
---|
{ "locationName": string, "address": string } |
Champs | |
---|---|
locationName |
Nom de l'établissement auquel l'utilisateur est invité. |
address |
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 |
Répertorier les invitations uniquement pour les cibles de type Account. |
LOCATIONS_ONLY |
Répertorier les invitations uniquement pour les cibles de type Lieu |