Method: contactGroups.get

Obtenez un groupe de contacts spécifique appartenant à l'utilisateur authentifié en spécifiant un nom de ressource de groupe de contacts.

Requête HTTP

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
resourceName

string

Obligatoire. Nom de ressource du groupe de contacts à obtenir.

Paramètres de requête

Paramètres
maxMembers

integer

Facultatif. Spécifie le nombre maximal de membres à renvoyer. Si ce champ n'est pas spécifié, la valeur par défaut est 0, ce qui renvoie zéro membre.
groupFields

string (FieldMask format)

Facultatif. Masque de champ permettant de limiter les champs du groupe renvoyés. Si aucune valeur n'est définie ou si le champ est vide, les valeurs par défaut sont metadata, groupType, memberCount et name. Les champs valides sont les suivants:

  • clientData
  • groupType
  • memberCount
  • métadonnées
  • name

Corps de la requête

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ContactGroup.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

Pour en savoir plus, consultez le guide relatif aux autorisations.