Introduction
Il est souvent utile pour les services qui utilisent les API Google Data afin de fournir un ensemble cohérent d'informations sur un type d'élément particulier.
Par exemple, divers services de l'API Google Data (ou "GData") peuvent fournir les coordonnées d'une personne ou d'une organisation. Il est logique que tous ces services utilisent le même ensemble d'éléments de coordonnées.
L'ensemble d'éléments décrivant un contact est appelé "genre". Certains éléments du genre Contact sont des éléments Atom ou RSS ordinaires. D'autres sont définis par Google dans un espace de noms appelé "Espace de noms Google Data". Par convention, l'espace de noms Google Data est généralement désigné par le code XML avec l'alias gd:
. Par exemple, l'élément contenant un numéro de téléphone ou de fax est <gd:phoneNumber>
. L'URL du schéma de l'espace de noms Google Data est http://schemas.google.com/g/2005.
Google définit également d'autres types d'événements: événement (ensemble d'éléments standardisés qui représentent un événement d'agenda) et Message (ensemble d'éléments représentant un e-mail, un message de groupe de discussion ou un autre message).
Certains éléments de l'espace de noms Google Data sont utilisés par plusieurs genres. Par exemple, l'élément <gd:who>
associe une personne (décrite dans <gd:who>
) à l'entrée contenant l'élément <gd:who>
. Cet élément est utilisé dans le genre d'événement pour spécifier des organisateurs, des participants, etc. Il est également utilisé dans le kind Message pour spécifier les expéditeurs et les destinataires.
Lorsqu'une entrée dans un flux d'API Google Data utilise un genre donné, elle contient un élément <atom:category>
avec son attribut scheme
défini sur "http://schemas.google.com/g/2005#kind"
et son attribut term
défini sur le nom de l'URL de schéma suivi du nom du genre. Par exemple, une entrée de contact inclut l'élément suivant:
<atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/>
Cela permet aux clients de déterminer rapidement et facilement le type de données que l'entrée contient, c'est-à-dire la sémantique de l'entrée. Si vous préférez, vous pouvez utiliser RSS à la place d'Atom. Consultez la documentation du protocole pour connaître les éléments RSS correspondant aux éléments Atom.
Ce document de référence présente certains genres courants et les éléments qu'ils contiennent.
Éléments non documentés
Nous n'incluons aucune information sur les éléments standards de <atom:entry>
dans les genres où ces éléments ont une signification standard. Par exemple, <atom:id>
, <atom:published>
et <atom:updated>
ont une signification standard lorsqu'ils apparaissent dans les genres.
Nous n'incluons également aucune information sur les éléments Atom standards qui seraient dénués de sens dans le contexte donné. Par exemple, <atom:summary>
n'est pas utilisé dans le kind du contact. Même si <atom:author>
est un élément obligatoire dans une entrée (sauf s'il est spécifié dans le flux parent), il n'a aucune signification utile dans le kind du contact.
Créer des genres
Il peut être difficile de déterminer avec précision les informations à inclure lorsque vous créez une entrée d'un kind donné, notamment parce que certains éléments des kinds contiennent d'autres kinds.
Une approche qui pourrait vous aider consiste à utiliser les bibliothèques clientes que nous fournissons plutôt que d'essayer de créer des genres à la main. Les bibliothèques clientes fournissent diverses méthodes pour ajouter et modifier des données dans une entrée d'un genre donné. Pour en savoir plus, consultez la documentation sur la bibliothèque cliente.
Extensibilité
Les informations contenues dans ce document ne couvrent pas toutes les propriétés et valeurs d'attribut possibles pour les genres. Les services peuvent étendre les genres. Un service particulier peut donc utiliser des propriétés et des valeurs non fournies dans ce document.
Conventions typographiques
Dans les tableaux de ce document, nous utilisons les conventions suivantes pour les éléments obligatoires et facultatifs:
Nom de l'élément | Élément requis |
élémentName ? | Élément facultatif |
élémentName* | Élément facultatif, plusieurs instances autorisées |
Les éléments et les attributs sont présentés en notation XPath standard.
Type de contact
Représente un contact: une personne, un lieu tel qu'un club, un restaurant ou une organisation.
Élément de catégorie : <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact"/>
Propriétés
Propriété | Description |
---|---|
atom:category * |
Catégories. Les instances comportant l'attribut @label sont traitées comme des tags. Pour en savoir plus sur l'utilisation de l'attribut @scheme , consultez la remarque au début de cette section. |
atom:content |
Notes sur le contact. |
atom:link * |
Liens vers des informations associées. Plus précisément, atom:link[@rel='alternate'] renvoie vers une page HTML décrivant le contact. |
atom:title |
Nom du contact. |
gd:email * |
Adresses e-mail. |
gd:im * |
Adresses IM. |
gd:phoneNumber * |
Numéros de téléphone et de fax |
gd:postalAddress * |
Adresses postales. |
gd:organization * |
Organisation |
gd:extendedProperty * |
Propriété étendue. |
gContact:groupMembershipInfo * |
Informations sur l'appartenance à un groupe. |
gd:deleted * |
État de contact supprimé. |
Exemples
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gd='http://schemas.google.com/g/2005'> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact'/> <title>Elizabeth Bennet</title> <content>My good friend, Liz. A little quick to judge sometimes, but nice girl.</content> <gd:email rel='http://schemas.google.com/g/2005#work' primary='true' address='liz@gmail.com'/> <gd:email rel='http://schemas.google.com/g/2005#home' address='liz@example.org'/> <gd:phoneNumber rel='http://schemas.google.com/g/2005#work' primary='true'> (206)555-1212 </gd:phoneNumber> <gd:phoneNumber rel='http://schemas.google.com/g/2005#home'> (206)555-1213 </gd:phoneNumber> <gd:phoneNumber rel='http://schemas.google.com/g/2005#mobile'> (206) 555-1212 </gd:phoneNumber> <gd:im rel='http://schemas.google.com/g/2005#home' protocol='http://schemas.google.com/g/2005#GOOGLE_TALK' address='liz@gmail.com'/> <gd:postalAddress rel='http://schemas.google.com/g/2005#work' primary='true'> 1600 Amphitheatre Pkwy Mountain View, CA 94043 </gd:postalAddress> <gd:postalAddress rel='http://schemas.google.com/g/2005#home'> 800 Main Street Mountain View, CA 94041 </gd:postalAddress> <gd:organization> <gd:orgName>Google, Inc.</gd:orgName> <gd:orgTitle>Tech Writer</gd:orgTitle> </gd:organization> </entry>
Type d'événement
Représente un événement d'agenda. Le lieu de l'événement est représenté par un genre de contact intégré (ou lié à partir) d'un élément <gd:where>
. Les organisateurs d'événements et les participants sont représentés par des genres de contacts intégrés (ou associés à) des éléments <gd:who>
.
Élément de catégorie : <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/>
Propriétés
Propriété | Description |
---|---|
atom:author |
Personne qui a créé cet événement. |
atom:category * |
Catégories. Les instances comportant l'attribut @label sont traitées comme des tags. Pour en savoir plus sur l'utilisation de l'attribut @scheme , consultez la remarque au début de cette section. |
atom:content |
Description plus longue de l'événement. |
atom:link * |
Liens : Plus précisément, atom:link[@rel='alternate'] fournit un lien vers une page HTML décrivant l'événement. |
atom:title |
Brève description de l'événement. |
gd:comments ? |
Flux de commentaires. |
gd:eventStatus ? |
Énumération extensible décrite ci-dessous. |
gd:recurrence ? |
Règle de récurrence. |
gd:transparency ? |
Énumération extensible documentée ci-dessous, correspondant à la propriété TRANSP définie dans la RFC 2445. |
gd:visibility ? |
Énumération extensible décrite ci-dessous. |
gd:when * |
Heure de l'événement Les attributs startTime et endTime doivent tous deux être définis. Toutefois, pour les événements d'une journée entière, ces attributs ne sont que des dates, sans heure. |
gd:when/gd:reminder * |
Rappels de l'événement. |
gd:where * |
Emplacement de l'événement ou services à proximité (parking, par exemple) Si un élément <gd:where> est spécifié au niveau du flux, mais qu'aucun élément <gd:where> n'est spécifié au niveau de l'entrée, les entrées héritent de la valeur <gd:where> au niveau du flux. |
gd:who * |
Personnes associées à l'événement: organisateur, participants, intervenants, artistes, etc. |
gd:who/gd:attendeeStatus ? |
État d'acceptation. |
gd:who/gd:attendeeType ? |
Type de participant : required ou optional . |
Valeurs rel pour gd:where
valeur rel | Description |
---|---|
http://schemas.google.com/g/2005#event ou non spécifié. |
Lieu de l'événement. |
http://schemas.google.com/g/2005#event.alternate |
Adresse secondaire. Par exemple, un site distant avec un lien de visioconférence vers le site principal. |
http://schemas.google.com/g/2005#event.parking |
Parking à proximité. |
Valeurs gd:eventStatus
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#event.canceled |
L'événement a été annulé. |
http://schemas.google.com/g/2005#event.confirmed |
L'événement est planifié. |
http://schemas.google.com/g/2005#event.tentative |
L'événement n'est proposé que de manière temporaire. |
Valeurs gd:visibility
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#event.confidential |
Autorisez certains lecteurs à voir l'événement. |
http://schemas.google.com/g/2005#event.default |
Hériter du comportement à partir des préférences du propriétaire de l'agenda dans lequel l'événement apparaît. |
http://schemas.google.com/g/2005#event.private |
Autorisez le moins de lecteurs à voir l'événement. |
http://schemas.google.com/g/2005#event.public |
Autorisez la plupart des lecteurs à voir l'événement. |
Valeurs gd:transparency
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#event.opaque |
Indique que l'événement consomme du temps dans l'agenda. L'heure de l'événement est marquée comme occupée dans une recherche de disponibilité. |
http://schemas.google.com/g/2005#event.transparent |
Indique que l'événement ne consomme pas de temps dans l'agenda. L'heure de l'événement n'est pas marquée comme occupée dans une recherche de disponibilité. |
Exemples
Réunion:
<entry xmlns:gd="http://schemas.google.com/g/2005"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/> <id>http://mycal.example.com/feeds/jo/home/full/e1a2af06df8a563edf9d32ec9fd61e03f7f3b67b</id> <published>2005-01-18T21:00:00Z</published> <updated>2006-01-01T00:00:00Z</updated> <title>Discuss BazMat API</title> <content>We will discuss integrating GData with BazMat.</content> <author> <name>Jo March</name> <email>jo@example.com</email> </author> <gd:when startTime='2005-01-18T21:00:00Z' endTime='2005-01-18T22:00:00Z'> <gd:reminder minutes='15'/> </gd:when> <gd:where valueString='Building 41, Room X'/> <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/> <gd:visibility value="http://schemas.google.com/g/2005#event.public"/> <gd:transparency value="http://schemas.google.com/g/2005#event.transparent"/> </entry>
Événement en ligne:
<entry xmlns:gd="http://schemas.google.com/g/2005"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/> <id>http://mycal.example.com/feeds/jo/home/full/982307e797979879a</id> <published>2005-01-18T21:00:00Z</published> <updated>2006-01-01T00:00:00Z</updated> <title>Online Chess Tournament</title> <content/> <author> <name>Jo March</name> <email>jo@example.com</email> </author> <gd:when startTime='2006-01-24T19:00:00-08:00' endTime='2006-01-24T20:00:00-08:00'> <gd:reminder minutes='15'/> </gd:when> <gd:where> <gd:entryLink> <entry> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/> <id>http://contacts.example.com/jo/GamePhannz</id> <published>2005-01-18T21:00:00Z</published> <updated>2006-01-01T00:00:00Z</updated> <title>GamePhannz Online Game Server</title> <link rel="http://schemas.google.com/g/2005#onlineLocation" type="text/html" href="http://gamephannz.example.com/chess/138fd87e"/> <content/> </entry> </gd:entryLink> </gd:where> <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/> <gd:visibility value="http://schemas.google.com/g/2005#event.public"/> <gd:transparency value="http://schemas.google.com/g/2005#event.transparent"/> </entry>
Type de message
Représente un message, tel qu'un e-mail, un post de groupe de discussion ou un commentaire.
Élément de catégorie: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message"/>
Propriétés
Propriété | Description |
---|---|
atom:category * |
Catégories. Les instances comportant l'attribut @label sont traitées comme des tags. Pour en savoir plus sur l'utilisation de l'attribut @scheme , consultez la remarque au début de cette section. Pour en savoir plus sur l'utilisation de l'attribut @term , consultez le tableau ci-dessous. |
atom:content |
Corps du message. |
atom:link * |
Pièces jointes aux messages. Plus précisément, pour importer une pièce jointe, utilisez <link rel="enclosure"> et placez le contenu de la pièce jointe dans une collection multimédia Atom. |
atom:title |
Objet du message. |
gd:geoPt ? |
Emplacement géographique depuis lequel le message a été publié. |
gd:rating ? |
Niveau de qualité (tel que défini par l'application) |
gd:who * |
Personnes associées à ce message. La sémantique exacte dépend de la valeur @rel . Consultez le tableau ci-dessous. |
Valeurs de la catégorie @term
Toutes les catégories ci-dessous appartiennent au schéma http://schemas.google.com/g/2005
.
Terme | Description |
---|---|
http://schemas.google.com/g/2005#message.chat |
Le message est une transcription d'une session de chat. |
http://schemas.google.com/g/2005#message.inbox |
Le message est alors marqué comme appartenant à la boîte de réception. |
http://schemas.google.com/g/2005#message.sent |
Le message est marqué comme envoyé. |
http://schemas.google.com/g/2005#message.spam |
Le message est considéré comme du spam. |
http://schemas.google.com/g/2005#message.starred |
Le message est marqué comme suivi. |
http://schemas.google.com/g/2005#message.unread |
Le message n'est pas lu. |
Valeurs rel pour gd:who
Propriété | Description |
---|---|
http://schemas.google.com/g/2005#message.bcc |
Destinataire du Cci des messages |
http://schemas.google.com/g/2005#message.cc |
Destinataire du message de message. |
http://schemas.google.com/g/2005#message.from |
Expéditeur du message (e-mail ou messagerie instantanée) |
http://schemas.google.com/g/2005#message.reply-to |
Destinataire prévu d'un message de réponse. |
http://schemas.google.com/g/2005#message.to |
Destinataire principal du message. |
Exemple
E-mail:
<entry xmlns:gd="http://schemas.google.com/g/2005"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message"/> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message.sent"/> <author> <name>Jo March</name> <email>jo@example.com</email> </author> <id>http://mymail.example.com/feeds/jo/home/full/e1a2af06df8a563edf9d32ec9fd61e03f7f3b67b</id> <published>2006-01-18T21:00:00Z</published> <updated>2006-01-18T21:00:00Z</updated> <title>Re: Info?</title> <content>Hi, Fritz -- The information you're looking for is on p. 47.</content> <gd:who rel="http://schemas.google.com/g/2005#message.from"> <gd:entryLink href="http://contacts.example.com/jo/Jo"/> </gd:who> <gd:who rel="http://schemas.google.com/g/2005#message.to"> <gd:entryLink href="http://contacts.example.com/fritzb/FritzB"/> </gd:who> </entry>
Documentation de référence sur les éléments de l'espace de noms Google Data
Le reste de ce document contient des documents de référence sur les éléments utilisés par les genres.
- Énumérations
- gdCommonProperties
- gd:commentaires
- gd:supprimé
- gd:e-mail
- gd:entryLink.
- gd:extendedProperty
- gd:fluxLien
- gd:geoPt
- gd:im
- gd:organisation
- gd:orgName
- gd:orgTitle
- gd:originalEvent
- gd:numérodetéléphone
- gd:adresse postale
- gd:note
- gd:récurrence
- gd:recurrenceException.
- gd:rappel
- gd:quand
- gd:où
- gd:qui
Enums
Certains éléments d'extension doivent spécifier des propriétés dont les valeurs proviennent d'un ensemble énuméré. La forme générale de ces propriétés est la suivante:
<gd:propertyName value="propertyValue">
Si la valeur de la propriété provient de l'espace de noms Google Data, elle se présente sous la forme http://schemas.google.com/g/2005#
{kind}.
{value}. Par exemple : http://schemas.google.com/g/2005#event.tentative
. Si l'espace de valeur est extensible, les valeurs peuvent également se présenter sous la forme d'un URI. La forme recommandée pour les URI à valeur étendue est {schema URI}#
{value}. Exemple : http://www.example.com/attendeeStatus#AudioConference
.
gEnumConstruct = attribute value { text }, anyAttribute*
gdCommonProperties
Propriétés courantes utilisées pour tous les types Google. Notez que la présence de anyAttribute
et anyElement
dans le schéma permet d'étendre davantage tous les éléments d'espace de noms Google Data utilisant des propriétés communes dans n'importe quel espace de noms. En particulier, il est légal d'imbriquer tout élément gd ou Atom/RSS dans un autre élément gd. Cette opération doit être effectuée judicieusement, et dans la plupart des cas, cette utilisation doit être documentée en tant que propriété explicite du type d'élément gd qui le contient.
Propriétés
Propriété | Type | Description |
---|---|---|
@xml:base |
uri |
Construction XML standard permettant de décrire la base des URI relatifs imbriqués. |
@xml:lang |
text |
Langue des chaînes imbriquées. |
Schéma
namespace gd = "http://schemas.google.com/g/2005" gdCommonProperties = { atomCommonAttributes, anyAttribute*, (anyElement*) }
gd:commentaires
Contient un flux de commentaires pour l'entrée englobante (un événement d'agenda, par exemple).
Propriétés
Propriété | Type | Description |
---|---|---|
@rel ? |
string |
Type de commentaire contenu dans. Il existe actuellement une distinction entre les commentaires et les avis standards. |
gd:feedLink ? |
feedLink |
Flux de commentaires. Ce flux doit implémenter le genre Message. |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#regular ou non spécifié |
Commentaires réguliers (provenant des utilisateurs) |
http://schemas.google.com/g/2005#reviews |
Avis de professionnels. |
Exemples
Flux de commentaires:
<gd:comments> <gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10"> <feed> <id>http://example.com/Jo/posts/MyFirstPost/comments</id> <title>My first post: comments</title> ... <entry> ... <content>Good post.</content> </entry> <entry> ... </entry> ... </feed> </gd:feedLink> </gd:comments>
Flux d'avis:
<gd:comments rel="http://schemas.google.com/g/2005#reviews"> <gd:feedLink href="http://example.com/restaurants/SanFrancisco/432432/reviews" countHint="25"> <feed> <id>http://example.com/restaurants/SanFrancisco/432432/reviews</id> <title>La Folie reviews</title> ... <entry> ... <content>Good food.</content> <gd:rating value="5" min="1" max="5"/> </entry> <entry> ... </entry> ... </feed> </gd:feedLink> </gd:comments>
Schéma
start = comments comments = element gd:comments { gdCommonProperties, attribute rel { xs:string }?, (feedLink?) }
gd:supprimé
Un élément de repère, s'il est présent, indique que l'entrée associée a été supprimée.
Propriétés
Aucune.
Schéma
start = deleted deleted = element gd:deleted
gd:e-mail
Adresse e-mail associée à l'entité hôte (généralement une entité représentant une personne ou un lieu).
Propriétés
Propriété | Type | Description |
---|---|---|
@address |
xs:string |
Adresse e-mail. |
@label ? |
xs:string |
Valeur de chaîne simple utilisée pour nommer cette adresse e-mail. Elle permet aux interfaces utilisateur d'afficher un libellé tel que "Travail", "Personnel", "À privilégier", etc. |
@rel ? |
xs:string |
Valeur programmatique qui identifie le type d'e-mail (voir ci-dessous pour en savoir plus). |
@primary ? |
xs:boolean |
Lorsque plusieurs extensions d'adresse e-mail apparaissent dans un type de contact, laquelle est celle qui est principale. Une adresse e-mail peut être principale. La valeur par défaut est "false" . |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#home |
|
http://schemas.google.com/g/2005#other |
Une adresse e-mail qui ne correspond ni à votre domicile, ni à votre lieu de travail. label peut être utilisé pour indiquer le type réel. |
http://schemas.google.com/g/2005#work |
Exemples
<gd:email address="foo@bar.example.com"/> <gd:email label="Personal" rel="http://schemas.google.com/g/2005#home" address="fubar@gmail.com" primary="true"/>
Schéma
start = email email = element gd:email { attribute address { xs:string }, attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }? }
gd:entryLink
Représente une entrée imbriquée logiquement. Par exemple, un <gd:who>
représentant un contact peut avoir une entrée imbriquée à partir d'un flux de contacts.
Propriétés
Propriété | Type | Description |
---|---|---|
@href ? |
xs:string |
Spécifie l'URI d'entrée. Si l'entrée imbriquée est intégrée et non associée, cet attribut peut être omis. |
@readOnly ? |
xs:boolean |
Indique si l'entrée contenue est en lecture seule. La valeur par défaut est "false" . |
@rel ? |
xs:string |
Spécifie la relation de lien ; permet au service de fournir plusieurs types de liens d'entrée pour une seule entité. Il présente la même sémantique et les mêmes valeurs autorisées que l'attribut rel de l'élément <atom:link> . |
atom:entry ? |
atomEntry |
Contenu de l'entrée. |
Restrictions
@href
ou<atom:entry>
doivent être présents.- Si
atom:entry
n'est pas présent, le client peut récupérer le contenu à partir de l'URI d'entrée dans@href
. Siatom:entry
est présent, le contenu doit être identique à celui extrait de@href
au moment de la création de l'entrée. - Lorsqu'un élément
PUT
ouPOST
contient une valeur<gd:entryLink>
et que l'attribut@href
est spécifié, la valeur de l'attribut est utilisée pour créer un lien. Si l'élémentatom:entry
est également présent, il est ignoré. Si l'attribut@href
n'est pas spécifié, l'élémentatom:entry
est soit stocké en tant qu'entrée intégrée, soit stocké dans un autre flux et associé. Notez que certains services peuvent ne pas être compatibles avec toutes ces options.
Exemples
Coordonnées dans <gd:who>
:
<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo"> <gd:entryLink href="http://gmail.com/jo/contacts/Jo"> <entry> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/> <id>http://gmail.com/jo/contacts/Jo</id> <category term="user-tag" label="Google"/> <title>Jo March</title> <gd:email address="jo@example.com"/> <gd:phoneNumber label="work">(650) 555-1212</gd:phoneNumber> </entry> </gd:entryLink> </gd:who>
Référence externe uniquement (entrée en lecture seule):
<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo"> <gd:entryLink href="http://gmail.com/jo/contacts/Jo" readOnly="true"/> </gd:who>
Schéma
start = entryLink entryLink = element gd:entryLink { attribute href { xs:string }?, attribute readOnly { xs:boolean }?, (atomEntry?) }
gd:extendedProperty
Permet de stocker une quantité limitée de données personnalisées en tant que propriété auxiliaire de l'entité englobante.
Notez que la présence de anyForeignElement
permet au flux d'intégrer éventuellement n'importe quel XML valide dans l'élément gd:extendedProperty
(mutuellement exclusif avec l'attribut value
).
Propriétés
Propriété | Type | Description |
---|---|---|
@name |
xs:string |
Spécifie le nom de la propriété, exprimé en tant qu'URI. Les URI de propriété étendue respectent généralement la convention {scheme}#{local-name}. |
@value ? |
xs:string |
Valeur de la propriété. |
Exemple
Un identifiant externe pour un événement d'agenda:
<gd:extendedProperty name="http://www.example.com/schemas/2007#mycal.id" value="1234"></gd:extendedProperty>
Fichier XML supplémentaire pour la saisie du contact
<gd:extendedProperty name="com.google"> <some_xml>value</some_xml> </gd:extendedProperty>
Schéma
start = extendedProperty extendedProperty = element gd:extendedProperty { attribute name { xs:string }, attribute value { xs:string } ?, (anyForeignElement*) }
gd:lienflux
Représente un flux imbriqué de manière logique. Par exemple, un flux d'agenda peut comporter un flux imbriqué représentant tous les commentaires publiés sur des entrées.
Propriétés
Propriété | Type | Description |
---|---|---|
@countHint ? |
xs:unsignedInt |
Indique le nombre d'entrées dans le flux. Selon l'implémentation, il peut ne pas s'agir d'un décompte précis. |
@href ? |
xs:string |
Spécifie l'URI du flux. Si le flux imbriqué est intégré et n'est pas associé, cet attribut peut être omis. |
@readOnly ? |
xs:boolean |
Indique si le flux contenu est en lecture seule. |
@rel ? |
xs:string |
Spécifie la relation de lien. Permet au service de fournir plusieurs types de liens de flux pour une seule entité. Il présente la même sémantique et les mêmes valeurs autorisées que l'attribut rel de l'élément <atom:link> . |
atom:feed ? |
atomFeed |
Contenu du flux. |
Restrictions
@href
ou<atom:feed>
doivent être présents.- Si
atom:feed
n'est pas présent, le client peut récupérer le contenu à partir de l'URI dans@href
. S'il est présent, le contenu doit être identique à celui récupéré dans@href
au moment de la création du flux. - Lorsqu'une requête PUT ou POST contient une valeur
<gd:feedLink>
et que l'attribut@href
est spécifié, la valeur de l'attribut est utilisée pour créer un lien. Si l'élément<atom:feed>
est également présent, il est ignoré. Si l'attribut@href
n'est pas spécifié, l'élément<atom:feed>
est stocké en tant que flux intégré. Notez que certains services peuvent ne pas être compatibles avec toutes ces options.
Exemples
Blogs:
<gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10"> <feed> <id>http://example.com/Jo/posts/MyFirstPost/comments</id> <title>My first post: comments</title> ... <entry> ... <content>Good post.</content> </entry> <entry> ... </entry> ... </feed> </gd:feedLink>
Référence externe uniquement:
<gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10"/>
Flux intégré dans une entrée Atom représentant une liste:
<gd:feedLink> <feed> <id>cid:1</id> <entry> <id>cid:1.1</id> <content>list item 1</content> </entry> <entry> <id>cid:1.2</id> <content>list item 2</content> </entry> </feed> </gd:feedLink>
Schéma
start = feedLink feedLink = element gd:feedLink { attribute href { xs:string }?, attribute readOnly { xs:boolean }?, attribute countHint { xs:unsignedInt }?, (atomFeed?) }
gd:geoPt
Emplacement géographique (latitude, longitude, altitude).
Obsolète. Cet élément est obsolète. Pour les données de géomarquage, utilisez plutôt GeoRSS.
Propriétés
Propriété | Type | Description |
---|---|---|
@elev ? |
xs:float |
Altitude en mètres. Les valeurs négatives indiquent les profondeurs inférieures au niveau moyen de la mer. |
@label ? |
xs:string |
Valeur de chaîne simple utilisée pour nommer cet emplacement. Elle permet aux interfaces utilisateur d'afficher un libellé tel que "Position actuelle". |
@lat |
xs:float |
Latitude en degrés. Les valeurs positives correspondent au nord, tandis que les valeurs négatives correspondent au sud. La plage est [-90.0, 90.0]. |
@lon |
xs:float |
Longueur en degrés. Les valeurs positives correspondent à "Est", et les valeurs négatives à "Ouest". La plage est [-180.0, 180.0]. |
@time ? |
xs:dateTime |
Timestamp. |
Exemples
<gd:geoPt lat="40.75" lon="-74.0"/>
<gd:geoPt lat="27.98778" lon="86.94444" elev="8850.0"/>
Schéma
start = geoPt geoPt = element gd:geoPt { attribute label { xs:string }?, attribute lat { xs:float }, attribute lon { xs:float }, attribute elev { xs:float }?, attribute time { xs:dateTime }? }
gd:im
Adresse de messagerie instantanée associée à l'entité hôte.
Propriétés
Propriété | Type | Description |
---|---|---|
@address |
xs:string |
Adresse e-mail de messagerie instantanée |
@label ? |
xs:string |
Valeur de chaîne simple utilisée pour nommer cette adresse de messagerie instantanée. Elle permet aux interfaces utilisateur d'afficher un libellé tel que "Travail", "Personnel", "À privilégier", etc. |
@rel ? |
xs:string |
Valeur programmatique qui identifie le type de gestionnaire d'inventaire (voir ci-dessous pour plus de détails). |
@protocol ? |
xs:string |
Identifie le réseau de messagerie instantanée. Il peut s'agir de l'une des valeurs standards (illustrées ci-dessous) ou d'un URI identifiant un réseau de messagerie instantanée propriétaire. |
@primary ? |
xs:boolean |
Lorsque plusieurs extensions de messagerie instantanée apparaissent dans un genre de contact, celle qui est principale est indiquée. Un seul gestionnaire d'inventaire peut être principal. La valeur par défaut est "false" . |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#home |
|
http://schemas.google.com/g/2005#other |
Une adresse de messagerie instantanée qui n'est ni personnelle ni professionnelle. label peut être utilisé pour indiquer le type réel. |
http://schemas.google.com/g/2005#work |
valeurs d'attribut de protocole
Le tableau suivant présente quelques valeurs possibles possibles pour l'attribut @protocol.
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#AIM |
Protocole AOL Instant Messenger |
http://schemas.google.com/g/2005#MSN |
Protocole MSN Messenger |
http://schemas.google.com/g/2005#YAHOO |
Protocole Yahoo Messenger |
http://schemas.google.com/g/2005#SKYPE |
Protocole Skype |
http://schemas.google.com/g/2005#QQ |
Protocole QQ |
http://schemas.google.com/g/2005#GOOGLE_TALK |
Protocole Google Talk |
http://schemas.google.com/g/2005#ICQ |
Protocole ICQ |
http://schemas.google.com/g/2005#JABBER |
Protocole Jabber |
Exemples
Adresse IM pour MSN Messenger:
<gd:im protocol="http://schemas.google.com/g/2005#MSN" address="foo@bar.msn.com" rel="http://schemas.google.com/g/2005#home" primary="true"/>
Adresse IM fournie par l'utilisateur avec un protocole non spécifié. Cette adresse est utile à des fins d'affichage, mais elle est difficile à gérer à l'aide d'un programme.
<gd:im label="Other" address="foo@baz.example.com"/>
Schéma
start = im im = element gd:im { attribute address { xs:string }, attribute label { xs:string }?, attribute rel { xs:string }?, attribute protocol { xs:string }?, attribute primary { xs:boolean }? }
gd:organisation
Organisation, généralement associée à un contact.
Propriétés
Propriété | Type | Description |
---|---|---|
@label ? |
xs:string |
Valeur de chaîne simple utilisée pour nommer cette organisation. Il permet aux UI d'afficher un libellé tel que "Travail", "Bénévole", "Société professionnelle", etc. |
@rel ? |
xs:string |
Valeur programmatique qui identifie le type d'organisation. |
@primary ? |
xs:boolean |
Lorsque plusieurs extensions d'organisation apparaissent dans un genre de contact, celle-ci indique l'extension principale. Une organisation peut être principale. La valeur par défaut est "false" . |
gd:orgName ? |
orgName |
Nom de l'organisme. |
gd:orgTitle ? |
orgTitle |
Fonction d'un membre de l'organisation. |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#other |
Une organisation qui ne fonctionne pas label peut être utilisé pour indiquer le type réel. |
http://schemas.google.com/g/2005#work |
Exemples
<gd:organization rel="http://schemas.google.com/g/2005#work" label="Work" primary="true"/> <gd:orgName>Google, Inc.</gd:orgName> <gd:orgTitle>Tech Writer</gd:orgTitle> </gd:organization>
Schéma
start = organzation organization = element gd:organization { attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }? orgName?, orgTitle?, }
gd:orgName
Nom de l'organisme. Doit figurer dans un élément gd:organization
.
Exemple
<gd:orgName>Google, Inc.</gd:orgName>
Schéma
start = orgName orgName = element gd:orgName { xs:string }
gd:orgTitre
Fonction d'un membre d'une organisation. Doit figurer dans un élément gd:organization
.
Exemple
<gd:orgTitle>President and CEO</gd:orgTitle>
Schéma
start = orgTitle orgTitle = element gd:orgTitle { xs:string }
gd:événementd'origine
Équivaut à la propriété de l'ID de récurrence spécifiée dans la section 4.8.4.4 de la RFC 2445. S'affiche dans chaque instance d'un événement périodique pour identifier l'événement d'origine.
Contient un élément <gd:when>
spécifiant l'heure de début d'origine de l'instance devenue une exception.
Propriétés
Propriété | Type | Description |
---|---|---|
@id |
xs:string |
ID de l'événement d'origine. |
@href |
xs:string |
URL du flux de l'événement d'origine |
Exemple
Spécifier un événement d'origine:
<gd:originalEvent id="i8fl1nrv2bl57c1qgr3f0onmgg" href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID"> <gd:when startTime="2006-03-17T22:00:00.000Z"/>
</gd:originalEvent>
Schéma
start = originalEvent originalEvent = element gd:originalEvent { attribute id { xs:string }, attribute href { xs:string }, when }
gd:numérodetéléphone
Numéro de téléphone associé à l'entité hôte (généralement une entité représentant une personne ou un lieu).
Propriétés
Propriété | Type | Description |
---|---|---|
@label ? |
xs:string |
Valeur de chaîne simple utilisée pour nommer ce numéro de téléphone. Dans la plupart des cas, @label n'est pas nécessaire, car @rel identifie de manière unique un nombre et permet aux interfaces utilisateur d'afficher un libellé approprié, tel que "Mobile", "Domicile", "Travail", etc. Toutefois, dans le cas où une personne possède (par exemple) plusieurs téléphones mobiles, cette propriété peut être utilisée pour faire la distinction. |
@rel ? |
xs:string |
Valeur programmatique qui identifie le type de numéro de téléphone (voir détails ci-dessous). |
@uri ? |
xs:string |
Un "tel URI" facultatif permettant de représenter le numéro de manière formelle, utile pour l'accès programmatique, comme un pont VoIP/PSTN. Pour en savoir plus sur les URI tels que, consultez la RFC 3966. |
@primary ? |
xs:boolean |
Lorsque plusieurs extensions de numéro de téléphone apparaissent dans un genre de contact, celle qui est principale est indiquée. Vous ne pouvez indiquer qu'un seul numéro de téléphone principal. La valeur par défaut est "false" . |
text() |
xs:string |
Numéro de téléphone lisible dans n'importe quel format de numéro de téléphone. Les espaces de début et de fin sont insignifiants. Les sauts de ligne dans la chaîne sont également insignifiants et peuvent être supprimés ou aplatis pour former un seul espace. |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#fax |
|
http://schemas.google.com/g/2005#home |
|
http://schemas.google.com/g/2005#home_fax |
|
http://schemas.google.com/g/2005#mobile |
|
http://schemas.google.com/g/2005#other |
Type de nombre spécial pour lequel aucune autre valeur rel n'a de sens. (par exemple, un appareil TTY). label peut être utilisé pour indiquer le type réel. |
http://schemas.google.com/g/2005#pager |
|
http://schemas.google.com/g/2005#work |
|
http://schemas.google.com/g/2005#work_fax |
Exemples
Numéro de téléphone simple saisi par un utilisateur:
<gd:phoneNumber>(425) 555-8080 ext. 72585</gd:phoneNumber>
Même numéro de téléphone extrait d'un annuaire:
<gd:phoneNumber rel="http://schemas.google.com/g/2005#work" uri="tel:+1-425-555-8080;ext=52585"> (425) 555-8080 ext. 52585 </gd:phoneNumber>
Numéro associé à un libellé:
<gd:phoneNumber rel="http://schemas.google.com/g/2005#mobile" label="Personal calls only" uri="tel:+12065551212"> +1 206 555 1212 </gd:phoneNumber>
Schéma
start = phoneNumber phoneNumber = element gd:phoneNumber { attribute rel { xs:string }?, attribute label { xs:string }?, attribute uri { xs:string }?, attribute primary { xs:boolean }?, (xs:string) }
gd:adresse postale
Adresse postale.
Propriétés
Propriété | Type | Description |
---|---|---|
@label ? |
xs:string |
Valeur de chaîne simple utilisée pour nommer cette adresse. |
@rel ? |
xs:string |
Valeur programmatique qui identifie le type d'adresse postale (voir ci-dessous pour en savoir plus). |
@primary ? |
xs:boolean |
Lorsque plusieurs extensions d'adresse postale apparaissent dans un type de contact, cette valeur indique l'adresse principale. Vous ne pouvez indiquer qu'une seule adresse postale principale. La valeur par défaut est "false" . |
text() |
xs:string |
Adresse sous forme de texte. Les espaces de début et de fin sont insignifiants. Les sauts de ligne dans la chaîne sont importants. |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#home |
|
http://schemas.google.com/g/2005#other |
Adresse qui ne correspond ni à votre domicile, ni à votre lieu de travail label peut être utilisé pour indiquer le type réel. |
http://schemas.google.com/g/2005#work |
Exemples
<gd:postalAddress> 500 West 45th Street New York, NY 10036 </gd:postalAddress>
Schéma
start = postalAddress postalAddress = element gd:postalAddress { attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }?, (xs:string) }
gd:note
Représente une note numérique de l'entité englobante, comme un commentaire. Chaque note fournit sa propre échelle de notation, bien qu'elle puisse être normalisée par un service. Par exemple, certains services peuvent convertir toutes les notes en une échelle de 1 à 5.
Propriétés
Propriété | Type | Description |
---|---|---|
@average ? |
xs:float |
Note moyenne. |
@max |
xs:int |
Valeur maximale de l'échelle d'évaluation. |
@min |
xs:int |
Valeur minimale de l'échelle d'évaluation. |
@numRaters ? |
xs:int |
Nombre de notes prises en compte lors du calcul de la valeur moyenne. |
@rel ? |
xs:string |
Spécifie l'aspect évalué. Si elle n'est pas spécifiée, la note est une note globale. |
@value ? |
xs:int |
Valeur de la note. |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#overall ou non spécifié |
Note globale Plus la valeur est élevée, meilleure est la note. |
http://schemas.google.com/g/2005#price |
Avis sur le prix. Plus la valeur est élevée, plus les prix sont élevés. |
http://schemas.google.com/g/2005#quality |
Niveau de qualité. Plus la valeur est élevée, meilleure est la qualité. |
Exemples
Note globale : 4/5
<gd:rating value="4" min="1" max="5"/>
Note sur la gamme de prix la plus chère:
<gd:rating rel="http://schemas.google.com/g/2005#price" value="5" min="1" max="5"/>
Notée par 200 utilisateurs, avec une note moyenne de 4,65 sur 5:
<gd:rating average="4.65" min="1" max="5" numRaters="200"/>
Schéma
start = rating rating = element gd:rating { gdCommonProperties, attribute rel { xs:string }?, attribute value { xs:int }?, attribute average { xs:float }?, attribute min { xs:int }, attribute max { xs:int }, attribute numRaters { xs:int }? }
gd:récurrence
Représente les dates et heures d'un événement périodique.
La chaîne qui définit la récurrence se compose d'un ensemble de propriétés, chacune étant définie dans la norme iCalendar (RFC 2445).
Plus précisément, la chaîne commence généralement par une propriété DTSTART qui indique l'heure de début de la première instance de l'événement, et souvent une propriété DTEND ou une propriété DURATION pour indiquer la fin de la première instance. Vient ensuite les propriétés RRULE, RDATE, EXRULE et/ou EXDATE, qui définissent collectivement un événement périodique et ses exceptions (voir ci-dessous). Pour en savoir plus sur ces propriétés, consultez la section 4.8.5 de la RFC 2445. Enfin, un composant VTIMEZONE fournit des règles de fuseau horaire détaillées pour tout ID de fuseau horaire mentionné dans les propriétés précédentes.
Les services Google tels que Google Agenda ne génèrent généralement pas de propriétés EXRULE et EXDATE pour représenter des exceptions aux événements périodiques. Au lieu de cela, ils génèrent des éléments <gd:recurrenceException>
. Toutefois, les services Google peuvent tout de même inclure des propriétés EXRULE et/ou EXDATE. Par exemple, les utilisateurs peuvent importer des événements et des exceptions dans Agenda. Si ces événements contiennent des propriétés EXRULE ou EXDATE, Agenda fournira ces propriétés lors de l'envoi d'un élément <gd:recurrence>
.
Notez que l'utilisation de <gd:recurrenceException>
signifie qu'il n'est pas possible simplement d'examiner un élément <gd:recurrence>
s'il existe des exceptions à la description de la récurrence. Pour vous assurer de trouver toutes les exceptions, recherchez des éléments <gd:recurrenceException>
dans le flux et utilisez leurs éléments <gd:originalEvent>
pour les mettre en correspondance avec des éléments <gd:recurrence>
.
Propriétés
Propriété | Type | Description |
---|---|---|
text() |
xs:string |
Description de la récurrence. |
Exemple
Un événement récurrent a lieu tous les matins de 6 h à 7 h. Pacifique, du 14 au 21 mars 2006:
<gd:recurrence> DTSTART;TZID=America/Los_Angeles:20060314T060000 DURATION:PT3600S RRULE:FREQ=DAILY;UNTIL=20060321T220000Z BEGIN:VTIMEZONE TZID:America/Los_Angeles X-LIC-LOCATION:America/Los_Angeles BEGIN:STANDARD TZOFFSETFROM:-0700 TZOFFSETTO:-0800 TZNAME:PST DTSTART:19671029T020000 RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU END:STANDARD BEGIN:DAYLIGHT TZOFFSETFROM:-0800 TZOFFSETTO:-0700 TZNAME:PDT DTSTART:19870405T020000 RRULE:FREQ=YEARLY;BYMONTH=4;BYDAY=1SU END:DAYLIGHT END:VTIMEZONE </gd:recurrence>
Schéma
start = recurrence recurrence = element gd:recurrence { (xs:string) }
gd:recurrenceException
Représente un événement qui constitue une exception à un événement périodique, c'est-à-dire une occurrence d'un événement périodique au cours duquel un ou plusieurs aspects de l'événement périodique (liste de présence, heure ou lieu, par exemple) ont été modifiés.
Contient un élément <gd:originalEvent>
qui spécifie l'événement périodique d'origine auquel cet événement est une exception.
Lorsque vous modifiez une instance d'un événement périodique, cette instance devient une exception. En fonction de la modification apportée, l'exception se comporte de deux manières lorsque l'événement périodique d'origine est modifié:
- Si vous ajoutez, modifiez ou supprimez des commentaires, des participants ou des réponses aux participants, l'exception reste liée à l'événement d'origine et toute modification apportée à l'événement d'origine modifie également l'exception.
- Si vous apportez d'autres modifications à l'exception (comme l'heure ou le lieu), l'instance devient "spécialisée", ce qui signifie qu'elle n'est plus aussi étroitement liée à l'événement d'origine. Si vous modifiez l'événement d'origine, les exceptions spéciales ne changent pas. Voir ci-dessous.
Par exemple, imaginons que vous organisiez une réunion tous les mardis et jeudis à 14 h. Si vous modifiez la liste de participation pour cette réunion de jeudi, mais pas pour la réunion planifiée, cela devient une exception. Si vous modifiez l'heure de la réunion de jeudi, mais pas celle de la réunion planifiée, elle se spécialise.
Que l'exception soit spécialisée ou non, si vous effectuez une action qui supprime l'instance d'où elle provient, elle est supprimée. Notez que la modification du jour ou de l'heure d'un événement périodique supprime toutes les instances et en crée d'autres.
Par exemple, une fois que vous aurez réservé la réunion de jeudi, vous allez modifier la réunion périodique pour qu'elle ait lieu le lundi, le mercredi et le vendredi. Cette modification supprime toutes les instances récurrentes de la réunion du mardi/jeudi.
Si une instance particulière d'un événement périodique est supprimée, cette instance apparaît sous la forme d'un <gd:recurrenceException>
contenant un <gd:entryLink>
dont le <gd:eventStatus>
est défini sur "http://schemas.google.com/g/2005#event.canceled"
. (Pour plus d'informations sur les événements annulés, consultez le document RFC 2445.)
Propriétés
Propriété | Type | Description |
---|---|---|
@specialized |
xs:boolean |
Indique si l'exception est spécialisée ou non. |
gd:entryLink |
entryLink |
Une entrée "Event" fournissant des détails sur l'exception |
gd:originalEvent |
originalEvent |
Événement récurrent d'origine auquel il s'agit d'une exception. |
Exemple
Exception à un événement périodique : pour plus de clarté, certains éléments sont remplacés par de brefs identifiants en italique :
<gd:recurrenceException specialized="true"> <gd:entryLink> <entry> <id>i8fl1nrv2bl57c1qgr3f0onmgg_20060317T220000Z</id> <published>2006-03-17T23:00:00.000Z</published> <updated>2006-03-14T21:33:12.000Z</updated> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/> <title type="text">recurrence</title> <content type="text"/> <link rel="alternate" type="text/html" href="http://www.google.com/calendar/event?eid=idString" title="alternate"/> <author> <name>exception</name> </author> <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/> <gd:comments> <gd:feedLink href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID/comments/"> <feed> <updated>2006-03-14T21:36:23.250Z</updated> <title type="text">Comments for: recurrence</title> <link rel="alternate" type="text/html" href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID/comments/" title="alternate"/> </feed> </gd:feedLink> </gd:comments> <gd:transparency value="http://schemas.google.com/g/2005#event.opaque "/> <gd:originalEvent id="i8fl1nrv2bl57c1qgr3f0onmgg" href="http://www.google.com/calendar/feeds/userID/private-magicCookie/composite/eventID"> <gd:when startTime="2006-03-17T22:00:00.000Z"/> </gd:originalEvent> <gd:where valueString="Home"/> <gd:when startTime="2006-03-17T23:00:00.000Z" endTime="2006-03-18T00:00:00.000Z"/> </entry> </gd:entryLink> </gd:recurrenceException>
Schéma
start = recurrenceException recurrenceException = element gd:recurrenceException { attribute specialized { xs:boolean }, (entryLink & originalEvent) }
gd:rappel
Plus souvent utilisée dans les pays suivants : <gd:when>
Intervalle de temps indiquant le délai d'émission d'un rappel avant l'attribut @startTime
ou @dueTime
de l'entité hôte. Vous pouvez également spécifier une heure absolue à laquelle un rappel doit être émis. Spécifie également une méthode de notification, indiquant le support que le système doit utiliser pour rappeler l'utilisateur.
Propriétés
Propriété | Type | Description |
---|---|---|
@absoluteTime ? |
xs:dateTime |
Heure absolue à laquelle le rappel doit être émis. Cette option est généralement utilisée lorsqu'un utilisateur retarde un rappel précédent grâce à la fonctionnalité de mise en attente. Si le fuseau horaire n'est pas spécifié, l'heure locale de l'observateur est supposée. |
@method ? |
xs:string |
Méthode de notification que le rappel doit utiliser. Les valeurs possibles sont alert , une alerte s'affiche lorsqu'un utilisateur consulte l'agenda dans un navigateur, email (un e-mail est envoyé à l'utilisateur) ou sms (un SMS est envoyé à l'utilisateur). |
@days ? |
xs:unsignedInt |
Délai avant gd:when/@startTime avant l'émission d'un rappel. Si l'heure cible de l'entité parente est une date et non une heure spécifique, ces attributs sont relatifs à minuit (00:00). |
@hours ? |
xs:unsignedInt |
|
@minutes ? |
xs:unsignedInt |
Lorsque vous créez ou modifiez une entrée <gd:when>
, utilisez les conventions suivantes pour obtenir des résultats particuliers:
- Pour indiquer au service d'utiliser les rappels par défaut de l'utilisateur, incluez un élément
<gd:reminder>
sans attribut. Si vous spécifiez une durée, mais pas d'attributmethod
, le service utilise les méthodes de notification par défaut de l'utilisateur avec la durée spécifiée. - Pour indiquer au service de ne pas émettre de rappels pour l'événement (ou de supprimer des rappels existants lors de la mise à jour d'un événement), n'incluez aucun élément
<gd:reminder>
.
Restrictions
- Vous ne pouvez pas spécifier plus de
@days
,@hours
,@minutes
ou@absoluteTime
. Pour spécifier une durée mixte, convertissez l'unité en unité la plus précise. Par exemple, pour spécifier 1 heure et 30 minutes, utilisez@minutes="90"
. - Vous ne pouvez pas utiliser de valeurs négatives pour les attributs. Par conséquent, si vous souhaitez qu'un rappel se produise après l'heure de début, vous devez utiliser
@absoluteTime
. - Un événement ne peut pas être associé à plus de cinq rappels.
- Lorsque vous ajoutez un rappel à un événement, vous devez également spécifier une durée si vous spécifiez les méthodes
alert
,email
ousms
.
Exemples
Un rappel de 15 minutes:
<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00"> <gd:reminder minutes="15"/> </gd:when>
Même réunion que ci-dessus, mais mise en attente pendant 10 minutes après le rappel à 16h45 :
<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00"> <gd:reminder minutes="15"/> <gd:reminder absoluteTime="2005-06-06T16:55:00-08:00"/> </gd:when>
Schéma
start = reminder reminder = element gd:reminder { gdCommonProperties, attribute absoluteTime { xs:dateTime }?, attribute method { xs:string }?, attribute days { xs:unsignedInt }?, attribute hours { xs:unsignedInt }?, attribute minutes { xs:unsignedInt }? }
gd:ressourceId
Identifiant de ressource opaque, distinct de atom:id, car il ne doit pas nécessairement être un URI valide. Certains services fournissent un identifiant distinct à utiliser lors de la création de requêtes ultérieures. L'utilisation exacte est spécifique au service.
Exemple
<gd:resourceId>9749638</gd:resourceId>
Schéma
start = resourceId resourceId = element gd:resourceId { xs:string }
gd:date
Représente une période ou un instantané.
Propriétés
Propriété | Type | Description |
---|---|---|
@endTime ? |
xs:dateTime ou xs:date |
Décrit la fin de l'événement. Si le fuseau horaire n'est pas spécifié, le fuseau horaire local de l'observateur est utilisé. |
@startTime |
xs:dateTime ou xs:date |
Décrit le début ou la fin de l'événement (pour les événements de durée zéro). Si le fuseau horaire n'est pas spécifié, le fuseau horaire local de l'observateur est utilisé. |
@valueString ? |
xs:string |
Valeur de chaîne simple pouvant être utilisée comme représentation de cette période. |
Restrictions
- Impossible de mélanger
xs:dateTime
avecxs:date
dansstartTime
/endTime
. - Si
endTime
n'est pas spécifié, l'événement est considéré comme un événement instantané (si@startTime
inclut une heure) ou un événement d'une journée (si@startTime
n'est qu'une date).
Exemples
Un événement d'une journée:
<gd:when startTime="2005-06-06"/>
Autre représentation d'un événement d'une journée:
<gd:when startTime="2005-06-06" endTime="2005-06-07"/>
Un événement de deux jours (les 6 et 7 juin) avec une description de la chaîne:
<gd:when startTime="2005-06-06" endTime="2005-06-08" valueString="This weekend"/>
Réunion d'une heure:
<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00"/>
Un événement sans durée:
<gd:when startTime="2005-06-06T17:00:00-08:00"/>
Schéma
start = when when = element gd:when { gdCommonProperties, attribute startTime { (xs:date | xs:dateTime) }, attribute endTime { (xs:date | xs:dateTime) }?, attribute valueString { xs:string }? }
gd:où
Lieu (tel qu'un lieu d'événement) associé à l'entité qui le contient. Le type d'association est déterminé par l'attribut rel
. Les informations sur l'établissement sont contenues dans une entrée de contact intégrée ou liée à un contact.
Un élément <gd:where>
est plus général qu'un élément <gd:geoPt>
. La première identifie une adresse à l'aide d'une description textuelle et/ou d'une entrée de contact, tandis que la seconde identifie une adresse à partir d'un emplacement géographique spécifique.
Propriétés
Propriété | Type | Description |
---|---|---|
@label ? |
xs:string |
Spécifie un libellé lisible par l'utilisateur pour distinguer cet établissement des autres. |
@rel ? |
xs:string |
Spécifie la relation entre l'entité qui le contient et l'emplacement qu'il contient. Les valeurs possibles (voir ci-dessous) sont définies par d'autres éléments. Par exemple, <gd:when> définit http://schemas.google.com/g/2005#event . |
@valueString ? |
xs:string |
Valeur de chaîne simple pouvant être utilisée comme représentation de cet emplacement. |
gd:entryLink ? |
entryLink |
Entrée représentant les détails de l'emplacement. Cette entrée doit implémenter le genre Contact. |
Valeurs rel
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#event ou non spécifié |
Lieu où l'événement englobant a lieu. |
http://schemas.google.com/g/2005#event.alternate |
Adresse secondaire. Par exemple, un site distant avec un lien de visioconférence vers le site principal. |
http://schemas.google.com/g/2005#event.parking |
Un parking à proximité. |
Exemples
Lieu de l'événement:
<gd:where valueString="Google Cafeteria (Building 40)"/>
Lieu de l'événement plus complexe:
<gd:where rel="http://schemas.google.com/g/2005#event" valueString="Joe's Pub"> <gd:entryLink href="http://local.example.com/10018/JoesPub"> <gd:entry> <id>http://local.example.com/10018/JoesPub</id> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/> <content>Nice place to listen to jazz music</content> <link href="http://www.joespub.com"/> <gd:postalAddress>500 West 45th Street, New York, NY 10018</gd:postalAddress> <gd:geoPt lat="40.75" lon="-74.0"/> <gd:phoneNumber>(212) 555-1212</gd:phoneNumber> <gd:email address="info@joespub.com"/> </gd:entry> </gd:entryLink> </gd:where>
Événement avec plusieurs lieux:
<gd:where label="Mountain View Location (main)" valueString="Google Cafeteria (Building 40)"/> <gd:where rel="http://schemas.google.com/g/2005#event.alternate" label="New York Location (videoconference)" valueString="Metropolis"/>
Schéma
start = where where = element gd:where { gdCommonProperties, attribute rel { xs:string }?, attribute label { xs:string }?, attribute valueString { xs:string }?, (entryLink?) }
gd:qui
Personne associée à l'entité hôte. Le type d'association est déterminé par l'attribut rel
. Les informations concernant la personne figurent dans une entrée Contact ou associée à un contact.
L'élément <gd:who>
permet de spécifier les expéditeurs et les destinataires d'e-mails, les organisateurs d'événements d'agenda, etc.
Propriétés
Propriété | Type | Description |
---|---|---|
@email ? |
xs:string |
Adresse e-mail. Cette propriété est généralement utilisée lorsque <gd:entryLink> n'est pas spécifié. Elle doit respecter la section 3.4.1 du document RFC 2822. |
@rel ? |
xs:string |
Spécifie la relation entre l'entité hôte et la personne contenue. Vous trouverez ci-dessous les différentes valeurs possibles. |
@valueString ? |
xs:string |
Valeur de chaîne simple pouvant être utilisée comme représentation de cette personne. |
gd:attendeeStatus ? |
gEnumConstruct |
État du participant à l'événement. Énumération extensible décrite ci-dessous. |
gd:attendeeType ? |
gEnumConstruct |
Type de participant à l'événement. Énumération extensible décrite ci-dessous. |
gd:entryLink ? |
entryLink |
Entrée représentant les détails de la personne. Cette entrée doit implémenter le genre Contact. Dans de nombreux cas, cette entrée provient d'un flux de contacts. |
Valeurs rel
Les valeurs valides pour @rel dépendent du genre dans lequel l'élément <gd:who>
apparaît.
Valeur | Type | Description |
---|---|---|
http://schemas.google.com/g/2005#event.attendee |
Événement | Réunion générale ou participant à un événement. |
http://schemas.google.com/g/2005#event.organizer |
Événement | Organisateur de l'événement. Un organisateur n'est pas nécessairement un participant. |
http://schemas.google.com/g/2005#event.performer |
Événement | Artiste. Semblable à http://schemas.google.com/g/2005#event.speaker , mais plus axé sur l'art que sur la diffusion vocale. |
http://schemas.google.com/g/2005#event.speaker |
Événement | Haut-parleur. |
http://schemas.google.com/g/2005#message.bcc |
Message | Destinataire du Cci des messages |
http://schemas.google.com/g/2005#message.cc |
Message | Destinataire du message de message. |
http://schemas.google.com/g/2005#message.from |
Message | Expéditeur du message (e-mail ou messagerie instantanée) |
http://schemas.google.com/g/2005#message.reply-to |
Message | Destinataire prévu d'un message de réponse. |
http://schemas.google.com/g/2005#message.to |
Message | Destinataire principal du message. |
Valeurs gd:attendeeType
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#event.optional |
Participation facultative. |
http://schemas.google.com/g/2005#event.required |
Participation obligatoire. |
Valeurs gd:attendeeStatus
Valeur | Description |
---|---|
http://schemas.google.com/g/2005#event.accepted |
Le participant a accepté l'invitation. |
http://schemas.google.com/g/2005#event.declined |
Le participant a refusé l'invitation. |
http://schemas.google.com/g/2005#event.invited |
L'invitation a été envoyée, mais la personne n'a pas accepté. |
http://schemas.google.com/g/2005#event.tentative |
Le participant a accepté provisoirement. |
Exemples
Destinataires des e-mails:
<gd:who rel="http://schemas.google.com/g/2005#message.from" email="jo@example.com"/> <gd:who rel="http://schemas.google.com/g/2005#message.to" valueString="Elizabeth" email="liz@example.com"/>
Participant à la réunion:
<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo"> <gd:attendeeType value="http://schemas.google.com/g/2005#event.required"/> <gd:attendeeStatus value="http://schemas.google.com/g/2005#event.tentative"/> <gd:entryLink href="http://gmail.com/jo/contacts/Jo"> <entry> <id>http://gmail.com/jo/contacts/Jo</id> <category term="user-tag" label="Google"/> <title>Jo March</title> <gd:email address="jo@example.com"/> <gd:phoneNumber label="work">(650) 555-1212</gd:phoneNumber> </entry> </gd:entryLink> </gd:who>
Organisateur de l'événement:
<gd:who rel="http://schemas.google.com/g/2005#event.organizer" valueString="Receptionist 41"/>
Schéma
start = who who = element gd:who { gdCommonProperties, attribute rel { xs:string }?, attribute email { xs:string }?, attribute valueString { xsd:string }?, (entryLink? & element gd:attendeeType { gEnumConstruct }? & element gd:attendeeStatus { gEnumConstruct }?) }