此页面由 Cloud Translation API 翻译。

Class XmlService

此服务允许脚本解析、导航和以编程方式创建 XML 文档。

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

属性

属性	类型	说明
`ContentTypes`	`ContentType`	表示 XML 内容节点类型的枚举。

方法

方法	返回类型	简介
`createCdata(text)`	`Cdata`	使用指定值创建未附加的 `CDATASection` 节点。
`createComment(text)`	`Comment`	使用指定值创建未附加的 `Comment` 节点。
`createDocType(elementName)`	`DocType`	为根 `Element` 节点创建未附加的 `DocumentType` 节点。
`createDocType(elementName, systemId)`	`DocType`	为根 `Element` 节点创建未附加的 `DocumentType` 节点以及外部子集数据的指定系统 ID。
`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`	创建 `Format` 对象，用于输出直观易懂的 XML 文档。
`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 节点创建未附加的 DocumentType 节点以及外部子集数据的指定系统 ID。

参数

名称	类型	说明
`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.
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);

Format - 新创建的格式化程序

`getNamespace(uri)`

使用指定的 URI 创建 Namespace。

参数

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

Namespace - 新创建的命名空间

`getNamespace(prefix, uri)`

创建具有给定前缀和 URI 的 Namespace。

参数

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

Namespace - 新创建的命名空间

`getNoNamespace()`

创建一个表示不存在实际命名空间的 Namespace。

Namespace - 新创建的命名空间

`getPrettyFormat()`

创建 Format 对象，用于输出直观易懂的 XML 文档。格式化程序默认为 UTF-8 编码，两空格缩进，后面添加 \r\n 行分隔符并包括 XML 声明及其编码。

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

Format - 新创建的格式化程序

`getRawFormat()`

创建用于输出原始 XML 文档的 Format 对象。格式化程序默认设置为 UTF-8 编码，除了 XML 中提供的代码外，不得缩进和换行文档本身，并且包括 XML 声明及其编码。

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

Format - 新创建的格式化程序

`getXmlNamespace()`

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

Namespace - 新创建的命名空间

`parse(xml)`

根据指定的 XML 创建 Document，而不验证 XML。

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

参数

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

Document - 新创建的文档

Class XmlService

属性

方法

详细文档

createCdata(text)

参数

返回

createComment(text)

参数

返回

createDocType(elementName)

参数

返回

createDocType(elementName, systemId)

参数

返回

createDocType(elementName, publicId, systemId)

参数

返回

createDocument()

返回

createDocument(rootElement)

参数

返回

createElement(name)

参数

返回

createElement(name, namespace)

参数

返回

createText(text)

参数

返回

getCompactFormat()

返回

getNamespace(uri)

参数

返回

getNamespace(prefix, uri)

参数

返回

getNoNamespace()

返回

getPrettyFormat()

返回

getRawFormat()

返回

getXmlNamespace()

返回

parse(xml)

参数

返回

`createCdata(text)`

`createComment(text)`

`createDocType(elementName)`

`createDocType(elementName, systemId)`

`createDocType(elementName, publicId, systemId)`

`createDocument()`

`createDocument(rootElement)`

`createElement(name)`

`createElement(name, namespace)`

`createText(text)`

`getCompactFormat()`

`getNamespace(uri)`

`getNamespace(prefix, uri)`

`getNoNamespace()`

`getPrettyFormat()`

`getRawFormat()`

`getXmlNamespace()`

`parse(xml)`