Obtenir les contacts partagés

Vous pouvez demander des contacts utilisateur partagés de différentes manières:

  • Tous les contacts partagés
  • Un ensemble de contacts correspondant à un critère spécifié
  • Un seul contact partagé
  • La photo d'un contact

Par défaut, les entrées d'un flux ne sont pas triées.

Récupérer tous les contacts partagés

  1. Pour obtenir tous les contacts partagés, envoyez une requête HTTP GET à l'URL du flux Contacts:

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

    Remplacez les éléments suivants :

    • DOMAIN: URL de votre domaine (par exemple, example.com).
    • PROJECTION: valeur de projection qui spécifie les éléments gd:extendedProperty. Pour obtenir la liste des valeurs acceptées, consultez la section Valeurs de projection.

    Le flux renvoie un code d'état HTTP 200 OK et un flux Atom 1.0 standard contenant les contacts. Voici un exemple de flux de contacts avec une seule entrée:

    <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. Le flux ne renvoie pas plus de 10 Mo dans une seule réponse. Pour obtenir la liste complète des contacts, cliquez plusieurs fois sur le lien Suivant du flux renvoyé jusqu'à ce qu'il n'apparaisse plus dans le flux de retour.

Obtenir des contacts partagés à l'aide de paramètres de requête

Vous pouvez demander un ensemble de contacts correspondant à un critère spécifié, par exemple demander des contacts mis à jour après une date donnée. Les requêtes en texte intégral et la localisation d'un contact par adresse e-mail ne sont pas prises en charge. Pour obtenir la liste complète des paramètres de requête acceptés, consultez le guide de référence de l'API Domain Shared Contacts.

  1. Envoyez une requête HTTP GET à l'URL du flux de contacts avec un paramètre défini:

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

    Remplacez les éléments suivants :

    • DOMAIN: URL de votre domaine (par exemple, example.com).
    • PROJECTION: valeur de projection qui spécifie les éléments gd:extendedProperty. Pour obtenir la liste des valeurs acceptées, consultez la section Valeurs de projection.
    • PARAMETER: l'un des paramètres de requête acceptés. Pour en savoir plus, consultez le guide de référence de l'API Domain Shared Contacts.

    Par exemple, pour mettre à jour toutes les entrées des contacts partagés du domaine après le 16 mars 2022 pour example.com, envoyez une requête HTTP à l'URL du flux de contacts partagés au sein du domaine et ajoutez-y le paramètre updated-min:

    GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00

    Lorsque vous envoyez cette requête GET, le serveur renvoie un code d'état HTTP 200 OK et un flux contenant tous les contacts partagés au sein du domaine qui ont été créés ou mis à jour après la date spécifiée.

  2. Le flux ne renvoie pas plus de 10 Mo dans une seule réponse. Pour obtenir la liste complète des contacts avec les critères spécifiés, suivez plusieurs fois le lien Suivant du flux renvoyé jusqu'à ce qu'il ne s'affiche plus dans le flux de retour.

Suivre les modifications incrémentielles

Pour suivre les modifications incrémentielles apportées à une liste de contacts partagée au niveau du domaine, procédez comme suit : 1. Lorsque vous envoyez une requête de flux, effectuez le suivi de la valeur de l'élément <updated> du flux. 1. Vous ne pouvez obtenir que les contacts partagés au sein du domaine qui ont été modifiés depuis la requête précédente. Pour ce faire, définissez le paramètre de requête updated-min sur cette valeur <updated> et définissez showdeleted sur true.

Obtenir un seul contact partagé

Pour obtenir un seul contact partagé, vous devez utiliser le lien auto du contact. Vous ne pouvez obtenir le lien auto du contact partagé qu'en recherchant son entrée dans le flux de contacts partagés. Si vous ne savez pas quelle valeur utiliser pour le lien auto, consultez Obtenir tous les contacts et Obtenir des contacts à l'aide de paramètres de requête.

  1. Pour obtenir un contact partagé spécifique au domaine, envoyez une requête HTTP GET au lien auto d'un contact : 
    GET https://www.google.com/m8/feeds/contacts/DOMAIN/PROJECTION/:SELF_LINK>
    Remplacez les éléments suivants:
  • DOMAIN: URL de votre domaine (par exemple, example.com).
  • PROJECTION: valeur de projection qui spécifie les éléments gd:extendedProperty. Pour obtenir la liste des valeurs acceptées, consultez la section Valeurs de projection.
  • SELF_LINK: valeur numérique unique représentant un seul contact partagé (par exemple, 12345).

Le serveur renvoie ensuite un code d'état HTTP 200 OK et une entrée contenant le contact.

Par exemple, pour obtenir un contact partagé au sein du domaine avec un lien auto défini sur https://www.google.com/m8/feeds/contacts/example.com/full/12345, envoyez la requête HTTP suivante:

GET https://www.google.com/m8/feeds/contacts/example.com/full/12345

Étapes suivantes