Method: people.get
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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
https://www.googleapis.com/auth/profile.language.read
Para obtener más información, consulta la guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-08-06 (UTC)
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Falta la información que necesito","missingTheInformationINeed","thumb-down"],["Muy complicado o demasiados pasos","tooComplicatedTooManySteps","thumb-down"],["Desactualizado","outOfDate","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Problema con las muestras o los códigos","samplesCodeIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2024-08-06 (UTC)"],[[["Retrieves information about a person, including the authenticated user using `people/me` or by specifying a resource name."],["Requires the `personFields` query parameter to specify which fields to include in the response, otherwise, it returns a 400 error."],["Allows filtering the source of the data using the `sources[]` parameter and supports various authorization scopes for accessing private data."],["Uses a `GET` request to the `https://people.googleapis.com/v1/{resourceName=people/*}` endpoint with optional query parameters."],["Response includes a [Person](/people/api/rest/v1/people#Person) object containing the requested information if successful."]]],["This outlines how to retrieve person information via a `GET` request to `https://people.googleapis.com/v1/{resourceName=people/*}`. The `resourceName` path parameter specifies the person (e.g., `people/me` for the authenticated user). The `personFields` query parameter is mandatory and dictates the data returned. The request body must be empty. A successful request returns a `Person` resource. Authorization is needed for private data. A `400` error is returned if `personFields` is not specified.\n"]]