Receber contatos compartilhados

É possível solicitar contatos de usuários compartilhados de várias maneiras:

  • Todos os contatos compartilhados
  • Um conjunto de contatos que correspondem a um critério especificado
  • Um único contato compartilhado
  • Uma foto de um contato

Por padrão, as entradas em um feed não são ordenadas.

Receber todos os contatos compartilhados

  1. Para receber todos os contatos compartilhados, envie uma solicitação HTTP GET para o URL do feed de contatos:

    GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION

    Substitua:

    • DOMAIN: o URL do seu domínio, por exemplo, example.com.
    • PROJECTION: o valor da projeção que especifica os elementos gd:extendedProperty. Para conferir uma lista de valores aceitos, 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. Confira a seguir um exemplo de um 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>

  2. O feed não retorna mais de 10 MB em uma única resposta. Para acessar a lista de contatos inteira, siga repetidamente o link Next do feed retornado até que ele não apareça mais no feed.

Receber contatos compartilhados usando parâmetros de consulta

Você pode solicitar um conjunto de contatos que correspondam a um critério especificado, como solicitar 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 conferir uma lista completa de parâmetros de consulta aceitos, consulte o Guia de referência da API Domain Shared Contacts.

  1. 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 seu domínio, por exemplo, example.com.
    • PROJECTION: o valor da projeção que especifica os elementos gd:extendedProperty. Para conferir uma lista de valores aceitos, consulte Valores de projeção.
    • PARAMETER: um dos parâmetros de consulta aceitos. Para mais informações, consulte o guia de referência da API Domain Shared Contacts.

    Por exemplo, para atualizar todas as entradas de contato compartilhadas do domínio após 16 de março de 2022 para example.com, envie uma solicitação HTTP para o URL do feed de contato 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 HTTP 200 OK e um feed contendo todos os contatos compartilhados do domínio que foram criados ou atualizados após a data especificada.

  2. O feed não retorna mais de 10 MB em uma única resposta. Para receber a lista de contatos inteira com os critérios especificados, siga repetidamente o link Next do feed retornado até que ele não apareça mais no feed de retorno.

Rastrear mudanças incrementais

Para acompanhar as mudanças incrementais em uma lista de contatos compartilhada de domínio, faça o seguinte: 1. Ao enviar uma solicitação para um feed, acompanhe o valor do elemento <updated> do feed. 1. Para receber apenas os contatos compartilhados do domínio que mudaram desde a solicitação anterior, defina o parâmetro de consulta updated-min como o valor <updated> e showdeleted como true.

Receber um único contato compartilhado

Para acessar um único contato compartilhado, use o link próprio dele. Só é possível encontrar o link próprio do contato compartilhado localizando a entrada dele no feed de contatos compartilhados. Se você não souber qual valor usar para o link próprio, consulte Pegar todos os contatos e Pegar contatos usando parâmetros de consulta.

  1. Para receber um contato compartilhado de domínio específico, envie uma solicitação HTTP GET para o link próprio de um contato: 
    GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION/:SELF_LINK>
     Substitua:
  • DOMAIN: o URL do seu domínio, por exemplo, example.com.
  • PROJECTION: o valor da projeção que especifica os elementos gd:extendedProperty. Para conferir uma lista de valores aceitos, consulte Valores de projeção.
  • SELF_LINK: um valor numérico exclusivo que representa um contato compartilhado, por exemplo, 12345.

O servidor retorna um código de status HTTP 200 OK e uma entrada contendo o contato.

Por exemplo, para receber um contato compartilhado de domínio com o link próprio 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

Próximas etapas