- Ressource: ContactGroup
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ContactGroupMetadata
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- GroupType
- GroupClientData
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Méthodes
Ressource: ContactGroup
Un groupe de contacts.
Représentation JSON |
---|
{ "resourceName": string, "etag": string, "metadata": { object ( |
Champs | |
---|---|
resourceName |
Nom de ressource du groupe de contacts, attribué par le serveur. Chaîne ASCII, au format |
etag |
Tag d'entité HTTP de la ressource. Utilisé pour la validation du cache Web. |
metadata |
Uniquement en sortie. Métadonnées sur le groupe de contacts. |
groupType |
Uniquement en sortie. Type de groupe de contacts. |
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 |
formattedName |
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 |
memberResourceNames[] |
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 |
memberCount |
Uniquement en sortie. Nombre total de contacts dans le groupe, quel que soit le nombre maximal de membres spécifié dans la requête. |
clientData[] |
Les données client du groupe. |
ContactGroupMetadata
Métadonnées associées à un groupe de contacts.
Représentation JSON |
---|
{ "updateTime": string, "deleted": boolean } |
Champs | |
---|---|
updateTime |
Uniquement en sortie. Heure de la dernière mise à jour du groupe. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
deleted |
Uniquement en sortie. "True" si la ressource de groupe de contacts a été supprimée. Renseigné uniquement pour les requêtes |
GroupType
Type de groupe de contacts.
Enums | |
---|---|
GROUP_TYPE_UNSPECIFIED |
Non spécifié. |
USER_CONTACT_GROUP |
Groupe de contacts défini par l'utilisateur. |
SYSTEM_CONTACT_GROUP |
Groupe de contacts défini par le système. |
GroupClientData
Données client arbitraires remplies par les clients. Les clés et valeurs en double sont autorisées.
Représentation JSON |
---|
{ "key": string, "value": string } |
Champs | |
---|---|
key |
Clé des données du client spécifiée par le client. |
value |
Valeur des données client spécifiée par le client. |
Méthodes |
|
---|---|
|
Obtenez une liste des groupes de contacts appartenant à l'utilisateur authentifié en spécifiant une liste de noms de ressources de groupe de contacts. |
|
Créez un groupe de contacts appartenant à l'utilisateur authentifié. |
|
Supprimez un groupe de contacts existant appartenant à l'utilisateur authentifié en spécifiant un nom de ressource de groupe de contacts. |
|
Obtenez un groupe de contacts spécifique appartenant à l'utilisateur authentifié en spécifiant un nom de ressource de groupe de contacts. |
|
Répertorier tous les groupes de contacts appartenant à l'utilisateur authentifié. |
|
Mettez à jour le nom d'un groupe de contacts existant appartenant à l'utilisateur authentifié. |