XML Service

XML 服務

這項服務可讓指令碼剖析、瀏覽及以程式輔助方式建立 XML 文件。

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

類別

名稱簡短說明
AttributeXML 屬性的表示法。
CdataXML CDATASection 節點的表示法。
CommentXML Comment 節點的表示法。
Content一般 XML 節點的表示法。
ContentType代表 XML 內容節點類型的列舉。
DocTypeXML DocumentType 節點的表示法。
DocumentXML 文件的表示法。
ElementXML Element 節點的表示法。
EntityRefXML EntityReference 節點的表示法。
Format用於輸出 XML 文件的格式化工具,內含三種可進一步自訂的預先定義格式。
NamespaceXML 命名空間的表示法。
ProcessingInstructionXML ProcessingInstruction 節點的表示法。
TextXML Text 節點的表示法。
XmlService這項服務可讓指令碼剖析、瀏覽及以程式設計方式建立 XML 文件。

Attribute

方法

方法傳回類型簡短說明
getName()String取得屬性的本機名稱。
getNamespace()Namespace取得屬性的命名空間。
getValue()String取得屬性值。
setName(name)Attribute設定屬性的本機名稱。
setNamespace(namespace)Attribute設定屬性的命名空間。
setValue(value)Attribute設定屬性的值。

Cdata

方法

方法傳回類型簡短說明
append(text)Text將指定文字附加至節點中現有的任何內容。
detach()Content將節點從父項 Element 節點中分離。
getParentElement()Element取得節點的父項 Element 節點。
getText()String取得 Text 節點的文字值。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。
setText(text)Text設定 Text 節點的文字值。

Comment

方法

方法傳回類型簡短說明
detach()Content將節點從父項 Element 節點中分離。
getParentElement()Element取得節點的父項 Element 節點。
getText()String取得 Comment 節點的文字值。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。
setText(text)Comment設定 Comment 節點的文字值。

Content

方法

方法傳回類型簡短說明
asCdata()Cdata將節點投放為 CDATASection 節點,以便自動完成功能。
asComment()Comment將節點投放為 Comment 節點,以便自動完成功能。
asDocType()DocType將節點投放為 DocumentType 節點,以便自動完成功能。
asElement()Element將節點投放為 Element 節點,以便自動完成。
asEntityRef()EntityRef將節點投放為 EntityReference 節點,以便自動完成功能。
asProcessingInstruction()ProcessingInstruction將節點投放為 ProcessingInstruction 節點,以便自動完成功能。
asText()Text將節點投放為 Text 節點,以便自動完成功能。
detach()Content將節點從父項 Element 節點中分離。
getParentElement()Element取得節點的父項 Element 節點。
getType()ContentType取得節點的內容類型。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。

ContentType

屬性

屬性類型說明
CDATAEnumXML CDATASection 節點。
COMMENTEnumXML Comment 節點。
DOCTYPEEnumXML DocumentType 節點。
ELEMENTEnumXML Element 節點。
ENTITYREFEnumXML EntityReference 節點。
PROCESSINGINSTRUCTIONEnumXML ProcessingInstruction 節點。
TEXTEnumXML Text 節點。

DocType

方法

方法傳回類型簡短說明
detach()Content將節點從父項 Element 節點中分離。
getElementName()String取得 DocType 宣告中指定的根 Element 節點名稱。
getInternalSubset()String取得 DocumentType 節點的內部子集資料。
getParentElement()Element取得節點的父項 Element 節點。
getPublicId()String取得 DocumentType 節點的外部子集資料的公開 ID。
getSystemId()String取得 DocumentType 節點的外部子集資料系統 ID。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。
setElementName(name)DocType設定 DocType 宣告中要指定的根 Element 節點名稱。
setInternalSubset(data)DocType設定 DocumentType 節點的內部子集資料。
setPublicId(id)DocTypeDocumentType 節點設定外部子集資料的公開 ID。
setSystemId(id)DocTypeDocumentType 節點設定外部子集資料的系統 ID。

Document

方法

方法傳回類型簡短說明
addContent(content)Document將指定節點附加至文件結尾。
addContent(index, content)Document在文件的所有直接子項節點中,於指定索引處插入指定節點。
cloneContent()Content[]為文件的所有直接子項節點建立未連結的副本。
detachRootElement()Element分離並傳回文件的根 Element 節點。
getAllContent()Content[]取得文件的所有直接子項節點。
getContent(index)Content在文件的所有直接子項中,取得指定索引的節點。
getContentSize()Integer取得文件直接子項的節點數量。
getDescendants()Content[]取得文件的直接或間接子項,並按照文件中顯示的順序。
getDocType()DocType取得文件的 DocType 宣告。
getRootElement()Element取得文件的根 Element 節點。
hasRootElement()Boolean判斷文件是否有根 Element 節點。
removeContent()Content[]移除文件的所有直接子項節點。
removeContent(content)Boolean如果節點是文件的直接子項,則移除該節點。
removeContent(index)Content從文件的所有直接子項節點中,移除指定索引的節點。
setDocType(docType)Document設定文件的 DocType 宣告。
setRootElement(element)Document設定文件的根 Element 節點。

Element

方法

方法傳回類型簡短說明
addContent(content)Element將指定的節點附加為 Element 節點的最後一個子項。
addContent(index, content)ElementElement 節點的所有直接子項中,於指定索引處插入指定節點。
cloneContent()Content[]為 {@code Element} 節點的直接子項,建立未連結的所有節點副本。
detach()Content將節點從父項 Element 節點中分離。
getAllContent()Content[]取得 {@code Element} 節點的所有直接子項節點。
getAttribute(name)Attribute取得此 Element 節點的屬性,其名稱已指定,但沒有命名空間。
getAttribute(name, namespace)Attribute取得此 Element 節點的屬性,其中包含指定名稱和命名空間。
getAttributes()Attribute[]依文件中顯示的順序,取得此 Element 節點的所有屬性。
getChild(name)Element取得第一個 Element 節點,該節點具有指定名稱且沒有命名空間,且是這個 Element 節點的直接子項。
getChild(name, namespace)Element取得第一個 Element 節點,該節點具有指定名稱和命名空間,且是這個 Element 節點的直接子項。
getChildText(name)String如果節點是 Element 節點的直接子項,則會取得具有指定名稱且沒有命名空間的節點文字值。
getChildText(name, namespace)String如果節點是 Element 節點的直接子項,則會取得具有指定名稱和命名空間的節點文字值。
getChildren()Element[]取得此 Element 節點的所有直接子項 Element 節點,並按照文件中的顯示順序排序。
getChildren(name)Element[]取得所有具有指定名稱且沒有命名空間的 Element 節點,這些節點是此 Element 節點的直接子項,並按照文件中顯示的順序。
getChildren(name, namespace)Element[]取得所有具有指定名稱和命名空間的 Element 節點,這些節點是此 Element 節點的直接子項,並按照文件中顯示的順序排列。
getContent(index)Content取得 {@code Element} 節點的直接子項所屬的所有節點中,指定索引的節點。
getContentSize()Integer取得 {@code Element} 節點的直接子項數量。
getDescendants()Content[]取得 {@code Element} 節點的直接或間接子項,並按照文件中顯示的順序。
getDocument()Document取得包含 {@code Element} 節點的 XML 文件。
getName()String取得 Element 節點的本機名稱。
getNamespace()Namespace取得 Element 節點的命名空間。
getNamespace(prefix)Namespace取得 Element 節點的命名空間,並使用指定的前置字串。
getParentElement()Element取得節點的父項 Element 節點。
getQualifiedName()String[namespacePrefix]:[localName] 格式,取得 Element 節點的本機名稱和命名空間前置字元。
getText()String取得 Element 節點的文字值。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。
isAncestorOf(other)Boolean判斷此 Element 節點是否為特定 Element 節點的直接或間接父項。
isRootElement()Boolean判斷 Element 節點是否為文件的根節點。
removeAttribute(attribute)Boolean移除此 Element 節點的指定屬性 (如果有此屬性)。
removeAttribute(attributeName)Boolean移除此 Element 節點的屬性 (如果存在),該屬性具有指定名稱且沒有命名空間。
removeAttribute(attributeName, namespace)Boolean移除此 Element 節點的屬性 (如果存在),該屬性必須具有指定的名稱和命名空間。
removeContent()Content[]移除 {@code Element} 節點的所有直接子項。
removeContent(content)Boolean如果節點是 {@code Element} 節點的直接子項,則移除該節點。
removeContent(index)Content移除 {@code Element} 節點直接子項的所有節點中,指定索引的節點。
setAttribute(attribute)Element為這個 Element 節點設定指定的屬性。
setAttribute(name, value)Element為這個 Element 節點設定屬性,並指定名稱、值和命名空間。
setAttribute(name, value, namespace)Element使用指定的名稱、值和命名空間,為這個 Element 節點設定屬性。
setName(name)Element設定 Element 節點的本機名稱。
setNamespace(namespace)Element設定 Element 節點的命名空間。
setText(text)Element設定 Element 節點的文字值。

EntityRef

方法

方法傳回類型簡短說明
detach()Content將節點從父項 Element 節點中分離。
getName()String取得 EntityReference 節點的名稱。
getParentElement()Element取得節點的父項 Element 節點。
getPublicId()String取得 EntityReference 節點的公開 ID。
getSystemId()String取得 EntityReference 節點的系統 ID。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。
setName(name)EntityRef設定 EntityReference 節點的名稱。
setPublicId(id)EntityRef設定 EntityReference 節點的公開 ID。
setSystemId(id)EntityRef設定 EntityReference 節點的系統 ID。

Format

方法

方法傳回類型簡短說明
format(document)String以格式化字串的形式輸出指定的 Document
format(element)String以格式化字串的形式輸出指定的 Element 節點。
setEncoding(encoding)Format設定格式化工具應使用的字元編碼。
setIndent(indent)Format設定用於將子節點與父節點對齊的字串。
setLineSeparator(separator)Format設定在格式化工具通常會插入分隔符時要插入的字串。
setOmitDeclaration(omitDeclaration)Format設定格式化工具是否應省略 XML 宣告,例如 <?xml version="1.0" encoding="UTF-8"?>
setOmitEncoding(omitEncoding)Format設定格式化工具是否應略過 XML 宣告中的編碼,例如 <?xml version="1.0" encoding="UTF-8"?> 中的編碼欄位。

Namespace

方法

方法傳回類型簡短說明
getPrefix()String取得命名空間的前置字元。
getURI()String取得命名空間的 URI。

ProcessingInstruction

方法

方法傳回類型簡短說明
detach()Content將節點從父項 Element 節點中分離。
getData()String取得 ProcessingInstruction 節點中每項指令的原始資料。
getParentElement()Element取得節點的父項 Element 節點。
getTarget()String取得 ProcessingInstruction 節點的目標。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。

Text

方法

方法傳回類型簡短說明
append(text)Text將指定文字附加至節點中現有的任何內容。
detach()Content將節點從父項 Element 節點中分離。
getParentElement()Element取得節點的父項 Element 節點。
getText()String取得 Text 節點的文字值。
getValue()String取得節點的所有直接或間接子項節點的文字值,並依文件中顯示的順序排列。
setText(text)Text設定 Text 節點的文字值。

XmlService

屬性

屬性類型說明
ContentTypesContentType代表 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建立 Format 物件,用於輸出精簡 XML 文件。
getNamespace(uri)Namespace使用指定的 URI 建立 Namespace
getNamespace(prefix, uri)Namespace使用指定的前置字串和 URI 建立 Namespace
getNoNamespace()Namespace建立代表沒有實際命名空間的 Namespace
getPrettyFormat()Format建立 Format 物件,用於輸出人類可讀的 XML 文件。
getRawFormat()Format建立 Format 物件,用於輸出原始 XML 文件。
getXmlNamespace()Namespace使用標準 xml 前置字串建立 Namespace
parse(xml)Document從指定的 XML 建立 Document,但不會驗證 XML。