Method: people.getBatchGet
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Fornece informações sobre uma lista de pessoas específicas especificando uma lista de nomes de recursos solicitados. Use people/me para indicar o usuário autenticado.
A solicitação vai retornar um erro 400 se "personFields" não for especificado.
Solicitação HTTP
GET https://people.googleapis.com/v1/people:batchGet
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
| Parâmetros |
resourceNames[] |
string
Obrigatório. Os nomes dos recursos das pessoas sobre as quais você quer fornecer informações. Ele pode ser repetido. O parâmetro de consulta do URL deve ser
resourceNames=<name1>&resourceNames=<name2>&...
- Para receber informações sobre o usuário autenticado, especifique
people/me.
- Para acessar 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 conforme retornado por
people.connections.list
Há um máximo de 200 nomes de recursos.
|
requestMask
(deprecated) |
object (RequestMask)
USO SUSPENSO (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 de cada pessoa são retornados. Vários campos podem ser especificados separados por vírgulas. Os valores válidos são:
- addresses
- ageRanges
- biografias
- aniversários
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- eventos
- externalIds
- sexos
- imClients
- interesses
- locales
- locais
- dos canais
- metadados
- miscKeywords
- nomes
- 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 é READ_SOURCE_TYPE_CONTACT e READ_SOURCE_TYPE_PROFILE, caso não esteja definido.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
A resposta a uma solicitação de recebimento de uma lista de pessoas por nome de recurso.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Campos |
responses[] |
object (PersonResponse)
A resposta para cada nome de recurso solicitado.
|
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-11-08 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-11-08 UTC."],[[["\u003cp\u003eRetrieves information about a list of specific people, including the authenticated user, by specifying resource names.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003epersonFields\u003c/code\u003e query parameter to specify desired data fields and returns a 400 error if it's missing.\u003c/p\u003e\n"],["\u003cp\u003eSupports various authorization scopes for accessing private data, although public data requires no authorization.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing an array of \u003ccode\u003ePersonResponse\u003c/code\u003e objects, each corresponding to a requested resource name.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003eGET\u003c/code\u003e HTTP method and the \u003ccode\u003ehttps://people.googleapis.com/v1/people:batchGet\u003c/code\u003e endpoint with gRPC Transcoding syntax.\u003c/p\u003e\n"]]],["This outlines how to retrieve information about specific people using the `people:batchGet` endpoint via a `GET` HTTP request. You must provide `resourceNames` (up to 200) in the query, identifying each person (e.g., `people/me` or `people/{account_id}`). The `personFields` parameter is required to specify which person attributes to include. The request body is empty. The response returns an array of `PersonResponse` objects, one for each requested resource name, and requires authorization scopes for private data. A 400 error is returned if 'personFields' are not provided.\n"],null,[]]
