Method: contactGroups.list

Répertorier tous les groupes de contacts appartenant à l'utilisateur authentifié. Les membres des groupes de contacts ne sont pas renseignés.

Requête HTTP

GET https://people.googleapis.com/v1/contactGroups

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageToken

string

Facultatif. La valeur nextPageToken renvoyée par un appel précédent à contactGroups.list. Demande la page de ressources suivante.
pageSize

integer

Facultatif. Nombre maximal de ressources à renvoyer. Les valeurs valides sont comprises entre 1 et 1 000 inclus. La valeur par défaut est 30 s'il n'est pas défini ou s'il est défini sur 0.
syncToken

string

Facultatif. Un jeton de synchronisation, renvoyé par un appel précédent à contactgroups.list. Seules les ressources modifiées depuis la création du jeton de synchronisation seront renvoyées.
groupFields

string (FieldMask format)

Facultatif. Masque de champ permettant de limiter les champs du groupe qui sont renvoyés. La valeur par défaut est metadata, groupType, memberCount et name s'il n'est pas défini ou s'il est vide. Les champs valides sont les suivants:

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

Corps de la requête

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

Corps de la réponse

Réponse à une requête listant les groupes de contacts.

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

Représentation JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Champs
contactGroups[]

object (ContactGroup)

Liste des groupes de contacts. Les membres des groupes de contacts ne sont pas renseignés.
totalItems

integer

Nombre total d'éléments dans la liste sans pagination.
nextPageToken

string

Jeton pouvant être utilisé pour récupérer la page de résultats suivante.
nextSyncToken

string

Jeton pouvant être utilisé pour récupérer les modifications depuis la dernière requête.

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.