É possível solicitar contatos compartilhados de usuário de várias maneiras:
- Todos os contatos compartilhados
- Um conjunto de contatos que corresponde a um critério especificado.
- Um único contato compartilhado
- A foto de um contato
Por padrão, as entradas em um feed não são ordenadas.
Recupere todos os contatos compartilhados
Para acessar todos os contatos compartilhados, envie uma solicitação
GET
HTTP para o URL do feed de contatos:GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION
Substitua:
DOMAIN
: o URL do domínio, por exemplo, example.com.PROJECTION
: o valor de projeção que especifica os elementos degd:extendedProperty
. Para ver uma lista de valores compatíveis, consulte Valores de projeção.
O feed retorna um código de status
HTTP 200 OK
e um feed Atom 1.0 padrão contendo os contatos. Veja a seguir um exemplo de feed de contatos com apenas uma entrada:<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:gd='http://schemas.google.com/g/2005' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:batch='http://schemas.google.com/gdata/batch'> <id>https://www.google.com/m8/feeds/contacts/example.com/base</id> <updated>2008-03-05T12:36:38.836Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>example.com's Contacts</title> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#batch' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/batch' /> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full?max-results=25' /> <author> <name>example.com</name> <email>example.com</email> </author> <generator version='1.0' uri='https://www.google.com/m8/feeds/contacts'> Contacts </generator> <openSearch:totalResults>1</openSearch:totalResults> <openSearch:startIndex>1</openSearch:startIndex> <openSearch:itemsPerPage>25</openSearch:itemsPerPage> <entry> <id> https://www.google.com/m8/feeds/contacts/example.com/base/c9012de </id> <updated>2008-03-05T12:36:38.835Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>Fitzgerald</title> <gd:name> <gd:fullName>Fitzgerald</gd:fullName> </gd:name> <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*" href="http://google.com/m8/feeds/photos/media/example.com/c9012de"/> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de' /> <link rel='edit' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de/1204720598835000' /> <gd:phoneNumber rel='http://schemas.google.com/g/2005#home' primary='true'> 456 </gd:phoneNumber> <gd:extendedProperty name="pet" value="hamster" /> </entry> </feed>
O feed não retorna mais de 10 MB em uma única resposta. Para ver toda a lista de contatos, siga repetidamente o link Próxima do feed retornado até que esse link não apareça mais no feed.
Receber contatos compartilhados usando parâmetros de consulta
Você pode solicitar um conjunto de contatos que corresponda a um critério especificado, como a solicitação de contatos atualizados após uma determinada data. Não há suporte para consultas de texto completo ou localização de um contato por endereço de e-mail. Para uma lista completa dos parâmetros de consulta compatíveis, consulte o Guia de Referência da API Domain Shared Contacts.
Envie uma solicitação
HTTP GET
para o URL do feed de contatos com um parâmetro definido:GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION?PARAMETER
Substitua:
DOMAIN
: o URL do domínio, por exemplo, example.com.PROJECTION
: o valor de projeção que especifica os elementos degd:extendedProperty
. Para ver uma lista de valores compatíveis, consulte Valores de projeção.PARAMETER
: um dos parâmetros de consulta compatíveis. Para mais informações, consulte o Guia de referência da API Domain Shared Contacts.
Por exemplo, para receber todas as entradas de contatos compartilhados do domínio atualizadas após 16 de março de 2022, em example.com, envie uma solicitação HTTP para o URL do feed de contatos compartilhado do domínio e adicione o parâmetro
updated-min
ao URL da solicitação:GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00
Quando você envia essa solicitação
GET
, o servidor retorna um código de status HTTP200 OK
e um feed contendo todos os contatos compartilhados do domínio que foram criados ou atualizados após a data especificada.O feed não retorna mais de 10 MB em uma única resposta. Para ver toda a lista de contatos com os critérios especificados, siga repetidamente o link Próxima do feed retornado até que esse link não apareça mais no feed.
Acompanhar mudanças incrementais
Para acompanhar alterações incrementais em uma lista de contatos compartilhados do domínio, faça o
seguinte:
1. Ao enviar uma solicitação para um feed, monitore o valor do elemento <updated>
dele.
1. Para acessar apenas os contatos compartilhados do domínio que foram alterados desde a solicitação anterior, defina o parâmetro de consulta updated-min
como esse valor <updated>
e showdeleted
como true
.
Reunir um único contato compartilhado
Para ter um único contato compartilhado, você precisa usar o link próprio do contato. Você só pode acessar o link próprio do contato compartilhado localizando a entrada dele no feed de contatos compartilhados. Se você não tiver certeza de qual valor usar para o self link, consulte Receber todos os contatos e Receber contatos usando parâmetros de consulta.
- Para receber um contato compartilhado específico do domínio, envie uma solicitação
GET
HTTP para o link próprio de um contato:GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION/:SELF_LINK>
Substitua o seguinte:
DOMAIN
: o URL do domínio, por exemplo, example.com.PROJECTION
: o valor de projeção que especifica os elementosgd:extendedProperty
. Para ver uma lista de valores compatíveis, consulte Valores de projeção.SELF_LINK
: um valor numérico exclusivo que representa um único contato compartilhado, por exemplo, 12345.
Em seguida, o servidor retorna um código de status HTTP 200 OK
e uma entrada que contém o
contato.
Por exemplo, para receber um contato compartilhado do domínio com o self link definido como https://www.google.com/m8/feeds/contacts/example.com/full/12345
, envie a seguinte solicitação HTTP:
GET https://www.google.com/m8/feeds/contacts/example.com/full/12345