Method: contactGroups.list

Lista todos os grupos de contatos do usuário autenticado. Os membros dos grupos de contatos não estão preenchidos.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
pageToken

string

Opcional. O valor nextPageToken retornado de uma chamada anterior para contactGroups.list. Solicita a próxima página de recursos.
pageSize

integer

Opcional. O número máximo de recursos a serem retornados. Os valores válidos estão entre 1 e 1.000, inclusive. O padrão será 30 se não for definido ou for definido como 0.
syncToken

string

Opcional. Um token de sincronização, retornado por uma chamada anterior para contactgroups.list. Serão retornados somente os recursos alterados desde a criação do token de sincronização.
groupFields

string (FieldMask format)

Opcional. Uma máscara de campo para restringir quais campos do grupo são retornados. Se não for definido ou for definido como vazio, o padrão será metadata, groupType, memberCount e name. Os campos válidos são:

  • clientData
  • groupType
  • memberCount
  • metadados
  • name

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta a uma solicitação de lista de grupos de contatos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Campos
contactGroups[]

object (ContactGroup)

A lista de grupos de contatos. Os membros dos grupos de contatos não estão preenchidos.
totalItems

integer

O número total de itens na lista sem paginação.
nextPageToken

string

O token que pode ser usado para recuperar a próxima página de resultados.
nextSyncToken

string

O token que pode ser usado para recuperar mudanças desde a última solicitação.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte o Guia de autorização.