Ce service permet aux scripts d'analyser des documents XML, de les parcourir et de les créer de manière automatisée.
// 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 XML CDATASection . |
Comment | Représentation d'un nœud XML Comment . |
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 XML DocumentType . |
Document | Représentation d'un document XML. |
Element | Représentation d'un nœud XML Element . |
EntityRef | Représentation d'un nœud XML EntityReference . |
Format | Formateur permettant de générer un document XML, avec trois formats prédéfinis pouvant être personnalisés. |
Namespace | Représentation d'un espace de noms XML. |
ProcessingInstruction | Représentation d'un nœud XML ProcessingInstruction . |
Text | Représentation d'un nœud XML Text . |
XmlService | Ce service permet aux scripts d'analyser des documents XML, de les parcourir et de les programmer. |
Attribute
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getName() | String | Récupère le nom local de l'attribut. |
getNamespace() | Namespace | 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 pour 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 qui existe déjà dans le nœud. |
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getText() | String | Récupère la valeur de texte du nœud Text . |
getValue() | String | Récupère la valeur de texte 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 de texte du nœud Text . |
Comment
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getText() | String | Récupère la valeur de texte du nœud Comment . |
getValue() | String | Récupère la valeur de texte 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 de texte du nœud Comment . |
Content
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
asCdata() | Cdata | Convertit le nœud en nœud CDATASection à des fins de saisie semi-automatique. |
asComment() | Comment | Convertit le nœud en nœud Comment à des fins de saisie semi-automatique. |
asDocType() | DocType | Convertit le nœud en nœud DocumentType à des fins de saisie semi-automatique. |
asElement() | Element | Convertit le nœud en nœud Element à des fins de saisie semi-automatique. |
asEntityRef() | EntityRef | Convertit le nœud en nœud EntityReference à des fins de saisie semi-automatique. |
asProcessingInstruction() | ProcessingInstruction | Convertit le nœud en nœud ProcessingInstruction à des fins de saisie semi-automatique. |
asText() | Text | Convertit le nœud en nœud Text à des fins de saisie semi-automatique. |
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getType() | ContentType | Récupère le type de contenu du nœud. |
getValue() | String | Récupère la valeur de texte 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 | Un nœud XML CDATASection . |
COMMENT | Enum | Un nœud XML Comment . |
DOCTYPE | Enum | Un nœud XML DocumentType . |
ELEMENT | Enum | Un nœud XML Element . |
ENTITYREF | Enum | Un nœud XML EntityReference . |
PROCESSINGINSTRUCTION | Enum | Un nœud XML ProcessingInstruction . |
TEXT | Enum | Un nœud XML Text . |
DocType
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getElementName() | String | Récupère le nom du nœud Element racine spécifié dans la déclaration DocType . |
getInternalSubset() | String | Récupère les données du sous-ensemble interne pour le nœud DocumentType . |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getPublicId() | String | Récupère l'ID public des données du sous-ensemble externe pour le nœud DocumentType . |
getSystemId() | String | Récupère l'ID système des données du sous-ensemble externe pour le nœud DocumentType . |
getValue() | String | Récupère la valeur de texte 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 du sous-ensemble externe 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 associées de tous les nœuds qui sont des enfants immédiats du document. |
detachRootElement() | Element | Dissocie et renvoie le nœud Element racine du document. |
getAllContent() | Content[] | Récupère tous les nœuds qui sont des enfants immédiats du document. |
getContent(index) | Content | Récupère le nœud d'un index donné parmi tous les nœuds qui sont des enfants immédiats du document. |
getContentSize() | Integer | Récupère 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 | Récupère la déclaration DocType du document. |
getRootElement() | Element | Récupère le nœud Element racine du document. |
hasRootElement() | Boolean | Détermine si le document possède 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 | Supprime le nœud d'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[] | Cette opération crée des copies non associées de tous les nœuds qui sont les enfants immédiats du nœud ('codecode Element}). |
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getAllContent() | Content[] | Récupère tous les nœuds qui sont des enfants immédiats du nœud ('codecode Element}". |
getAttribute(name) | Attribute | Récupère l'attribut de ce nœud Element avec le nom donné et sans espace de noms. |
getAttribute(name, namespace) | Attribute | Récupère l'attribut de ce nœud Element avec le nom et l'espace de noms fournis. |
getAttributes() | Attribute[] | Récupère tous les attributs pour ce nœud Element , dans l'ordre dans lequel ils apparaissent dans le document. |
getChild(name) | Element | Récupère le premier nœud Element avec le nom donné et sans espace de noms qui est un enfant immédiat de ce nœud Element . |
getChild(name, namespace) | Element | Récupère le premier nœud Element avec le nom et l'espace de noms donnés qui sont un enfant immédiat de ce nœud Element . |
getChildText(name) | String | Récupère la valeur de texte du nœud avec le nom donné et sans espace de noms si le nœud est un enfant immédiat du nœud Element . |
getChildText(name, namespace) | String | Récupère la valeur de texte du nœud avec le nom et l'espace de noms fournis, 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 les 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 spécifié, mais sans espace de noms, qui sont les 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 avec le nom et l'espace de noms indiqués, qui sont les enfants immédiats de ce nœud Element , dans l'ordre dans lequel ils apparaissent dans le document. |
getContent(index) | Content | Récupère le nœud à l'index donné parmi tous les nœuds enfants immédiats du nœud gcloud Element. |
getContentSize() | Integer | Récupère le nombre de nœuds enfants immédiats du nœud goocode Element. |
getDescendants() | Content[] | Récupère tous les nœuds qui sont des enfants directs ou indirects du nœud gcloud Element, dans l'ordre dans lequel ils apparaissent dans le document. |
getDocument() | Document | Récupère le document XML contenant le nœud ('codecode Element}". |
getName() | String | Récupère le nom local du nœud Element . |
getNamespace() | Namespace | Récupère l'espace de noms pour le nœud Element . |
getNamespace(prefix) | Namespace | Récupère l'espace de noms avec le préfixe donné pour le nœud Element . |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getQualifiedName() | String | Récupère le nom local et le préfixe d'espace de noms du nœud Element , au format [namespacePrefix]:[localName] . |
getText() | String | Récupère la valeur de texte du nœud Element . |
getValue() | String | Récupère la valeur de texte 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 , le cas échéant. |
removeAttribute(attributeName) | Boolean | Supprime l'attribut de ce nœud Element portant le nom donné et sans espace de noms, le cas échéant. |
removeAttribute(attributeName, namespace) | Boolean | Supprime l'attribut de ce nœud Element avec le nom et l'espace de noms donnés, le cas échéant. |
removeContent() | Content[] | Supprime tous les nœuds qui sont des enfants immédiats du nœud ('codecode Element}). |
removeContent(content) | Boolean | Supprime le nœud donné s'il s'agit d'un enfant enfant immédiat du nœud ('codecode Element}). |
removeContent(index) | Content | Supprime le nœud d'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud ('codecode Element}). |
setAttribute(attribute) | Element | Définit l'attribut donné pour ce nœud Element . |
setAttribute(name, value) | Element | Définit l'attribut du nœud Element avec le nom, la valeur et aucun espace de noms fournis. |
setAttribute(name, value, namespace) | Element | Définit l'attribut du nœud Element avec le nom, la valeur et l'espace de noms fournis. |
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 de texte du nœud Element . |
EntityRef
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getName() | String | Récupère le nom du nœud EntityReference . |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getPublicId() | String | Récupère l'ID public du nœud EntityReference . |
getSystemId() | String | Récupère l'ID système du nœud EntityReference . |
getValue() | String | Récupère la valeur de texte 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 | Renvoie la chaîne Document mise en forme sous forme de chaîne formatée. |
format(element) | String | Génère le nœud Element donné sous forme de chaîne formatée. |
setEncoding(encoding) | Format | Définit l'encodage des caractères que l'outil de mise en forme doit utiliser. |
setIndent(indent) | Format | Définit la chaîne permettant de mettre en retrait les nœuds enfants par rapport à leurs parents. |
setLineSeparator(separator) | Format | Définit la chaîne à insérer chaque fois que l'outil de mise en forme insérera normalement un saut de ligne. |
setOmitDeclaration(omitDeclaration) | Format | Détermine si l'outil de mise en forme doit omettre la déclaration XML, par exemple <?xml version="1.0"
encoding="UTF-8"?> . |
setOmitEncoding(omitEncoding) | Format | Détermine si l'outil de mise en forme doit omettre le codage dans la déclaration XML, par exemple le champ d'encodage dans <?xml version="1.0" encoding="UTF-8"?> . |
Namespace
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getPrefix() | String | Récupère le préfixe de l'espace de noms. |
getURI() | String | Récupère l'URI de l'espace de noms. |
ProcessingInstruction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getData() | String | Récupère les données brutes pour chaque instruction du nœud ProcessingInstruction . |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getTarget() | String | Récupère la cible du nœud ProcessingInstruction . |
getValue() | String | Récupère la valeur de texte 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 qui existe déjà dans le nœud. |
detach() | Content | Dissocie le nœud de son nœud Element parent. |
getParentElement() | Element | Récupère le nœud Element du nœud parent. |
getText() | String | Récupère la valeur de texte du nœud Text . |
getValue() | String | Récupère la valeur de texte 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 de texte 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 racine Element avec le nom donné. |
createDocType(elementName, systemId) | DocType | Un nœud DocumentType non associé est créé pour le nœud racine Element avec le nom donné, ainsi que l'ID de système donné pour les données externes du sous-ensemble. |
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 externes du sous-ensemble. |
createDocument() | Document | Crée un document XML vide. |
createDocument(rootElement) | Document | Crée un document XML avec le nœud Element racine 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 indiqué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. |
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 fichier XML donné, sans valider le fichier XML. |