Method: people.getBatchGet

Fornece informações sobre uma lista de pessoas específicas, especificando uma lista de nomes de recursos solicitados. Use people/me para indicar o usuário autenticado.

A solicitação retornará um erro 400 se "personFields" não for especificado.

Solicitação HTTP

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

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

Parâmetros de consulta

Parâmetros
resourceNames[]

string

Obrigatório. Os nomes dos recursos das pessoas sobre as quais as informações serão fornecidas. Ele pode ser repetido. O parâmetro de consulta do URL deve ser

resourceNames=<name1>&resourceNames=<name2>&...

  • Para receber informações sobre o usuário autenticado, especifique people/me.
  • Para receber informações sobre uma Conta do Google, especifique people/{account_id}.
  • Para receber informações sobre um contato, especifique o nome do recurso que identifica o contato como retornado por people.connections.list.

O número máximo de nomes de recursos é 200.
requestMask
(deprecated)

object (RequestMask)

OBSOLETO (use personFields)

Uma máscara para restringir os resultados a um subconjunto de campos de pessoa.
personFields

string (FieldMask format)

Obrigatório. Uma máscara de campo para restringir quais campos de cada pessoa são retornados. É possível especificar vários campos separados por vírgulas. Os valores válidos são:

  • addresses
  • ageRanges
  • biografias
  • aniversários
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • events
  • externalIds
  • sexos
  • imClients
  • interesses
  • locales
  • locais
  • dos canais
  • metadados
  • miscKeywords
  • names
  • apelidos
  • ocupações
  • organizations
  • phoneNumbers
  • fotos
  • relações
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opcional. Uma máscara dos tipos de origem a serem retornados. O padrão será READ_SOURCE_TYPE_CONTACT e READ_SOURCE_TYPE_PROFILE, se nenhum valor for definido.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta a uma solicitação get para uma lista de pessoas por nome de recurso.

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

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

object (PersonResponse)

A resposta para cada nome de recurso solicitado.

Escopos de autorização

Nenhuma autorização é necessária para acessar dados públicos. Para dados particulares, um dos seguintes escopos do OAuth é obrigatório:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile
  • https://www.googleapis.com/auth/profile.language.read

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