Method: contactGroups.list

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

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
pageToken

string

Campo facoltativo. Il valore nextPageToken restituito da una chiamata precedente a contactGroups.list. Richiede la pagina successiva delle risorse.
pageSize

integer

Campo facoltativo. Il numero massimo di risorse da restituire. I valori validi sono compresi tra 1 e 1000 inclusi. Se non è impostato o è impostato su 0, il valore predefinito è 30.
syncToken

string

Campo facoltativo. Un token di sincronizzazione, restituito da una precedente chiamata a contactgroups.list. Verranno restituite solo le risorse modificate dalla creazione del token di sincronizzazione.
groupFields

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, 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 alla richiesta di un 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 contatto non vengono compilati.
totalItems

integer

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

string

Il token che può essere utilizzato per recuperare la pagina dei risultati successiva.
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.