- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
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 |
Nom de ressource du groupe de contacts, attribué par le serveur. Chaîne ASCII, sous la forme |
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 ( |
Champs | |
---|---|
contactGroup.etag |
Le tag d'entité HTTP de la ressource. Utilisé pour la validation du cache Web. |
contactGroup.metadata |
Uniquement en sortie. Métadonnées sur le groupe de contacts. |
contactGroup.groupType |
Uniquement en sortie. Type de groupe de contacts. |
contactGroup.name |
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 |
contactGroup.formattedName |
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 |
contactGroup.memberResourceNames[] |
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 |
contactGroup.memberCount |
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[] |
Données client du groupe. |
updateGroupFields |
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
|
readGroupFields |
Facultatif. Masque de champ permettant de limiter les champs du groupe renvoyés. Les valeurs par défaut sont
|
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.