Method: contactGroups.batchGet

Receba uma lista de grupos de contatos de propriedade do usuário autenticado. Basta especificar uma lista de nomes de recursos de grupos 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 dos recursos dos grupos de contatos a serem recebidos.

O número máximo de nomes de recursos é 200.
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, 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

A resposta a uma solicitação get em lote de grupos de contatos.

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 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.

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 do recurso solicitado original.
status

object (Status)

Status da resposta.
contactGroup

object (ContactGroup)

O grupo de contatos.