Method: people.get

Proporciona información sobre una persona mediante la especificación de un nombre de recurso. 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/{resourceName=people/*}

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

Parámetros de ruta de acceso

Parámetros
resourceName

string

Obligatorio. El nombre de recurso de la persona sobre la que se proporcionará información.

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

Parámetros de consulta

Parámetros
requestMask
(deprecated)

object (RequestMask)

OBSOLETO (en su lugar, usa personFields)

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

personFields

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos que se muestran en la persona. Se pueden especificar varios campos separándolos con comas. Estos son los valores válidos:

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

enum (ReadSourceType)

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

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Person.

Permisos 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

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