Method: contactGroups.update

Mettez à jour le nom d'un groupe de contacts existant appartenant à l'utilisateur authentifié.

Les noms de groupes de contacts mis à jour doivent être uniques pour les groupes de contacts des utilisateurs. Si vous essayez de créer un groupe avec un nom en double, vous obtiendrez une erreur HTTP 409.

Les requêtes de mutation pour un même utilisateur doivent être envoyées de manière séquentielle afin d'éviter une augmentation de la latence et des échecs.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
contactGroup.resourceName

string

Nom de ressource du groupe de contacts, attribué par le serveur. Chaîne ASCII, sous la forme contactGroups/{contactGroupId}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Champs
contactGroup.etag

string

Le tag d'entité HTTP de la ressource. Utilisé pour la validation du cache Web.
contactGroup.metadata

object (ContactGroupMetadata)

Uniquement en sortie. Métadonnées sur le groupe de contacts.
contactGroup.groupType

enum (GroupType)

Uniquement en sortie. Type de groupe de contacts.
contactGroup.name

string

Nom du groupe de contacts défini par le propriétaire du groupe ou nom fourni par le système pour les groupes système.

Pour contactGroups.create ou contactGroups.update, le nom doit être propre aux groupes de contacts des utilisateurs. Si vous essayez de créer un groupe avec un nom en double, vous obtiendrez une erreur HTTP 409.
contactGroup.formattedName

string

Uniquement en sortie. Nom traduit et formaté dans les paramètres régionaux du compte du lecteur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language pour les noms des groupes système. Les noms de groupe définis par le propriétaire sont identiques au nom.
contactGroup.memberResourceNames[]

string

Uniquement en sortie. Liste des noms de ressources des contacts membres du groupe de contacts. Ce champ n'est renseigné que pour les requêtes GET et n'affiche que le nombre de membres maxMembers dans la requête get.
contactGroup.memberCount

integer

Uniquement en sortie. Nombre total de contacts dans le groupe, quel que soit le nombre maximal de membres spécifié dans la demande.
contactGroup.clientData[]

object (GroupClientData)

Données client du groupe.
updateGroupFields

string (FieldMask format)

Facultatif. Masque de champ permettant de limiter les champs du groupe mis à jour. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. La valeur par défaut est name si elle n'est pas configurée ou si elle est vide. Les champs mis à jour sont remplacés. Les valeurs possibles sont les suivantes :

  • clientData
  • name
readGroupFields

string (FieldMask format)

Facultatif. Masque de champ permettant de limiter les champs du groupe renvoyés. Les valeurs par défaut sont metadata, groupType et name si elles ne sont pas définies ou si le champ est vide. Les champs valides sont les suivants:

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

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

Requiert le niveau d'accès OAuth suivant :

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

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