Method: contactGroups.get

Especifique um nome de recurso de grupo de contatos para obter um grupo de contatos específico de propriedade do usuário autenticado.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
resourceName

string

Obrigatório. O nome do recurso do grupo de contatos a ser recebido.

Parâmetros de consulta

Parâmetros
maxMembers

integer

Opcional. Especifica o número máximo de membros a serem retornados. Se não for definido, o padrão será 0, o que não retornará nenhum membro.
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

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ContactGroup.

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.