Class XmlService

XmlService

Ta usługa umożliwia skryptom analizowanie, nawigację i programowe tworzenie dokumentów 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);
}

Właściwości

WłaściwośćTypOpis
ContentTypesContentTypeWyliczenie reprezentujące typy węzłów treści XML.

Metody

MetodaZwracany typKrótki opis
createCdata(text)CdataTworzy niedołączony węzeł CDATASection o podanej wartości.
createComment(text)CommentTworzy niedołączony węzeł Comment o podanej wartości.
createDocType(elementName)DocTypeTworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie.
createDocType(elementName, systemId)DocTypeTworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie oraz podany identyfikator systemu dla zewnętrznych podzbioru danych.
createDocType(elementName, publicId, systemId)DocTypeTworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie oraz podany identyfikator publiczny i identyfikator systemu dla zewnętrznych podzbioru danych.
createDocument()DocumentTworzy pusty dokument XML.
createDocument(rootElement)DocumentTworzy dokument XML z danym głównym węzłem Element.
createElement(name)ElementTworzy niedołączony węzeł Element o podanej nazwie lokalnej bez przestrzeni nazw.
createElement(name, namespace)ElementTworzy niedołączony węzeł Element o podanej nazwie lokalnej i przestrzeni nazw.
createText(text)TextTworzy niedołączony węzeł Text o podanej wartości.
getCompactFormat()FormatTworzy obiekt Format do przesyłania kompaktowego dokumentu XML.
getNamespace(uri)NamespaceTworzy element Namespace o podanym identyfikatorze URI.
getNamespace(prefix, uri)NamespaceTworzy element Namespace o podanym prefiksie i identyfikatorze URI.
getNoNamespace()NamespaceTworzy element Namespace reprezentujący brak rzeczywistej przestrzeni nazw.
getPrettyFormat()FormatTworzy obiekt Format do umieszczenia na wyjściu zrozumiałego dla człowieka dokumentu XML.
getRawFormat()FormatTworzy obiekt Format do przesyłania nieprzetworzonego dokumentu XML.
getXmlNamespace()NamespaceTworzy element Namespace ze standardowym prefiksem xml.
parse(xml)DocumentTworzy Document z danego kodu XML bez weryfikacji kodu XML.

Szczegółowa dokumentacja

createCdata(text)

Tworzy niedołączony węzeł CDATASection o podanej wartości.

Parametry

NazwaTypOpis
textStringwartość do ustawienia

Powroty

Cdata – nowo utworzony węzeł CDATASection


createComment(text)

Tworzy niedołączony węzeł Comment o podanej wartości.

Parametry

NazwaTypOpis
textStringwartość do ustawienia

Powroty

Comment – nowo utworzony węzeł Comment


createDocType(elementName)

Tworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie.

Parametry

NazwaTypOpis
elementNameStringnazwa głównego węzła Element do określenia w deklaracji DocType

Powroty

DocType – nowo utworzony węzeł DocumentType


createDocType(elementName, systemId)

Tworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie oraz podany identyfikator systemu dla zewnętrznych podzbioru danych.

Parametry

NazwaTypOpis
elementNameStringnazwa głównego węzła Element do określenia w deklaracji DocType
systemIdStringidentyfikator systemu zewnętrznych podzbiorów danych do ustawienia

Powroty

DocType – nowo utworzony węzeł DocumentType


createDocType(elementName, publicId, systemId)

Tworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie oraz podany identyfikator publiczny i identyfikator systemu dla zewnętrznych podzbioru danych.

Parametry

NazwaTypOpis
elementNameStringnazwa głównego węzła Element do określenia w deklaracji DocType
publicIdStringpubliczny identyfikator zewnętrznych podzbiorów danych do ustawienia
systemIdStringidentyfikator systemu zewnętrznych podzbiorów danych do ustawienia

Powroty

DocType – nowo utworzony węzeł DocumentType


createDocument()

Tworzy pusty dokument XML.

Powroty

Document – nowo utworzony dokument


createDocument(rootElement)

Tworzy dokument XML z danym głównym węzłem Element.

Parametry

NazwaTypOpis
rootElementElementgłówny węzeł Element do ustawienia

Powroty

Document – nowo utworzony dokument


createElement(name)

Tworzy niedołączony węzeł Element o podanej nazwie lokalnej bez przestrzeni nazw.

Parametry

NazwaTypOpis
nameStringnazwa lokalna do ustawienia

Powroty

Element – nowo utworzony węzeł Element


createElement(name, namespace)

Tworzy niedołączony węzeł Element o podanej nazwie lokalnej i przestrzeni nazw.

Parametry

NazwaTypOpis
nameStringnazwa lokalna do ustawienia
namespaceNamespaceprzestrzeń nazw do ustawienia

Powroty

Element – nowo utworzony węzeł Element


createText(text)

Tworzy niedołączony węzeł Text o podanej wartości.

Parametry

NazwaTypOpis
textStringwartość do ustawienia

Powroty

Text – nowo utworzony węzeł Text


getCompactFormat()

Tworzy obiekt Format do przesyłania kompaktowego dokumentu XML. W przypadku narzędzia formatowania domyślnie stosowane jest kodowanie UTF-8, bez wcięć i bez dodatkowych podziałów wierszy, ale uwzględniana jest deklaracja XML i jej kodowanie.

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

Powroty

Format – nowo utworzony narzędzie do formatowania


getNamespace(uri)

Tworzy element Namespace o podanym identyfikatorze URI.

Parametry

NazwaTypOpis
uriStringidentyfikator URI przestrzeni nazw

Powroty

Namespace – nowo utworzona przestrzeń nazw


getNamespace(prefix, uri)

Tworzy element Namespace o podanym prefiksie i identyfikatorze URI.

Parametry

NazwaTypOpis
prefixStringprefiks przestrzeni nazw
uriStringidentyfikator URI przestrzeni nazw

Powroty

Namespace – nowo utworzona przestrzeń nazw


getNoNamespace()

Tworzy element Namespace reprezentujący brak rzeczywistej przestrzeni nazw.

Powroty

Namespace – nowo utworzona przestrzeń nazw


getPrettyFormat()

Tworzy obiekt Format do umieszczenia na wyjściu zrozumiałego dla człowieka dokumentu XML. W przypadku narzędzia do formatowania domyślnie stosowane jest kodowanie UTF-8, wcięcie tekstu ze spacjami 2 spacje i separatory wierszy \r\n po każdym węźle. Obejmuje ona deklarację XML i jej kodowanie.

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

Powroty

Format – nowo utworzony narzędzie do formatowania


getRawFormat()

Tworzy obiekt Format do przesyłania nieprzetworzonego dokumentu XML. W programie formatowania domyślnie stosowane jest kodowanie UTF-8, bez wcięć ani podziałów wierszy innych niż te podane w samym dokumencie XML. Zawiera też deklarację XML i jej kodowanie.

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

Powroty

Format – nowo utworzony narzędzie do formatowania


getXmlNamespace()

Tworzy element Namespace ze standardowym prefiksem xml.

Powroty

Namespace – nowo utworzona przestrzeń nazw


parse(xml)

Tworzy Document z danego kodu XML bez weryfikacji kodu XML.

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

Parametry

NazwaTypOpis
xmlStringkod XML do przeanalizowania

Powroty

Document – nowo utworzony dokument