REST Resource: contactGroups

Ressource: ContactGroup

Un groupe de contacts.

Représentation JSON 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Champs
resourceName

string

Nom de ressource du groupe de contacts, attribué par le serveur. Chaîne ASCII, au format contactGroups/{contactGroupId}.
etag

string

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

object (ContactGroupMetadata)

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

enum (GroupType)

Uniquement en sortie. Type de groupe de contacts.
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.
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.
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.
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.
clientData[]

object (GroupClientData)

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

string (Timestamp format)

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 : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Uniquement en sortie. "True" si la ressource de groupe de contacts a été supprimée. Renseigné uniquement pour les requêtes contactGroups.list qui incluent un jeton de synchronisation.

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

string

Clé des données du client spécifiée par le client.
value

string

Valeur des données client spécifiée par le client.

Méthodes

batchGet

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

create

 Créez un groupe de contacts appartenant à l'utilisateur authentifié.

delete

 Supprimez un groupe de contacts existant appartenant à l'utilisateur authentifié en spécifiant un nom de ressource de groupe de contacts.

get

 Obtenez un groupe de contacts spécifique appartenant à l'utilisateur authentifié en spécifiant un nom de ressource de groupe de contacts.

list

 Répertorier tous les groupes de contacts appartenant à l'utilisateur authentifié.

update

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