Class XmlService

XmlService

Ta usługa umożliwia skryptom analizowanie, nawigowanie i tworzenie dokumentów XML w ramach programowania.

// 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 niepowiązany węzeł CDATASection z określoną wartością.
createComment(text)CommentTworzy niepowiązany węzeł Comment z określoną wartością.
createDocType(elementName)DocTypeTworzy niepowiązany węzeł DocumentType dla węzła głównego Element o podanej nazwie.
createDocType(elementName, systemId)DocTypeTworzy niepowiązany węzeł DocumentType dla węzła Element z daną nazwą i danym identyfikatorem systemowym dla danych zewnętrznych podzbioru.
createDocType(elementName, publicId, systemId)DocTypeTworzy nieprzyłączony węzeł DocumentType dla węzła Element z podaną nazwą oraz podanym identyfikatorem publicznym i identyfikatorem systemowym dla danych zewnętrznych podzbioru.
createDocument()DocumentTworzy pusty dokument XML.
createDocument(rootElement)DocumentTworzy dokument XML z danym węzłem głównym Element.
createElement(name)ElementTworzy niepowiązany węzeł Element o podanej nazwie lokalnej i bez przestrzeni nazw.
createElement(name, namespace)ElementTworzy niepowiązany węzeł Element z daną nazwą lokalną i przestrzenią nazw.
createText(text)TextTworzy niepowiązany węzeł Text z określoną wartością.
getCompactFormat()FormatTworzy obiekt Format, aby wygenerować skompresowany dokument XML.
getNamespace(uri)NamespaceTworzy obiekt Namespace z podanym identyfikatorem URI.
getNamespace(prefix, uri)NamespaceTworzy Namespace z danym prefiksem i identyfikatorem URI.
getNoNamespace()NamespaceTworzy Namespace, który reprezentuje brak prawdziwej przestrzeni nazw.
getPrettyFormat()FormatTworzy obiekt Format, aby wygenerować czytelny dla człowieka dokument XML.
getRawFormat()FormatTworzy obiekt Format, aby wygenerować surowy dokument XML.
getXmlNamespace()NamespaceTworzy Namespace ze standardowym prefiksem xml.
parse(xml)DocumentTworzy Document z podanego kodu XML bez jego weryfikacji.

Szczegółowa dokumentacja

createCdata(text)

Tworzy niepowiązany węzeł CDATASection z określoną wartością.

Parametry

NazwaTypOpis
textStringwartość do ustawienia.

Powrót

Cdata – nowo utworzony węzeł CDATASection


createComment(text)

Tworzy niepowiązany węzeł Comment z określoną wartością.

Parametry

NazwaTypOpis
textStringwartość do ustawienia.

Powrót

Comment – nowo utworzony węzeł Comment


createDocType(elementName)

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

Parametry

NazwaTypOpis
elementNameStringnazwę węzła głównego Element, który ma być określony w deklaracji DocType;

Powrót

DocType – nowo utworzony węzeł DocumentType


createDocType(elementName, systemId)

Tworzy niepowiązany węzeł DocumentType dla węzła Element z daną nazwą i danym identyfikatorem systemowym dla danych zewnętrznych podzbioru.

Parametry

NazwaTypOpis
elementNameStringnazwę węzła głównego Element, który ma być określony w deklaracji DocType;
systemIdStringidentyfikator systemu zewnętrznego podzbioru danych, który ma zostać ustawiony;

Powrót

DocType – nowo utworzony węzeł DocumentType


createDocType(elementName, publicId, systemId)

Tworzy nieprzyłączony węzeł DocumentType dla węzła Element z podaną nazwą oraz podanym identyfikatorem publicznym i identyfikatorem systemowym dla danych zewnętrznych podzbioru.

Parametry

NazwaTypOpis
elementNameStringnazwę węzła głównego Element, który ma być określony w deklaracji DocType;
publicIdStringpubliczny identyfikator zewnętrznych danych podzbioru, które mają zostać ustawione.
systemIdStringidentyfikator systemu zewnętrznego podzbioru danych, który ma zostać ustawiony;

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 danym węzłem głównym Element.

Parametry

NazwaTypOpis
rootElementElementwierzchołkowy węzeł Element do ustawienia

Powrót

Document – nowo utworzony dokument


createElement(name)

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

Parametry

NazwaTypOpis
nameStringlokalna nazwa do ustawienia.

Powrót

Element – nowo utworzony węzeł Element


createElement(name, namespace)

Tworzy niepowiązany węzeł Element z daną nazwą lokalną i przestrzenią nazw.

Parametry

NazwaTypOpis
nameStringlokalna nazwa do ustawienia.
namespaceNamespaceprzestrzeń nazw do ustawienia.

Powrót

Element – nowo utworzony węzeł Element


createText(text)

Tworzy niepowiązany węzeł Text z określoną wartością.

Parametry

NazwaTypOpis
textStringwartość do ustawienia.

Powrót

Text – nowo utworzony węzeł Text


getCompactFormat()

Tworzy obiekt Format, aby wygenerować skompresowany dokument XML. Formatowanie domyślnie używa kodowania UTF-8, nie stosuje wcięć ani dodatkowych znaków końca wiersza, 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 formater.


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 danym prefiksem i identyfikatorem URI.

Parametry

NazwaTypOpis
prefixStringprefiks przestrzeni nazw,
uriStringidentyfikator URI przestrzeni nazw;

Powrót

Namespace – nowo utworzona przestrzeń nazw


getNoNamespace()

Tworzy Namespace, który reprezentuje brak prawdziwej przestrzeni nazw.

Powrót

Namespace – nowo utworzona przestrzeń nazw


getPrettyFormat()

Tworzy obiekt Format, aby wygenerować czytelny dla człowieka dokument XML. Formatowanie domyślnie używa kodowania UTF-8, wcięcia o 2 spacje, separatorów wierszy \r\n po każdym węźle oraz zawiera deklarację XML i jej kodowanie.

// 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 formater.


getRawFormat()

Tworzy obiekt Format, aby wygenerować surowy dokument XML. Domyślnie formatowanie używa kodowania UTF-8, nie stosuje wcięć ani znaków końca wiersza innych niż te podane 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 formater.


getXmlNamespace()

Tworzy Namespace ze standardowym prefiksem xml.

Powrót

Namespace – nowo utworzona przestrzeń nazw


parse(xml)

Tworzy Document z podanego kodu XML bez jego weryfikacji.

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

Parametry

NazwaTypOpis
xmlStringXML do przeanalizowania

Powrót

Document – nowo utworzony dokument