Method: contactGroups.list

Elenca tutti i gruppi di contatti di proprietà dell'utente autenticato. I membri dei gruppi di contatti non sono compilati.

Richiesta HTTP

GET https://people.googleapis.com/v1/contactGroups

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
pageToken

string

(Facoltativo) Il valore nextPageToken restituito da una chiamata precedente a contactGroups.list. Richiede la pagina successiva di risorse.
pageSize

integer

(Facoltativo) Il numero massimo di risorse da restituire. I valori validi sono compresi tra 1 e 1000 inclusi. Il valore predefinito è 30 se non viene configurato o se viene impostato su 0.
syncToken

string

(Facoltativo) Un token di sincronizzazione, restituito da una precedente chiamata a contactgroups.list. Verranno restituite solo le risorse modificate dopo la creazione del token di sincronizzazione.
groupFields

string (FieldMask format)

(Facoltativo) Una maschera del campo per limitare i campi restituiti del gruppo. Se il criterio non viene configurato o se viene lasciato vuoto, il valore predefinito è metadata, groupType, memberCount e name. I campi validi sono:

  • clientData
  • groupType
  • memberCount
  • metadati
  • nome

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta a una richiesta di elenco di gruppi di contatti.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Campi
contactGroups[]

object (ContactGroup)

L'elenco dei gruppi di contatti. I membri dei gruppi di contatti non sono compilati.
totalItems

integer

Il numero totale di elementi nell'elenco senza impaginazione.
nextPageToken

string

Il token che può essere utilizzato per recuperare la pagina successiva di risultati.
nextSyncToken

string

Il token che può essere utilizzato per recuperare le modifiche dall'ultima richiesta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.