REST Resource: contactGroups

Risorsa: ContactGroup

Un gruppo di contatti.

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

string

Il nome della risorsa per il gruppo di contatti, assegnato dal server. Una stringa ASCII, nel formato contactGroups/{contactGroupId}.

etag

string

Il tag entità HTTP della risorsa. Utilizzato per la convalida della cache web.

metadata

object (ContactGroupMetadata)

Solo output. I metadati sul gruppo di contatti.

groupType

enum (GroupType)

Solo output. Il tipo di gruppo di contatti.

name

string

Il nome del gruppo di contatti impostato dal proprietario del gruppo o un nome fornito dal sistema per i gruppi di sistema.

Per contactGroups.create o contactGroups.update il nome deve essere univoco per i gruppi di contatto degli utenti. Se provi a creare un gruppo con un nome duplicato, verrà restituito un errore HTTP 409.

formattedName

string

Solo output. Il nome tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language per i nomi dei gruppi di sistema. I nomi dei gruppi impostati dal proprietario corrispondono al nome.

memberResourceNames[]

string

Solo output. L'elenco di nomi di risorse della persona di contatto che fanno parte del gruppo di contatti. Il campo viene compilato solo per le richieste GET e restituirà solo un numero di membri pari a maxMembers nella richiesta get.

memberCount

integer

Solo output. Il numero totale di contatti nel gruppo indipendentemente dal numero massimo di membri specificato nella richiesta.

clientData[]

object (GroupClientData)

I dati client del gruppo.

ContactGroupMetadata

I metadati relativi a un gruppo di contatti.

Rappresentazione JSON
{
  "updateTime": string,
  "deleted": boolean
}
Campi
updateTime

string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento del gruppo.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

deleted

boolean

Solo output. True se la risorsa del gruppo di contatti è stata eliminata. Compilato solo per le richieste contactGroups.list che includono un token di sincronizzazione.

GroupType

Un tipo di gruppo di contatti.

Enum
GROUP_TYPE_UNSPECIFIED Non specificato.
USER_CONTACT_GROUP Gruppo di contatti definito dall'utente.
SYSTEM_CONTACT_GROUP Gruppo di contatti definito dal sistema.

GroupClientData

Dati arbitrariamente client compilati dai client. Sono consentiti valori e chiavi duplicati.

Rappresentazione JSON
{
  "key": string,
  "value": string
}
Campi
key

string

La chiave specificata dal client dei dati del client.

value

string

Valore dei dati del cliente specificato dal cliente.

Metodi

batchGet

Recupera un elenco dei gruppi di contatti di proprietà dell'utente autenticato specificando un elenco di nomi delle risorse dei gruppi di contatti.

create

Crea un nuovo gruppo di contatti di proprietà dell'utente autenticato.

delete

Elimina un gruppo di contatti esistente di proprietà dell'utente autenticato specificando il nome di una risorsa del gruppo di contatti.

get

Per ottenere un gruppo di contatti specifico di proprietà dell'utente autenticato, specifica il nome di una risorsa del gruppo di contatti.

list

Elenca tutti i gruppi di contatti di proprietà dell'utente autenticato.

update

Aggiorna il nome di un gruppo di contatti esistente di proprietà dell'utente autenticato.