Class XmlService

XmlService

Ta usługa umożliwia skryptom analizowanie dokumentów XML, poruszanie się po nich i tworzenie ich w sposób programowy. 

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

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 nieprzyłączony węzeł CDATASection o podanej wartości.
createComment(text)CommentTworzy nieprzyłączony węzeł Comment o podanej wartości.
createDocType(elementName)DocTypeTworzy nieprzyłączony węzeł DocumentType dla węzła głównego Element o podanej nazwie.
createDocType(elementName, systemId)DocTypeTworzy nieprzyłączony węzeł DocumentType dla węzła głównego Element o podanej nazwie i podanym identyfikatorze systemowym dla zewnętrznych danych podzbioru.
createDocType(elementName, publicId, systemId)DocTypeTworzy nieprzyłączony węzeł DocumentType dla węzła głównego Element o podanej nazwie oraz podany identyfikator publiczny i identyfikator systemowy dla zewnętrznego podzbioru danych.
createDocument()DocumentTworzy pusty dokument XML.
createDocument(rootElement)DocumentTworzy dokument XML z podanym węzłem głównym Element.
createElement(name)ElementTworzy nieprzyłączony węzeł Element o podanej nazwie lokalnej i bez przestrzeni nazw.
createElement(name, namespace)ElementTworzy nieprzyłączony węzeł Element o podanej nazwie lokalnej i przestrzeni nazw.
createText(text)TextTworzy nieprzyłączony węzeł Text o podanej wartości.
getCompactFormat()FormatTworzy obiekt Format do generowania kompaktowego dokumentu XML.
getNamespace(uri)NamespaceTworzy obiekt Namespace z podanym identyfikatorem URI.
getNamespace(prefix, uri)NamespaceTworzy Namespace z podanym prefiksem i identyfikatorem URI.
getNoNamespace()NamespaceTworzy obiekt Namespace, który reprezentuje brak rzeczywistej przestrzeni nazw.
getPrettyFormat()FormatTworzy obiekt Format do generowania czytelnego dokumentu XML.
getRawFormat()FormatTworzy obiekt Format do wyświetlania nieprzetworzonego dokumentu XML.
getXmlNamespace()NamespaceTworzy Namespace ze standardowym prefiksem xml.
parse(xml)DocumentTworzy obiekt Document z podanego kodu XML bez weryfikowania go.

Szczegółowa dokumentacja

createCdata(text)

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

Parametry

NazwaTypOpis
textStringWartość do ustawienia.

Powrót

Cdata – nowo utworzony węzeł CDATASection.

createComment(text)

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

Parametry

NazwaTypOpis
textStringWartość do ustawienia.

Powrót

Comment – nowo utworzony węzeł Comment.

createDocType(elementName)

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

Parametry

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

Powrót

DocType – nowo utworzony węzeł DocumentType.

createDocType(elementName, systemId)

Tworzy nieprzyłączony węzeł DocumentType dla węzła głównego Element o podanej nazwie i podanym identyfikatorze systemowym dla zewnętrznych danych podzbioru.

Parametry

NazwaTypOpis
elementNameStringNazwa węzła głównego Element do określenia w deklaracji DocType.
systemIdStringIdentyfikator systemowy zewnętrznych danych podzbioru do ustawienia.

Powrót

DocType – nowo utworzony węzeł DocumentType.

createDocType(elementName, publicId, systemId)

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

Parametry

NazwaTypOpis
elementNameStringNazwa węzła głównego Element do określenia w deklaracji DocType.
publicIdStringPubliczny identyfikator zewnętrznego podzbioru danych do ustawienia.
systemIdStringIdentyfikator systemowy zewnętrznych danych podzbioru do ustawienia.

Powrót

DocType – nowo utworzony węzeł DocumentType.

createDocument()

Tworzy pusty dokument XML.

Powrót

Document – nowo utworzony dokument.

createDocument(rootElement)

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

Parametry

NazwaTypOpis
rootElementElementWęzeł główny Element do ustawienia.

Powrót

Document – nowo utworzony dokument.

createElement(name)

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

Parametry

NazwaTypOpis
nameStringNazwa lokalna do ustawienia.

Powrót

Element – nowo utworzony węzeł Element.

createElement(name, namespace)

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

Parametry

NazwaTypOpis
nameStringNazwa lokalna do ustawienia.
namespaceNamespacePrzestrzeń nazw do ustawienia.

Powrót

Element – nowo utworzony węzeł Element.

createText(text)

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

Parametry

NazwaTypOpis
textStringWartość do ustawienia.

Powrót

Text – nowo utworzony węzeł Text.

getCompactFormat()

Tworzy obiekt Format do generowania kompaktowego dokumentu XML. Formatowanie domyślnie używa kodowania UTF-8, nie stosuje wcięć ani dodatkowych podziałów wierszy, ale zawiera deklarację XML i jej kodowanie. 

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

Powrót

Format – nowo utworzony formatujący.

getNamespace(uri)

Tworzy obiekt Namespace z podanym identyfikatorem URI.

Parametry

NazwaTypOpis
uriStringIdentyfikator URI przestrzeni nazw.

Powrót

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.

Powrót

Namespace – nowo utworzona przestrzeń nazw.

getNoNamespace()

Tworzy obiekt Namespace, który reprezentuje brak rzeczywistej przestrzeni nazw.

Powrót

Namespace – nowo utworzona przestrzeń nazw.

getPrettyFormat()

Tworzy obiekt Format do generowania czytelnego dokumentu XML. Formatowanie domyślnie używa kodowania UTF-8, wcięcia dwuspacjowego, separatorów wierszy \r\n po każdym węźle oraz deklaracji XML i jej kodowania. 

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

Powrót

Format – nowo utworzony formatujący.

getRawFormat()

Tworzy obiekt Format do wyświetlania nieprzetworzonego dokumentu XML. Formatowanie domyślnie używa kodowania UTF-8, nie stosuje wcięć ani podziałów wierszy innych niż te, które znajdują się w samym dokumencie XML, oraz zawiera deklarację XML i jej kodowanie. 

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

Powrót

Format – nowo utworzony formatujący.

getXmlNamespace()

Tworzy Namespace ze standardowym prefiksem xml.

Powrót

Namespace – nowo utworzona przestrzeń nazw.

parse(xml)

Tworzy obiekt Document z podanego kodu XML bez weryfikowania go. 

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

Parametry

NazwaTypOpis
xmlStringPlik XML do przeanalizowania.

Powrót

Document – nowo utworzony dokument.