A API People permite:
- Ler e gerenciar os Contatos do usuário autenticado
- Ler e copiar o campo Outros contatos do usuário autenticado
- Ler as informações de perfil de usuários autenticados e seus contatos
- Ler perfis e contatos do domínio
Por exemplo, suponha que a usuária autenticada, Jen, tem Fabian e Ranjith nos
contatos particulares dela. Quando o app chama
people.connections.list
para ler uma
lista de conexões, Jen aparece com uma tela de consentimento pedindo para
conceder acesso à lista. Se Jen consentir, o app lerá uma lista contendo
person resources
para Fabian e Ranjith.
Se o app precisar de informações de uma pessoa específica, ele pode chamar
people.get
e transmitir um nome de recurso para receber
o person resource
dessa pessoa.
O app também pode gerenciar contatos criando novos contatos usando
people.createContact
, atualizar contatos existentes
lidos com
people.connections.list
usando
people.updateContact
e excluir contatos
usando people.deleteContact
.
Os usuários do Google Workspace também podem listar os contatos e contatos de
domínio do domínio usando
people.listDirectoryPeople
ou pesquisar
usando
people.searchDirectoryPeople
.
Uma visualização unificada das informações de pessoas
As informações de pessoas que a API People lê são mescladas de várias fontes, dependendo das seguintes condições:
Fonte | Condição |
---|---|
Dados públicos de perfis do Google | Sempre. |
dados do perfil do domínio do Google Workspace | O administrador do domínio ativou o compartilhamento externo de contatos e
perfis
de dados com escopo do domínio, e o escopo
directory.readonly foi concedido |
As informações privadas do perfil do usuário autenticado | Um dos escopos profile foi concedido. |
Os contatos do usuário autenticado | O escopo
contacts foi
concedido. |
Noções básicas sobre dados de pessoas mescladas
Os dados de uma pessoa são derivados de um tipo principal de origem. Os dados de outras fontes serão combinados com esses dados se estiverem conectados por endereços de e-mail, números de telefone ou URLs de perfil verificados. Veja como uma pessoa pode ser composta:
Fonte principal | Contatos | Perfis | Perfis de domínio do Google Workspace | Contatos do domínio do Google Workspace | Uso |
---|---|---|---|---|---|
Contato | 1 | 0+ | 0+ | 0+ | Retornado para a maioria dos endpoints |
Perfil | 0+ | 1 | 0 ou 1 | 0 | Devolvido no people.get quando usado para levar a pessoa para o usuário conectado ou para a Conta do Google de outro usuário. |
Contato do domínio | 0+ | 0 | 0 | 1 | Devolvido em people.listDirectoryPeople ou people.searchDirectoryPeople . |
Somente pessoas baseadas em contatos podem ser modificadas por endpoints de mutação. As mutações de contato de perfil e do domínio não são compatíveis.