Method: contactGroups.batchGet

Obtenez la liste des groupes de contacts appartenant à l'utilisateur authentifié en spécifiant une liste de noms de ressources de groupe de contacts.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
resourceNames[]

string

Obligatoire. Noms de ressources des groupes de contacts à obtenir.

Le nombre de noms de ressources est limité à 200.
maxMembers

integer

Facultatif. Spécifie le nombre maximal de membres à renvoyer pour chaque groupe. 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

Réponse à une requête de groupes de contacts get par lot.

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

Représentation JSON 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
Champs
responses[]

object (ContactGroupResponse)

Liste des réponses pour chaque ressource de groupe de contacts demandée.

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.

ContactGroupResponse

Réponse pour un groupe de contacts spécifique.

Représentation JSON 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
Champs
requestedResourceName

string

Nom de la ressource d'origine demandé.
status

object (Status)

État de la réponse.
contactGroup

object (ContactGroup)

Groupe de contacts.