Method: contactGroups.update

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

Les noms des groupes de contacts mis à jour doivent être uniques 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.

Les requêtes de mutation pour le même utilisateur doivent être envoyées de manière séquentielle pour éviter une latence accrue 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, au format 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

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 unique 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é selon les paramètres régionaux du compte de l'utilisateur ou les paramètres régionaux de l'en-tête HTTP Accept-Language pour les noms de 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 de contacts membres du groupe de contacts. Le champ n'est renseigné que pour les requêtes GET et renvoie seulement maxMembers de membres 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 requête.
contactGroup.clientData[]

object (GroupClientData)

Les données client du groupe.
updateGroupFields

string (FieldMask format)

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

  • clientData
  • nom
readGroupFields

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 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 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.