Visão geral da API Domain Shared Contacts

A API Domain Shared Contacts permite que seus aplicativos recebam e atualizem 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. O uso dessa API para criar dados de contato de usuários ou grupos do domínio pode resultar em dados de contato duplicados para esses usuários e grupos, o que talvez cause um comportamento inesperado. Para receber e atualizar os dados de contato dos usuários do domínio (interno) do Google Workspace, use a API Directory.

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 critérios específicos.

A API Domain Shared Contacts só está disponível para contas do Google Workspace. Para usar a API, ative a API Domain Shared Contacts no Admin Console. As alterações em contatos compartilhados podem levar até 24 horas para serem refletidas no preenchimento automático do endereço de e-mail e no gerenciador de contatos.

Além de fornecer informações sobre os recursos da API Domain Shared Contacts, este documento oferece exemplos sobre 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 clientes que possam manipular listas de contatos do Google usando HTTP e XML. Este documento pressupõe que você conhece os fundamentos do protocolo das APIs de dados do Google.

Se você estiver usando um sistema operacional UNIX e quiser testar os exemplos deste documento sem escrever nenhum código, use os utilitários de linha de comando curl ou wget do UNIX. Saiba como usar o 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 Atom Publishing.

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, mas o método de cabeçalho HTTP é recomendado.

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