Class XmlService

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Usługa XML

Ta usługa umożliwia skryptom analizowanie, poruszanie się i automatyczne 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 uwzględniają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 na potrzeby węzła głównego Element o podanej nazwie oraz identyfikator systemu dla danych zewnętrznych podzbiorów.
createDocType(elementName, publicId, systemId)DocTypeTworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie oraz identyfikator publiczny i identyfikator systemu dla zewnętrznych danych podzbiorów.
createDocument()DocumentTworzy pusty dokument XML.
createDocument(rootElement)DocumentTworzy dokument XML z węzłem głównym 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 wyświetlania kompaktowego dokumentu XML.
getNamespace(uri)NamespaceTworzy Namespace z podanym identyfikatorem URI.
getNamespace(prefix, uri)NamespaceTworzy Namespace z podanym prefiksem i identyfikatorem URI.
getNoNamespace()NamespaceTworzy atrybut Namespace reprezentujący brak rzeczywistej przestrzeni nazw.
getPrettyFormat()FormatTworzy obiekt Format do wyjściowego w postaci zrozumiałej dla człowieka dokumentu XML.
getRawFormat()FormatTworzy obiekt Format do przesyłania nieprzetworzonych dokumentów XML.
getXmlNamespace()NamespaceTworzy Namespace ze standardowym prefiksem xml.
parse(xml)DocumentTworzy Document na podstawie podanego pliku XML bez weryfikacji.

Szczegółowa dokumentacja

createCdata(text)

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

Parametry

NazwaTypOpis
textStringwartość do ustawienia

Zwróć

Cdata – nowo utworzony węzeł CDATASection,


createComment(text)

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

Parametry

NazwaTypOpis
textStringwartość do ustawienia

Zwróć

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 węzła głównego Element, który jest określony w deklaracji DocType

Zwróć

DocType – nowo utworzony węzeł DocumentType,


createDocType(elementName, systemId)

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

Parametry

NazwaTypOpis
elementNameStringnazwa węzła głównego Element, który jest określony w deklaracji DocType
systemIdStringidentyfikator systemowy zewnętrznych danych podzbiorów, które chcesz ustawić

Zwróć

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 identyfikator publiczny i identyfikator systemu dla zewnętrznych danych podzbiorów.

Parametry

NazwaTypOpis
elementNameStringnazwa węzła głównego Element, który jest określony w deklaracji DocType
publicIdStringpubliczny identyfikator zewnętrznego podzbioru danych do ustawienia
systemIdStringidentyfikator systemowy zewnętrznych danych podzbiorów, które chcesz ustawić

Zwróć

DocType – nowo utworzony węzeł DocumentType,


createDocument()

Tworzy pusty dokument XML.

Zwróć

Document – nowo utworzony dokument


createDocument(rootElement)

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

Parametry

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

Zwróć

Document – nowo utworzony dokument


createElement(name)

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

Parametry

NazwaTypOpis
nameStringlokalnej nazwy do ustawienia

Zwróć

Element – nowo utworzony węzeł Element,


createElement(name, namespace)

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

Parametry

NazwaTypOpis
nameStringlokalnej nazwy do ustawienia
namespaceNamespaceprzestrzeń nazw do ustawienia

Zwróć

Element – nowo utworzony węzeł Element,


createText(text)

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

Parametry

NazwaTypOpis
textStringwartość do ustawienia

Zwróć

Text – nowo utworzony węzeł Text,


getCompactFormat()

Tworzy obiekt Format do wyświetlania kompaktowego dokumentu XML. Domyślnie formatuje UTF-8, nie dodaje wcięcia ani dodatkowych podziałów wierszy, ale zawiera deklarację 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);

Zwróć

Format – nowo utworzone narzędzie


getNamespace(uri)

Tworzy Namespace z podanym identyfikatorem URI.

Parametry

NazwaTypOpis
uriStringidentyfikator URI przestrzeni nazw

Zwróć

Namespace – nowo utworzona przestrzeń nazw


getNamespace(prefix, uri)

Tworzy Namespace z podanym prefiksem i identyfikatorem URI.

Parametry

NazwaTypOpis
prefixStringprefiks przestrzeni nazw
uriStringidentyfikator URI przestrzeni nazw

Zwróć

Namespace – nowo utworzona przestrzeń nazw


getNoNamespace()

Tworzy atrybut Namespace reprezentujący brak rzeczywistej przestrzeni nazw.

Zwróć

Namespace – nowo utworzona przestrzeń nazw


getPrettyFormat()

Tworzy obiekt Format do wyjściowego w postaci zrozumiałej dla człowieka dokumentu XML. Domyślnie formater ma wszystkie wartości, kodowanie UTF-8, wcięcia spacji, \r\n separatory wierszy po każdym węźle oraz zawiera 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);

Zwróć

Format – nowo utworzone narzędzie


getRawFormat()

Tworzy obiekt Format do przesyłania nieprzetworzonych dokumentów XML. Domyślnie formatuje UTF-8 i nie ma wcięcia ani podziałów wierszy innych niż te podane w dokumencie XML, a także 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);

Zwróć

Format – nowo utworzone narzędzie


getXmlNamespace()

Tworzy Namespace ze standardowym prefiksem xml.

Zwróć

Namespace – nowo utworzona przestrzeń nazw


parse(xml)

Tworzy Document na podstawie podanego pliku XML bez weryfikacji.

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

Parametry

NazwaTypOpis
xmlStringkod XML do analizy

Zwróć

Document – nowo utworzony dokument