Method: contactGroups.list

Enumera todos los grupos de contactos que pertenecen al usuario autenticado. Los miembros de los grupos de contactos no se propagan.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
pageToken

string

Opcional. El valor de nextPageToken que se muestra en una llamada anterior a contactGroups.list. Solicita la siguiente página de recursos.
pageSize

integer

Opcional. La cantidad máxima de recursos que se mostrarán. Los valores válidos deben estar entre 1 y 1,000, inclusive. El valor predeterminado es 30 si no se establece o se establece en 0.
syncToken

string

Opcional. Un token de sincronización, que muestra una llamada anterior a contactgroups.list. Solo se mostrarán los recursos modificados desde que se creó el token de sincronización.
groupFields

string (FieldMask format)

Opcional. Una máscara de campo para restringir los campos del grupo que se muestran. El valor predeterminado es metadata, groupType, memberCount y name si no se establece o si está vacío. Los campos válidos son los siguientes:

  • clientData
  • groupType
  • memberCount
  • metadatos
  • nombre

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta a una solicitud de lista de grupos de contactos.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Campos
contactGroups[]

object (ContactGroup)

La lista de grupos de contactos. Los miembros de los grupos de contactos no se propagan.
totalItems

integer

La cantidad total de elementos en la lista sin paginación.
nextPageToken

string

El token que se puede usar para recuperar la página siguiente de resultados.
nextSyncToken

string

El token que se puede usar para recuperar cambios desde la última solicitud.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.