Class XmlService

XmlService

此服务允许脚本解析、浏览和以程序化方式创建 XML 文档。

// 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);
}

属性

属性	类型	说明
ContentTypes	ContentType	一种枚举，用于表示 XML 内容节点的类型。

方法

方法	返回类型	简介
createCdata(text)	Cdata	使用给定值创建未附加的 CDATASection 节点。
createComment(text)	Comment	使用给定值创建未附加的 Comment 节点。
createDocType(elementName)	DocType	为具有指定名称的根 Element 节点创建未附加的 DocumentType 节点。
createDocType(elementName, systemId)	DocType	为具有指定名称的根 Element 节点和外部子集数据的指定系统 ID 创建一个未附加的 DocumentType 节点。
createDocType(elementName, publicId, systemId)	DocType	为具有指定名称的根 Element 节点创建未附加的 DocumentType 节点，并为外部子集数据提供指定的公开 ID 和系统 ID。
createDocument()	Document	创建空的 XML 文档。
createDocument(rootElement)	Document	使用给定的根 Element 节点创建 XML 文档。
createElement(name)	Element	创建具有给定本地名称且没有命名空间的未附加 Element 节点。
createElement(name, namespace)	Element	创建具有指定本地名称和命名空间的未附加 Element 节点。
createText(text)	Text	使用给定值创建未附加的 Text 节点。
getCompactFormat()	Format	创建用于输出紧凑 XML 文档的 Format 对象。
getNamespace(uri)	Namespace	使用给定的 URI 创建 Namespace。
getNamespace(prefix, uri)	Namespace	使用给定的前缀和 URI 创建 Namespace。
getNoNamespace()	Namespace	创建表示缺少实际命名空间的 Namespace。
getPrettyFormat()	Format	创建用于输出可读 XML 文档的 Format 对象。
getRawFormat()	Format	创建用于输出原始 XML 文档的 Format 对象。
getXmlNamespace()	Namespace	创建具有标准 xml 前缀的 Namespace。
parse(xml)	Document	根据给定的 XML 创建 Document，但不验证 XML。

详细文档

createCdata(text)

使用给定值创建未附加的 CDATASection 节点。

参数

名称	类型	说明
text	String	要设置的值。

返回

Cdata - 新创建的 CDATASection 节点。

---

createComment(text)

使用给定值创建未附加的 Comment 节点。

参数

名称	类型	说明
text	String	要设置的值。

返回

Comment - 新创建的 Comment 节点。

---

createDocType(elementName)

为具有指定名称的根 Element 节点创建未附加的 DocumentType 节点。

参数

名称	类型	说明
elementName	String	要在 DocType 声明中指定的根 Element 节点的名称。

返回

DocType - 新创建的 DocumentType 节点。

---

createDocType(elementName, systemId)

为具有指定名称的根 Element 节点和外部子集数据的指定系统 ID 创建一个未附加的 DocumentType 节点。

参数

名称	类型	说明
elementName	String	要在 DocType 声明中指定的根 Element 节点的名称。
systemId	String	要设置的外部子集数据的系统 ID。

返回

DocType - 新创建的 DocumentType 节点。

---

createDocType(elementName, publicId, systemId)

为具有指定名称的根 Element 节点创建未附加的 DocumentType 节点，并为外部子集数据提供指定的公开 ID 和系统 ID。

参数

名称	类型	说明
elementName	String	要在 DocType 声明中指定的根 Element 节点的名称。
publicId	String	要设置的外部子集数据的公开 ID。
systemId	String	要设置的外部子集数据的系统 ID。

返回

DocType - 新创建的 DocumentType 节点。

---

createDocument()

创建空的 XML 文档。

返回

Document - 新创建的文档。

---

createDocument(rootElement)

使用给定的根 Element 节点创建 XML 文档。

参数

名称	类型	说明
rootElement	Element	要设置的根 Element 节点。

返回

Document - 新创建的文档。

---

createElement(name)

创建具有给定本地名称且没有命名空间的未附加 Element 节点。

参数

名称	类型	说明
name	String	要设置的本地名称。

返回

Element - 新创建的 Element 节点。

---

createElement(name, namespace)

创建具有指定本地名称和命名空间的未附加 Element 节点。

参数

名称	类型	说明
name	String	要设置的本地名称。
namespace	Namespace	要设置的命名空间。

返回

Element - 新创建的 Element 节点。

---

createText(text)

使用给定值创建未附加的 Text 节点。

参数

名称	类型	说明
text	String	要设置的值。

返回

Text - 新创建的 Text 节点。

---

getCompactFormat()

创建用于输出紧凑型 XML 文档的 Format 对象。格式化程序默认采用 UTF-8 编码，不缩进，不添加额外的换行符，但包含 XML 声明及其编码。

// 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);

返回

Format - 新创建的格式化程序。

---

getNamespace(uri)

使用给定的 URI 创建 Namespace。

参数

名称	类型	说明
uri	String	命名空间的 URI。

返回

Namespace - 新创建的命名空间。

---

getNamespace(prefix, uri)

使用给定的前缀和 URI 创建 Namespace。

参数

名称	类型	说明
prefix	String	命名空间的前缀。
uri	String	命名空间的 URI。

返回

Namespace - 新创建的命名空间。

---

getNoNamespace()

创建表示缺少实际命名空间的 Namespace。

返回

Namespace - 新创建的命名空间。

---

getPrettyFormat()

创建用于输出可读 XML 文档的 Format 对象。格式化程序默认采用 UTF-8 编码、双空格缩进、每个节点后添加 \r\n 行分隔符，并包含 XML 声明及其编码。

// 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);

返回

Format - 新创建的格式化程序。

---

getRawFormat()

创建用于输出原始 XML 文档的 Format 对象。格式化程序默认采用 UTF-8 编码，不缩进，不换行（XML 文档本身提供的换行除外），并包含 XML 声明及其编码。

// 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);

返回

Format - 新创建的格式化程序。

---

getXmlNamespace()

创建具有标准 xml 前缀的 Namespace。

返回

Namespace - 新创建的命名空间。

---

parse(xml)

根据给定的 XML 创建 Document，但不验证 XML。

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

参数

名称	类型	说明
xml	String	要解析的 XML。

返回

Document - 新创建的文档。