A API Contacts foi desativada em 19 de janeiro de 2022. Use este guia para saber mais sobre as alterações em campos, endpoints e escopos de autorização à medida que você migra para a API People.
Informações gerais
A API People tem os mesmos recursos que a API Contacts legada para todos os recursos, com as seguintes exceções para Outros contatos:
Os administradores têm permissões somente leitura para "Outros contatos" pelo novo escopo. Como o envio de sinais de mutação/gravação de volta para "Outros contatos" não é compatível, seus usuários precisarão adicionar o outro contato como um meu contato se quiserem atualizar os campos de dados dele.
Apenas informações de contato básicas de "Outros contatos" podem ser lidas na API. Por exemplo, nome completo, endereço de e-mail e número de telefone.
Além disso, o antigo escopo Contatos (https://www.google.com/m8/feeds), que
fornecia acesso a contatos pessoais e informações de diretório, foi substituído
pelos seguintes escopos:
- Para acessar contatos pessoais:
https://www.googleapis.com/auth/contacts - Para acessar as informações do diretório:
https://www.googleapis.com/auth/directory.readonly
Contatos
Mapeamento de campos
| Campo de contato | Campo da pessoa |
|---|---|
| atom:content | biografias |
| atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' | fotos |
| atom:title | names |
| gContact:billingInformation | miscKeyword (type=OUTLOOK_BILLING_INFORMATION) |
| gContact:aniversário | aniversários |
| gContact:calendarLink | calendarUrls |
| gContact:directoryServer | miscPalavras-chave (type=OUTLOOK_DIRECTORY_SERVER) |
| gContact:event | eventos |
| gContact:extendedProperty | clientData |
| gContact:externalId | externalIds |
| gContact:fileAs | fileAses |
| gContact:gender | genders |
| gContact:groupMembershipInfo | memberships.contactGroupMembership |
| gContact:hobby | interesses |
| gContact:inicial | Apelidos (type=INITIALS) DESATIVADO |
| gContact:jot type='home' | miscPalavras-chave (type=HOME) |
| gContact:jot type='keywords' | miscKeyword (type=OUTLOOK_KEYWORD) |
| gContact:jot type='other' | miscPalavras-chave (type=OTHER) |
| gContact:jot type='user' | miscPalavras-chave (type=OUTLOOK_USER) |
| gContact:jot type='work' | miscPalavras-chave (type=WORK) |
| gContact:idioma | idiomas |
| gContact:maidenName | OBSOLETO apelidos (type=MAIDEN_NAME) |
| gContact:mileage | miscPalavras-chave (type=OUTLOOK_MILEAGE) |
| gContact:apelido | apelidos (type=DEFAULT) |
| gContact:profissão | ocupações |
| gContact:prioridade | miscPalavras-chave (type=OUTLOOK_PRIORITY) |
| gContact:relação | relações |
| gContact:sensibilidade | Palavras-chave misc (type=OUTLOOK_SENSITIVITY) |
| gContact:shortName | Apelidos (type=SHORT_NAME) DESATIVADO |
| gContact:subject | miscPalavras-chave (type=OUTLOOK_SUBJECT) |
| gContact:userDefinedField | userDefined |
| gContact:site | urls |
| gContact:yomiName | names.phonetic_full_name |
| gd:excluído | metadata.deleted |
| gd:email | emailAddresses |
| gd:im | imClients |
| gd:organização | organizations |
| gd:phoneNumber | phoneNumbers |
| gd:postalAddress | addresses.formattedValue |
| gd:onde | residências |
| gd:structuredPostalAddress | endereços |
Endpoints de contatos pessoais
Ler
Requer o escopo https://www.googleapis.com/auth/contacts ou https://www.googleapis.com/auth/contacts.readonly.
- Ler um único contato específico
people.get - Ler vários contatos específicos
people.getBatchGet - Ler contatos usando
people.connections.list.
Modificar
Requer o escopo https://www.googleapis.com/auth/contacts. Modifica todos os campos de contato, exceto as fotos.
- Criar um contato usando
people.createContact. - Atualizar um contato
que já existe usando
people.updateContact. - Exclua um contato
usando
people.deleteContact.
Modificar foto
Requer o escopo https://www.googleapis.com/auth/contacts.
- Atualize a foto de um contato usando
people.updateContactPhoto. - Exclua uma foto de contato usando
people.deleteContactPhoto.
Outros endpoints de contatos
Ler
Os outros contatos são somente leitura, e apenas os campos names, emailAddresses e phoneNumbers são retornados.
Requer o escopo https://www.googleapis.com/auth/contacts.other.readonly.
- Leia outros contatos usando
otherContacts.list.
Copiar
Requer escopos https://www.googleapis.com/auth/contacts.other.readonly e https://www.googleapis.com/auth/contacts.
- Copie outros contatos usando
otherContacts.copyOtherContactToMyContactsGroup.
Endpoints da lista de endereços global
Requer o escopo https://www.googleapis.com/auth/directory.readonly.
- Lista todos os contatos e perfis do diretório
people.listDirectoryPeople. - Pesquise contatos e perfis do diretório
people.searchDirectoryPeople.
Grupos de contato
Mapeamento de campos
| Campo do grupo de contatos da API de contatos | Campo do grupo de contato da API People |
|---|---|
| atom:atualizado | metadata.updateTime |
| atom:title | name |
| atom:content | name |
| gd:excluído | metadata.deleted |
| systemGroup | groupType=SYSTEM_CONTACT_GROUP (em inglês) |
Endpoints
Ler
Requer o escopo https://www.googleapis.com/auth/contacts ou https://www.googleapis.com/auth/contacts.readonly.
- Acessar um grupo de contatos específico usando
people.contactGroups.get - Listar grupos de contatos usando
people.contactGroups.list
Modificar
Requer o escopo https://www.googleapis.com/auth/contacts.
- Criar um grupo de contatos usando
people.contactGroups.create - Atualizar um grupo de contatos usando
people.contactGroups.update - Excluir um grupo de contatos usando
people.contactGroups.delete Adicionar ou remover contatos do grupo usando o
people.contactGroups.members.modify
Escopos de autorização
O escopo legado https://www.google.com/m8/feeds é um alias do escopo https://www.googleapis.com/auth/contacts. Isso significa que as concessões do OAuth atuais com o escopo legado funcionarão para todos os endpoints na API People que exigirem o escopo https://www.googleapis.com/auth/contacts. A leitura e a gravação de contatos e grupos de contatos funcionarão com o escopo legado.
A API People requer novos escopos para acessar os dados de "Outros contatos" ou do diretório. Confira os detalhes acima para os escopos necessários.
Para mais detalhes, consulte Autorizar solicitações.
Bibliotecas de cliente
- Para o Apps Script, consulte Serviço avançado de pessoas.
- Para outras linguagens compatíveis, consulte Instalar bibliotecas de cliente.