Visão geral da API Domain Shared Contacts

Com a API Domain Shared Contacts, seus aplicativos podem receber e atualizar contatos externos compartilhados com todos os usuários em um domínio do Google Workspace. Os contatos compartilhados ficam visíveis para todos os usuários de um domínio do Google Workspace, e todos os serviços do Google têm acesso à lista de contatos.

Aviso: a API Domain Shared Contacts é destinada apenas a contatos externos. Usar essa API para criar informações de contato de usuários ou grupos do domínio (internos) pode resultar em informações duplicadas, o que pode levar a um comportamento inesperado. Para acessar e atualizar as informações de contato dos usuários do domínio do Google Workspace (internos), use a API Directory em vez disso.

Seu aplicativo pode usar a API Domain Shared Contacts para criar contatos compartilhados, editar ou excluir contatos compartilhados existentes e consultar contatos compartilhados que correspondam a um critério específico.

A API Domain Shared Contacts está disponível apenas para contas do Google Workspace. Para usar a API, ative a API Domain Shared Contacts no Admin Console. As mudanças nos contatos compartilhados podem levar até 24 horas para aparecer no preenchimento automático do endereço de e-mail e no gerenciador de contatos.

Além de fornecer informações básicas sobre os recursos da API Domain Shared Contacts, este documento oferece exemplos de como gerenciar contatos usando XML e HTTP. Depois de ler este documento, saiba mais sobre como interagir com a API usando nossas bibliotecas de cliente.

Público-alvo

Este documento é destinado a desenvolvedores que querem criar aplicativos cliente capazes de manipular as listas de contatos do Google usando HTTP e XML. Neste documento, presumimos que você entenda os fundamentos do protocolo das APIs Google Data.

Se você estiver usando um sistema operacional UNIX e quiser testar os exemplos neste documento sem escrever código, use os utilitários de linha de comando UNIX curl ou wget. Saiba como usar cURL com os Serviços de dados do Google.

Princípios

Esta versão da API Domain Shared Contacts segue os princípios das APIs de dados do Google. As APIs de dados do Google são baseadas nos formatos de distribuição Atom 1.0 e RSS 2.0, além do protocolo de publicação Atom.

Especificar uma versão

Todas as solicitações enviadas usando a API Domain Shared Contacts precisam especificar a versão 3.0 da API:

GData-Version: 3.0

Se não for possível definir cabeçalhos HTTP, especifique v=3.0 como um parâmetro de consulta no URL. No entanto, o método de cabeçalho HTTP é recomendado.

Observação: as bibliotecas de cliente fornecem automaticamente os cabeçalhos de versão apropriados. Portanto, não use o parâmetro de consulta v=3.0 ao usar uma biblioteca de cliente.