Method: people.getBatchGet

Proporciona información sobre una lista de personas específicas especificando una lista de nombres de recursos solicitados. Usa people/me para indicar el usuario autenticado.

La solicitud muestra un error 400 si no se especifica "personFields".

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
resourceNames[]

string

Obligatorio. Los nombres de los recursos de las personas sobre las que se proporcionará información Se puede repetir. El parámetro de consulta de URL debe ser

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

  • Para obtener información sobre el usuario autenticado, especifica people/me.
  • Para obtener información sobre una Cuenta de Google, especifica people/{account_id}.
  • Para obtener información sobre un contacto, especifica el nombre del recurso que identifica al contacto como lo muestra people.connections.list.

Hay un máximo de 200 nombres de recursos.
requestMask
(deprecated)

object (RequestMask)

OBSOLETO (en su lugar, usa personFields)

Una máscara para restringir los resultados a un subconjunto de campos de personas.
personFields

string (FieldMask format)

Obligatorio. Es una máscara de campo para restringir qué campos de cada persona se muestran. Se pueden especificar varios campos separándolos con comas. Estos son los valores válidos:

  • direcciones
  • ageRanges
  • biografías
  • cumpleaños
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • eventos
  • externalIds
  • Sexos
  • imClients
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • metadatos
  • miscKeywords
  • names
  • sobrenombres
  • profesiones
  • organizaciones
  • phoneNumbers
  • fotos
  • relaciones
  • sipAddresses
  • skills
  • url
  • userDefined
sources[]

enum (ReadSourceType)

Opcional. Es una máscara de los tipos de fuentes que se mostrarán. Si no se configura, el valor predeterminado es READ_SOURCE_TYPE_CONTACT y READ_SOURCE_TYPE_PROFILE.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta a una solicitud GET de una lista de personas por nombre de recurso.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
Campos
responses[]

object (PersonResponse)

La respuesta para cada nombre de recurso solicitado

Alcances de autorización

No se requiere autorización para acceder a los datos públicos. Para los datos privados, se requiere uno de los siguientes permisos de OAuth:

  • 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 obtener más información, consulta la Guía de autorización.