Method: people.getBatchGet

Proporciona información sobre una lista de personas específicas mediante la especificación de 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 recursos de las personas a las que se les debe proporcionar información. Es repetible. El parámetro de búsqueda 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 el contacto que people.connections.list muestra.

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. Una máscara de campo que restringe los campos que se muestran en cada persona. Se pueden especificar varios campos separándolos con comas. A continuación, se indican los valores válidos:

  • addresses
  • Rangos de edad
  • biografías
  • cumpleaños
  • URL de calendario
  • datosdelcliente
  • fotos de portada
  • Direcciones de correo electrónico
  • eventos
  • ID externos
  • Sexos
  • clientes potenciales
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • metadata
  • palabras clave varias
  • names
  • sobrenombres
  • profesiones
  • organizations
  • númerosdeteléfono
  • fotos
  • relaciones
  • direccionessip
  • skills
  • url
  • definido por el usuario
sources[]

enum (ReadSourceType)

Opcional. Una máscara de los tipos de fuentes que se mostrarán La configuración predeterminada es READ_SOURCE_TYPE_CONTACT y READ_SOURCE_TYPE_PROFILE si no se configura.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

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

La respuesta a una solicitud get para una lista de personas por nombre de recurso.

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

object (PersonResponse)

La respuesta para cada nombre de recurso solicitado.

Alcances de la autorización

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

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.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

Para obtener más información, consulta la guía de autorización.