Method: people.get
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Fornece informações sobre uma pessoa especificando um nome de recurso. 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/{resourceName=people/*}
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
resourceName |
string
Obrigatório. O nome do recurso da pessoa sobre o qual as informações serão fornecidas.
- 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
|
Parâmetros de consulta
| Parâmetros |
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 da 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_PROFILE e READ_SOURCE_TYPE_CONTACT, se nenhum valor for definido.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Person.
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/contactshttps://www.googleapis.com/auth/contacts.readonlyhttps://www.googleapis.com/auth/contacts.other.readonlyhttps://www.googleapis.com/auth/directory.readonlyhttps://www.googleapis.com/auth/profile.agerange.readhttps://www.googleapis.com/auth/profile.emails.readhttps://www.googleapis.com/auth/profile.language.readhttps://www.googleapis.com/auth/user.addresses.readhttps://www.googleapis.com/auth/user.birthday.readhttps://www.googleapis.com/auth/user.emails.readhttps://www.googleapis.com/auth/user.gender.readhttps://www.googleapis.com/auth/user.organization.readhttps://www.googleapis.com/auth/user.phonenumbers.readhttps://www.googleapis.com/auth/userinfo.emailhttps://www.googleapis.com/auth/userinfo.profilehttps://www.googleapis.com/auth/profile.language.read
Para mais informações, consulte o Guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-08-06 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2024-08-06 UTC."],[[["\u003cp\u003eRetrieves information about a person, including the authenticated user using \u003ccode\u003epeople/me\u003c/code\u003e or by specifying a resource name.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003epersonFields\u003c/code\u003e query parameter to specify which fields to include in the response, otherwise, it returns a 400 error.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering the source of the data using the \u003ccode\u003esources[]\u003c/code\u003e parameter and supports various authorization scopes for accessing private data.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the \u003ccode\u003ehttps://people.googleapis.com/v1/{resourceName=people/*}\u003c/code\u003e endpoint with optional query parameters.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a \u003ca href=\"/people/api/rest/v1/people#Person\"\u003ePerson\u003c/a\u003e object containing the requested information if successful.\u003c/p\u003e\n"]]],["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"],null,[]]
