This service allows scripts to parse, navigate, and programmatically create XML documents.
// Log the title and labels for the first page of blog posts on the // Google Workspace Developer blog. function parseXml() { var url = 'https://gsuite-developers.googleblog.com/atom.xml'; var xml = UrlFetchApp.fetch(url).getContentText(); var document = XmlService.parse(xml); var root = document.getRootElement(); var atom = XmlService.getNamespace('http://www.w3.org/2005/Atom'); var entries = root.getChildren('entry', atom); for (var i = 0; i < entries.length; i++) { var title = entries[i].getChild('title', atom).getText(); var categoryElements = entries[i].getChildren('category', atom); var labels = []; for (var 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() { var root = XmlService.createElement('threads'); var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { var child = XmlService.createElement('thread') .setAttribute('messageCount', threads[i].getMessageCount()) .setAttribute('isUnread', threads[i].isUnread()) .setText(threads[i].getFirstMessageSubject()); root.addContent(child); } var document = XmlService.createDocument(root); var xml = XmlService.getPrettyFormat().format(document); Logger.log(xml); }
Properties
Property | Type | Description |
---|---|---|
ContentTypes
|
ContentType
|
An enumeration representing the types of XML content nodes. |
Methods
Method | Return type | Brief description |
---|---|---|
Cdata
|
Creates an unattached CDATASection
node with the given value. |
|
Comment
|
Creates an unattached Comment
node with the given value. |
|
DocType
|
Creates an unattached DocumentType
node for the root Element
node
with the given name. |
|
DocType
|
Creates an unattached DocumentType
node for the root Element
node
with the given name, and the given system ID for the external subset data. |
|
DocType
|
Creates an unattached DocumentType
node for the root Element
node
with the given name, and the given public ID and system ID for the external subset data. |
|
Document
|
Creates an empty XML document. | |
Document
|
Creates an XML document with the given root Element
node. |
|
Element
|
Creates an unattached Element
node with the given local name and no namespace. |
|
Element
|
Creates an unattached Element
node with the given local name and namespace. |
|
Text
|
Creates an unattached Text
node with the given value. |
|
Format
|
Creates a Format
object for outputting a compact XML document. |
|
Namespace
|
Creates a Namespace
with the given URI. |
|
Namespace
|
Creates a Namespace
with the given prefix and URI. |
|
Namespace
|
Creates a Namespace
that represents the absence of a real namespace. |
|
Format
|
Creates a Format
object for outputting a human-readable XML document. |
|
Format
|
Creates a Format
object for outputting a raw XML document. |
|
Namespace
|
Creates a Namespace
with the standard xml
prefix. |
|
Document
|
Creates an Document
from the given XML, without validating the XML. |
Detailed documentation
createCdata(text)
Creates an unattached CDATASection
node with the given value.
Parameters
Name | Type | Description |
---|---|---|
text
|
String
|
the value to set |
Return
Cdata
— the newly created CDATASection
node
createComment(text)
createDocType(elementName)
Creates an unattached DocumentType
node for the root Element
node
with the given name.
Parameters
Name | Type | Description |
---|---|---|
elementName
|
String
|
the name of the root Element
node to specify in the DocType
declaration |
Return
DocType
— the newly created DocumentType
node
createDocType(elementName, systemId)
Creates an unattached DocumentType
node for the root Element
node
with the given name, and the given system ID for the external subset data.
Parameters
Name | Type | Description |
---|---|---|
elementName
|
String
|
the name of the root Element
node to specify in the DocType
declaration |
systemId
|
String
|
the system ID of the external subset data to set |
Return
DocType
— the newly created DocumentType
node
createDocType(elementName, publicId, systemId)
Creates an unattached DocumentType
node for the root Element
node
with the given name, and the given public ID and system ID for the external subset data.
Parameters
Name | Type | Description |
---|---|---|
elementName
|
String
|
the name of the root Element
node to specify in the DocType
declaration |
publicId
|
String
|
the public ID of the external subset data to set |
systemId
|
String
|
the system ID of the external subset data to set |
Return
DocType
— the newly created DocumentType
node
createDocument()
createDocument(rootElement)
createElement(name)
createElement(name, namespace)
createText(text)
getCompactFormat()
Creates a Format
object for outputting a compact XML document. The formatter
defaults to UTF-8
encoding, no indentation, and no additional line breaks, but includes
the XML declaration and its encoding.
// Log an XML document in compact form. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getCompactFormat() .format(document); Logger.log(output);
Return
Format
— the newly created formatter
getNamespace(uri)
getNamespace(prefix, uri)
getNoNamespace()
getPrettyFormat()
Creates a Format
object for outputting a human-readable XML document. The formatter
defaults to UTF-8
encoding, two-space indentation, \r\n
line separators after
every node, and includes the XML declaration and its encoding.
// Log an XML document in human-readable form. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getPrettyFormat() .format(document); Logger.log(output);
Return
Format
— the newly created formatter
getRawFormat()
Creates a Format
object for outputting a raw XML document. The formatter defaults to UTF-8
encoding, no indentation and no line breaks other than those provided in the XML
document itself, and includes the XML declaration and its encoding.
// Log an XML document in raw form. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getRawFormat() .format(document); Logger.log(output);
Return
Format
— the newly created formatter