Method: contactGroups.update

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

I nomi dei gruppi di contatti aggiornati devono essere univoci per i gruppi di contatti degli utenti. Se si tenta di creare un gruppo con un nome duplicato, verrà restituito un errore HTTP 409.

Le richieste modificate per lo stesso utente devono essere inviate in sequenza per evitare un aumento della latenza e degli errori.

Richiesta HTTP

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
contactGroup.resourceName

string

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

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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
}
Campi
contactGroup.etag

string

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

object (ContactGroupMetadata)

Solo output. Metadati sul gruppo di contatti.
contactGroup.groupType

enum (GroupType)

Solo output. Il tipo di gruppo di contatti.
contactGroup.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 contatti degli utenti. Se si tenta di creare un gruppo con un nome duplicato, verrà restituito un errore HTTP 409.
contactGroup.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 sono gli stessi del nome.
contactGroup.memberResourceNames[]

string

Solo output. L'elenco dei nomi delle risorse delle persone 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.
contactGroup.memberCount

integer

Solo output. Il numero totale di contatti nel gruppo indipendentemente dal numero massimo di membri specificati nella richiesta.
contactGroup.clientData[]

object (GroupClientData)

I dati dei clienti del gruppo.
updateGroupFields

string (FieldMask format)

Campo facoltativo. Una maschera dei campi per limitare i campi del gruppo aggiornati. È possibile specificare più campi separandoli con virgole. Se non viene configurato o se viene lasciato vuoto, il valore predefinito è name. I campi aggiornati vengono sostituiti. I valori validi sono:

  • clientData
  • nome
readGroupFields

string (FieldMask format)

Campo facoltativo. Una maschera dei campi per limitare i campi del gruppo che vengono restituiti. Se non viene configurato o se viene lasciato vuoto, il valore predefinito è metadata, groupType e name. I campi validi sono:

  • clientData
  • groupType
  • memberCount
  • metadati
  • nome

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di ContactGroup.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/contacts

Per ulteriori informazioni, consulta la guida all'autorizzazione.