XML Service

Service XML

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

// Log the title and labels for the first page of blog posts on
// Google's The Keyword blog.
function parseXml() {
  let url = 'https://blog.google/rss/';
  let xml = UrlFetchApp.fetch(url).getContentText();
  let document = XmlService.parse(xml);
  let root = document.getRootElement();

  let channel = root.getChild('channel');
  let items = channel.getChildren('item');
  items.forEach(item => {
    let title = item.getChild('title').getText();
    let categories = item.getChildren('category');
    let labels = categories.map(category => category.getText());
    console.log('%s (%s)', title, labels.join(', '));
  });
}

// Create and log an XML representation of first 10 threads in your Gmail inbox.
function createXml() {
  let root = XmlService.createElement('threads');
  let threads = GmailApp.getInboxThreads()
  threads = threads.slice(0,10); // Just the first 10
  threads.forEach(thread => {
    let child = XmlService.createElement('thread')
        .setAttribute('messageCount', thread.getMessageCount())
        .setAttribute('isUnread', thread.isUnread())
        .setText(thread.getFirstMessageSubject());
    root.addContent(child);
  });
  let document = XmlService.createDocument(root);
  let xml = XmlService.getPrettyFormat().format(document);
  console.log(xml);
}

Classes

Nom	Brève description
Attribute	Représentation d'un attribut XML.
Cdata	Représentation d'un nœud CDATASection XML.
Comment	Représentation d'un nœud Comment XML.
Content	Représentation d'un nœud XML générique.
ContentType	Énumération représentant les types de nœuds de contenu XML.
DocType	Représentation d'un nœud DocumentType XML.
Document	Représentation d'un document XML.
Element	Représentation d'un nœud Element XML.
EntityRef	Représentation d'un nœud EntityReference XML.
Format	Formateur permettant de générer un document XML, avec trois formats prédéfinis qui peuvent être personnalisés.
Namespace	Représentation d'un espace de noms XML.
ProcessingInstruction	Représentation d'un nœud ProcessingInstruction XML.
Text	Représentation d'un nœud Text XML.
XmlService	Ce service permet aux scripts d'analyser, de parcourir et de créer des documents XML par programmation.

Attribute

Méthodes

Méthode	Type renvoyé	Brève description
getName()	String	Obtient le nom local de l'attribut.
getNamespace()	Namespace|null	Récupère l'espace de noms de l'attribut.
getValue()	String	Récupère la valeur de l'attribut.
setName(name)	Attribute	Définit le nom local de l'attribut.
setNamespace(namespace)	Attribute	Définit l'espace de noms de l'attribut.
setValue(value)	Attribute	Définit la valeur de l'attribut.

Cdata

Méthodes

Méthode	Type renvoyé	Brève description
append(text)	Text	Ajoute le texte donné à tout contenu déjà présent dans le nœud.
detach()	Content|null	Détache le nœud de son nœud parent Element.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getText()	String	Obtient la valeur textuelle du nœud Text.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.
setText(text)	Text	Définit la valeur textuelle du nœud Text.

Comment

Méthodes

Méthode	Type renvoyé	Brève description
detach()	Content|null	Détache le nœud de son nœud parent Element.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getText()	String	Obtient la valeur textuelle du nœud Comment.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.
setText(text)	Comment	Définit la valeur textuelle du nœud Comment.

Content

Méthodes

Méthode	Type renvoyé	Brève description
asCdata()	Cdata|null	Caste le nœud en tant que nœud CDATASection aux fins de la saisie semi-automatique.
asComment()	Comment|null	Caste le nœud en tant que nœud Comment aux fins de la saisie semi-automatique.
asDocType()	DocType|null	Caste le nœud en tant que nœud DocumentType aux fins de la saisie semi-automatique.
asElement()	Element|null	Caste le nœud en tant que nœud Element aux fins de la saisie semi-automatique.
asEntityRef()	EntityRef|null	Caste le nœud en tant que nœud EntityReference aux fins de la saisie semi-automatique.
asProcessingInstruction()	ProcessingInstruction|null	Caste le nœud en tant que nœud ProcessingInstruction aux fins de la saisie semi-automatique.
asText()	Text|null	Caste le nœud en tant que nœud Text aux fins de la saisie semi-automatique.
detach()	Content|null	Détache le nœud de son nœud parent Element.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getType()	ContentType	Obtient le type de contenu du nœud.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.

ContentType

Propriétés

Propriété	Type	Description
CDATA	Enum	Nœud CDATASection XML.
COMMENT	Enum	Nœud Comment XML.
DOCTYPE	Enum	Nœud DocumentType XML.
ELEMENT	Enum	Nœud Element XML.
ENTITYREF	Enum	Nœud EntityReference XML.
PROCESSINGINSTRUCTION	Enum	Nœud ProcessingInstruction XML.
TEXT	Enum	Nœud Text XML.

DocType

Méthodes

Méthode	Type renvoyé	Brève description
detach()	Content|null	Détache le nœud de son nœud parent Element.
getElementName()	String	Obtient le nom du nœud Element racine spécifié dans la déclaration DocType.
getInternalSubset()	String	Obtient les données du sous-ensemble interne pour le nœud DocumentType.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getPublicId()	String	Obtient l'ID public des données du sous-ensemble externe pour le nœud DocumentType.
getSystemId()	String	Obtient l'ID système des données du sous-ensemble externe pour le nœud DocumentType.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.
setElementName(name)	DocType	Définit le nom du nœud Element racine à spécifier dans la déclaration DocType.
setInternalSubset(data)	DocType	Définit les données du sous-ensemble interne pour le nœud DocumentType.
setPublicId(id)	DocType	Définit l'ID public des données du sous-ensemble externe pour le nœud DocumentType.
setSystemId(id)	DocType	Définit l'ID système des données de sous-ensemble externes pour le nœud DocumentType.

Document

Méthodes

Méthode	Type renvoyé	Brève description
addContent(content)	Document	Ajoute le nœud donné à la fin du document.
addContent(index, content)	Document	Insère le nœud donné à l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
cloneContent()	Content[]	Crée des copies non rattachées de tous les nœuds qui sont des enfants immédiats du document.
detachRootElement()	Element|null	Détache et renvoie le nœud racine Element du document.
getAllContent()	Content[]	Récupère tous les nœuds qui sont des enfants immédiats du document.
getContent(index)	Content|null	Obtient le nœud à l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
getContentSize()	Integer	Obtient le nombre de nœuds qui sont des enfants immédiats du document.
getDescendants()	Content[]	Récupère tous les nœuds qui sont des enfants directs ou indirects du document, dans l'ordre dans lequel ils apparaissent dans le document.
getDocType()	DocType|null	Obtient la déclaration DocType du document.
getRootElement()	Element|null	Obtient le nœud Element racine du document.
hasRootElement()	Boolean	Détermine si le document comporte un nœud Element racine.
removeContent()	Content[]	Supprime tous les nœuds qui sont des enfants immédiats du document.
removeContent(content)	Boolean	Supprime le nœud donné, s'il s'agit d'un enfant immédiat du document.
removeContent(index)	Content|null	Supprime le nœud à l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
setDocType(docType)	Document	Définit la déclaration DocType du document.
setRootElement(element)	Document	Définit le nœud Element racine du document.

Element

Méthodes

Méthode	Type renvoyé	Brève description
addContent(content)	Element	Ajoute le nœud donné en tant que dernier enfant du nœud Element.
addContent(index, content)	Element	Insère le nœud donné à l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud Element.
cloneContent()	Content[]	Crée des copies non rattachées de tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
detach()	Content|null	Détache le nœud de son nœud parent Element.
getAllContent()	Content[]	Récupère tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
getAttribute(name)	Attribute|null	Récupère l'attribut de ce nœud Element avec le nom donné et sans espace de noms.
getAttribute(name, namespace)	Attribute|null	Obtient l'attribut de ce nœud Element avec le nom et l'espace de noms spécifiés.
getAttributes()	Attribute[]	Récupère tous les attributs de ce nœud Element, dans l'ordre dans lequel ils apparaissent dans le document.
getChild(name)	Element|null	Obtient le premier nœud Element portant le nom donné et sans espace de noms, qui est un enfant immédiat de ce nœud Element.
getChild(name, namespace)	Element|null	Obtient le premier nœud Element portant le nom et l'espace de noms donnés qui est un enfant immédiat de ce nœud Element.
getChildText(name)	String|null	Obtient la valeur textuelle du nœud portant le nom indiqué et sans espace de noms, si le nœud est un enfant immédiat du nœud Element.
getChildText(name, namespace)	String|null	Obtient la valeur textuelle du nœud portant le nom et l'espace de noms spécifiés, si le nœud est un enfant immédiat du nœud Element.
getChildren()	Element[]	Récupère tous les nœuds Element qui sont des enfants immédiats de ce nœud Element, dans l'ordre dans lequel ils apparaissent dans le document.
getChildren(name)	Element[]	Récupère tous les nœuds Element portant le nom donné et sans espace de noms qui sont des enfants immédiats de ce nœud Element, dans l'ordre dans lequel ils apparaissent dans le document.
getChildren(name, namespace)	Element[]	Récupère tous les nœuds Element portant le nom et l'espace de noms donnés qui sont des enfants immédiats de ce nœud Element, dans l'ordre dans lequel ils apparaissent dans le document.
getContent(index)	Content|null	Récupère le nœud à l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
getContentSize()	Integer	Obtient le nombre de nœuds qui sont des enfants immédiats du nœud {@code Element}.
getDescendants()	Content[]	Récupère tous les nœuds qui sont des enfants directs ou indirects du nœud {@code Element}, dans l'ordre dans lequel ils apparaissent dans le document.
getDocument()	Document	Obtient le document XML qui contient le nœud {@code Element}.
getName()	String	Obtient le nom local du nœud Element.
getNamespace()	Namespace	Obtient l'espace de noms pour le nœud Element.
getNamespace(prefix)	Namespace	Obtient l'espace de noms avec le préfixe donné pour le nœud Element.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getQualifiedName()	String	Obtient le nom local et le préfixe de l'espace de noms du nœud Element, au format [namespacePrefix]:[localName].
getText()	String	Obtient la valeur textuelle du nœud Element.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.
isAncestorOf(other)	Boolean	Détermine si ce nœud Element est un parent direct ou indirect d'un nœud Element donné.
isRootElement()	Boolean	Détermine si le nœud Element est le nœud racine du document.
removeAttribute(attribute)	Boolean	Supprime l'attribut donné pour ce nœud Element, s'il existe.
removeAttribute(attributeName)	Boolean	Supprime l'attribut de ce nœud Element portant le nom donné et sans espace de noms, si un tel attribut existe.
removeAttribute(attributeName, namespace)	Boolean	Supprime l'attribut de ce nœud Element avec le nom et l'espace de noms donnés, si un tel attribut existe.
removeContent()	Content[]	Supprime tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
removeContent(content)	Boolean	Supprime le nœud donné, s'il s'agit d'un enfant immédiat du nœud {@code Element}.
removeContent(index)	Content|null	Supprime le nœud à l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
setAttribute(attribute)	Element	Définit l'attribut donné pour ce nœud Element.
setAttribute(name, value)	Element	Définit l'attribut de ce nœud Element avec le nom et la valeur indiqués, sans espace de noms.
setAttribute(name, value, namespace)	Element	Définit l'attribut de ce nœud Element avec le nom, la valeur et l'espace de noms spécifiés.
setName(name)	Element	Définit le nom local du nœud Element.
setNamespace(namespace)	Element	Définit l'espace de noms pour le nœud Element.
setText(text)	Element	Définit la valeur textuelle du nœud Element.

EntityRef

Méthodes

Méthode	Type renvoyé	Brève description
detach()	Content|null	Détache le nœud de son nœud parent Element.
getName()	String	Récupère le nom du nœud EntityReference.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getPublicId()	String|null	Obtient l'ID public du nœud EntityReference.
getSystemId()	String|null	Obtient l'ID système du nœud EntityReference.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.
setName(name)	EntityRef	Définit le nom du nœud EntityReference.
setPublicId(id)	EntityRef	Définit l'ID public du nœud EntityReference.
setSystemId(id)	EntityRef	Définit l'ID système du nœud EntityReference.

Format

Méthodes

Méthode	Type renvoyé	Brève description
format(document)	String	Affiche le Document donné sous forme de chaîne formatée.
format(element)	String	Affiche le nœud Element donné sous forme de chaîne formatée.
setEncoding(encoding)	Format	Définit l'encodage de caractères que le formateur doit utiliser.
setIndent(indent)	Format	Définit la chaîne utilisée pour mettre en retrait les nœuds enfants par rapport à leurs parents.
setLineSeparator(separator)	Format	Définit la chaîne à insérer chaque fois que le formateur insère normalement un saut de ligne.
setOmitDeclaration(omitDeclaration)	Format	Indique si le formateur doit omettre la déclaration XML, telle que <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)	Format	Indique si le formateur doit omettre l'encodage dans la déclaration XML, comme le champ d'encodage dans <?xml version="1.0" encoding="UTF-8"?>.

Namespace

Méthodes

Méthode	Type renvoyé	Brève description
getPrefix()	String	Obtient le préfixe de l'espace de noms.
getURI()	String	Obtient l'URI de l'espace de noms.

ProcessingInstruction

Méthodes

Méthode	Type renvoyé	Brève description
detach()	Content|null	Détache le nœud de son nœud parent Element.
getData()	String	Obtient les données brutes pour chaque instruction du nœud ProcessingInstruction.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getTarget()	String	Récupère la cible du nœud ProcessingInstruction.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.

Text

Méthodes

Méthode	Type renvoyé	Brève description
append(text)	Text	Ajoute le texte donné à tout contenu déjà présent dans le nœud.
detach()	Content|null	Détache le nœud de son nœud parent Element.
getParentElement()	Element|null	Obtient le nœud parent Element du nœud.
getText()	String	Obtient la valeur textuelle du nœud Text.
getValue()	String	Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.
setText(text)	Text	Définit la valeur textuelle du nœud Text.

XmlService

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é pour le nœud Element racine avec le nom donné.
createDocType(elementName, systemId)	DocType	Crée un nœud DocumentType non associé pour le nœud Element racine 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é pour le 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 spécifié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 indiqué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.
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 un Document à partir du code XML fourni, sans valider le code XML.