Class XmlService

XmlService

Ce service permet aux scripts d'analyser, de naviguer et de créer des documents XML par programmation.

// Log the title and labels for the first page of blog posts on the
// Google Workspace Developer blog.
function parseXml() {
  const url = 'https://gsuite-developers.googleblog.com/atom.xml';
  const xml = UrlFetchApp.fetch(url).getContentText();
  const document = XmlService.parse(xml);
  const root = document.getRootElement();
  const atom = XmlService.getNamespace('http://www.w3.org/2005/Atom');

  const entries = root.getChildren('entry', atom);
  for (let i = 0; i < entries.length; i++) {
    const title = entries[i].getChild('title', atom).getText();
    const categoryElements = entries[i].getChildren('category', atom);
    const labels = [];
    for (let j = 0; j < categoryElements.length; j++) {
      labels.push(categoryElements[j].getAttribute('term').getValue());
    }
    Logger.log('%s (%s)', title, labels.join(', '));
  }
}

// Create and log an XML representation of the threads in your Gmail inbox.
function createXml() {
  const root = XmlService.createElement('threads');
  const threads = GmailApp.getInboxThreads();
  for (let i = 0; i < threads.length; i++) {
    const child =
        XmlService.createElement('thread')
            .setAttribute('messageCount', threads[i].getMessageCount())
            .setAttribute('isUnread', threads[i].isUnread())
            .setText(threads[i].getFirstMessageSubject());
    root.addContent(child);
  }
  const document = XmlService.createDocument(root);
  const xml = XmlService.getPrettyFormat().format(document);
  Logger.log(xml);
}

Propriétés

Propriété	Type	Description
ContentTypes	ContentType	Énumération représentant les types de nœuds de contenu XML.

Méthodes

Méthode	Type renvoyé	Brève description
createCdata(text)	Cdata	Crée un nœud CDATASection non associé avec la valeur donnée.
createComment(text)	Comment	Crée un nœud Comment non associé avec la valeur donnée.
createDocType(elementName)	DocType	Crée un nœud DocumentType non associé au nœud Element racine avec le nom donné.
createDocType(elementName, systemId)	DocType	Crée un nœud DocumentType non associé au nœud racine Element avec le nom donné et l'ID système donné pour les données du sous-ensemble externe.
createDocType(elementName, publicId, systemId)	DocType	Crée un nœud DocumentType non associé au nœud Element racine avec le nom donné, ainsi que l'ID public et l'ID système donnés pour les données du sous-ensemble externe.
createDocument()	Document	Crée un document XML vide.
createDocument(rootElement)	Document	Crée un document XML avec le nœud racine Element donné.
createElement(name)	Element	Crée un nœud Element non associé avec le nom local donné et sans espace de noms.
createElement(name, namespace)	Element	Crée un nœud Element non associé avec le nom local et l'espace de noms donnés.
createText(text)	Text	Crée un nœud Text non associé avec la valeur donnée.
getCompactFormat()	Format	Crée un objet Format pour générer un document XML compact.
getNamespace(uri)	Namespace	Crée un Namespace avec l'URI donné.
getNamespace(prefix, uri)	Namespace	Crée un Namespace avec le préfixe et l'URI donnés.
getNoNamespace()	Namespace	Crée un Namespace qui représente l'absence d'un espace de noms réel.
getPrettyFormat()	Format	Crée un objet Format pour générer un document XML lisible par l'humain.
getRawFormat()	Format	Crée un objet Format pour générer un document XML brut.
getXmlNamespace()	Namespace	Crée un Namespace avec le préfixe xml standard.
parse(xml)	Document	Crée une Document à partir du fichier XML donné, sans le valider.

Documentation détaillée

createCdata(text)

Crée un nœud CDATASection non associé avec la valeur donnée.

Paramètres

Nom	Type	Description
text	String	la valeur à définir ;

Renvois

Cdata : nœud CDATASection nouvellement créé

---

createComment(text)

Crée un nœud Comment non associé avec la valeur donnée.

Paramètres

Nom	Type	Description
text	String	la valeur à définir ;

Renvois

Comment : nœud Comment nouvellement créé

---

createDocType(elementName)

Crée un nœud DocumentType non associé au nœud Element racine avec le nom donné.

Paramètres

Nom	Type	Description
elementName	String	Nom du nœud Element racine à spécifier dans la déclaration DocType

Renvois

DocType : nœud DocumentType nouvellement créé

---

createDocType(elementName, systemId)

Crée un nœud DocumentType non associé au nœud racine Element avec le nom donné et l'ID système donné pour les données du sous-ensemble externe.

Paramètres

Nom	Type	Description
elementName	String	Nom du nœud Element racine à spécifier dans la déclaration DocType
systemId	String	ID système des données du sous-ensemble externe à définir

Renvois

DocType : nœud DocumentType nouvellement créé

---

createDocType(elementName, publicId, systemId)

Crée un nœud DocumentType non associé au nœud Element racine avec le nom donné, ainsi que l'ID public et l'ID système donnés pour les données du sous-ensemble externe.

Paramètres

Nom	Type	Description
elementName	String	Nom du nœud Element racine à spécifier dans la déclaration DocType
publicId	String	ID public des données du sous-ensemble externe à définir
systemId	String	ID système des données du sous-ensemble externe à définir

Renvois

DocType : nœud DocumentType nouvellement créé

---

createDocument()

Crée un document XML vide.

Renvois

Document : document créé

---

createDocument(rootElement)

Crée un document XML avec le nœud racine Element donné.

Paramètres

Nom	Type	Description
rootElement	Element	Nœud racine Element à définir

Renvois

Document : document créé

---

createElement(name)

Crée un nœud Element non associé avec le nom local donné et sans espace de noms.

Paramètres

Nom	Type	Description
name	String	Nom local à définir

Renvois

Element : nœud Element nouvellement créé

---

createElement(name, namespace)

Crée un nœud Element non associé avec le nom local et l'espace de noms donnés.

Paramètres

Nom	Type	Description
name	String	Nom local à définir
namespace	Namespace	l'espace de noms à définir

Renvois

Element : nœud Element nouvellement créé

---

createText(text)

Crée un nœud Text non associé avec la valeur donnée.

Paramètres

Nom	Type	Description
text	String	la valeur à définir ;

Renvois

Text : nœud Text nouvellement créé

---

getCompactFormat()

Crée un objet Format pour générer un document XML compact. Le formateur utilise par défaut l'encodage UTF-8, aucune indentation et aucun saut de ligne supplémentaire, mais inclut la déclaration XML et son encodage.

// Log an XML document in compact form.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output = XmlService.getCompactFormat().format(document);
Logger.log(output);

Renvois

Format : le formateur nouvellement créé

---

getNamespace(uri)

Crée un Namespace avec l'URI donné.

Paramètres

Nom	Type	Description
uri	String	URI de l'espace de noms

Renvois

Namespace : espace de noms nouvellement créé

---

getNamespace(prefix, uri)

Crée un Namespace avec le préfixe et l'URI donnés.

Paramètres

Nom	Type	Description
prefix	String	le préfixe de l'espace de noms ;
uri	String	URI de l'espace de noms

Renvois

Namespace : espace de noms nouvellement créé

---

getNoNamespace()

Crée un Namespace qui représente l'absence d'un espace de noms réel.

Renvois

Namespace : espace de noms nouvellement créé

---

getPrettyFormat()

Crée un objet Format pour générer un document XML lisible par l'humain. Le formateur utilise par défaut l'encodage UTF-8, une indentation de deux espaces, des séparateurs de ligne \r\n après chaque nœud et inclut la déclaration XML et son encodage.

// Log an XML document in human-readable form.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output = XmlService.getPrettyFormat().format(document);
Logger.log(output);

Renvois

Format : le formateur nouvellement créé

---

getRawFormat()

Crée un objet Format pour générer un document XML brut. Le formateur utilise par défaut l'encodage UTF-8, aucune indentation et aucun saut de ligne autre que ceux fournis dans le document XML lui-même, et inclut la déclaration XML et son encodage.

// Log an XML document in raw form.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output = XmlService.getRawFormat().format(document);
Logger.log(output);

Renvois

Format : le formateur nouvellement créé

---

getXmlNamespace()

Crée un Namespace avec le préfixe xml standard.

Renvois

Namespace : espace de noms nouvellement créé

---

parse(xml)

Crée une Document à partir du fichier XML donné, sans le valider.

const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const doc = XmlService.parse(xml);

Paramètres

Nom	Type	Description
xml	String	le fichier XML à analyser

Renvois

Document : document créé