Method: contactGroups.batchGet

Receba uma lista de grupos de contatos de propriedade do usuário autenticado especificando uma lista de nomes de recursos de grupo de contatos.

Solicitação HTTP

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

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

Parâmetros de consulta

Parâmetros
resourceNames[]

string

Obrigatório. Os nomes de recurso dos grupos de contatos a serem conseguidos.

Há um máximo de 200 nomes de recursos.
maxMembers

integer

Opcional. Especifica o número máximo de membros a serem retornados para cada grupo. Se não for definido, o padrão será 0 e não retornará nenhum membro.
groupFields

string (FieldMask format)

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

  • clientData
  • groupType
  • memberCount
  • metadados
  • nome

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta a uma solicitação get contact groups em lote.

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

Representação JSON 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
Campos
responses[]

object (ContactGroupResponse)

A lista de respostas para cada recurso de grupo de contatos solicitado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

ContactGroupResponse

A resposta para um grupo de contatos específico.

Representação JSON 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
Campos
requestedResourceName

string

O nome original do recurso solicitado.
status

object (Status)

O status da resposta.
contactGroup

object (ContactGroup)

O grupo de contatos.