Visão geral da API Domain Shared Contacts

A API Domain Shared Contacts permite que seus aplicativos acessem 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 para usuários ou grupos do domínio (internos) pode resultar em dados de contato duplicados para esses usuários e grupos, o que pode causar um comportamento inesperado. Para receber e atualizar os dados de contato dos usuários do domínio do Google Workspace (interno), 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 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 de contato compartilhado podem levar até 24 horas para serem exibidas no preenchimento automático de 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, você também verá 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 clientes que possam manipular listas de contatos do Google usando HTTP e XML. Neste documento, pressupomos que você entenda os fundamentos por trás do protocolo de APIs de dados do Google.

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

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

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