XML Service

Usługa XML

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

Zajęcia

NazwaKrótki opis
AttributeReprezentacja atrybutu XML.
CdataReprezentacja węzła XML CDATASection.
CommentReprezentacja węzła XML Comment.
ContentReprezentacja ogólnego węzła XML.
ContentTypeWyliczenie reprezentujące typy węzłów treści XML.
DocTypeReprezentacja węzła XML DocumentType.
DocumentReprezentacja dokumentu XML.
ElementReprezentacja węzła XML Element.
EntityRefReprezentacja węzła XML EntityReference.
FormatNarzędzie do formatowania służące do generowania dokumentu XML z 3 wstępnie zdefiniowanymi formatami, które można dostosowywać.
NamespaceReprezentacja przestrzeni nazw XML.
ProcessingInstructionReprezentacja węzła XML ProcessingInstruction.
TextReprezentacja węzła XML Text.
XmlServiceTa usługa umożliwia skryptom analizowanie, nawigację i programowe tworzenie dokumentów XML.

Attribute

Metody

MetodaZwracany typKrótki opis
getName()StringPobiera lokalną nazwę atrybutu.
getNamespace()NamespacePobiera przestrzeń nazw dla atrybutu.
getValue()StringPobiera wartość atrybutu.
setName(name)AttributeUstawia lokalną nazwę atrybutu.
setNamespace(namespace)AttributeUstawia przestrzeń nazw dla atrybutu.
setValue(value)AttributeUstawia wartość atrybutu.

Cdata

Metody

MetodaZwracany typKrótki opis
append(text)TextDołącza podany tekst do dowolnej treści, która już istnieje w węźle.
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getText()StringPobiera wartość tekstową węzła Text.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
setText(text)TextUstawia wartość tekstową węzła Text.

Comment

Metody

MetodaZwracany typKrótki opis
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getText()StringPobiera wartość tekstową węzła Comment.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
setText(text)CommentUstawia wartość tekstową węzła Comment.

Content

Metody

MetodaZwracany typKrótki opis
asCdata()CdataPrzesyła węzeł jako węzeł CDATASection na potrzeby autouzupełniania.
asComment()CommentPrzesyła węzeł jako węzeł Comment na potrzeby autouzupełniania.
asDocType()DocTypePrzesyła węzeł jako węzeł DocumentType na potrzeby autouzupełniania.
asElement()ElementNa potrzeby autouzupełniania węzeł przesyła węzeł jako węzeł Element.
asEntityRef()EntityRefPrzesyła węzeł jako węzeł EntityReference na potrzeby autouzupełniania.
asProcessingInstruction()ProcessingInstructionPrzesyła węzeł jako węzeł ProcessingInstruction na potrzeby autouzupełniania.
asText()TextPrzesyła węzeł jako węzeł Text na potrzeby autouzupełniania.
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getType()ContentTypePobiera typ treści węzła.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.

ContentType

Właściwości

WłaściwośćTypOpis
CDATAEnumWęzeł XML CDATASection.
COMMENTEnumWęzeł XML Comment.
DOCTYPEEnumWęzeł XML DocumentType.
ELEMENTEnumWęzeł XML Element.
ENTITYREFEnumWęzeł XML EntityReference.
PROCESSINGINSTRUCTIONEnumWęzeł XML ProcessingInstruction.
TEXTEnumWęzeł XML Text.

DocType

Metody

MetodaZwracany typKrótki opis
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getElementName()StringPobiera nazwę głównego węzła Element określoną w deklaracji DocType.
getInternalSubset()StringPobiera wewnętrzne dane podzbioru węzła DocumentType.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getPublicId()StringPobiera publiczny identyfikator zewnętrznego podzbioru danych węzła DocumentType.
getSystemId()StringPobiera identyfikator systemu z zewnętrznych podzbioru danych węzła DocumentType.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
setElementName(name)DocTypeUstawia nazwę głównego węzła Element do określenia w deklaracji DocType.
setInternalSubset(data)DocTypeUstawia podzbiór wewnętrzne danych węzła DocumentType.
setPublicId(id)DocTypeUstawia publiczny identyfikator zewnętrznego podzbioru danych w węźle DocumentType.
setSystemId(id)DocTypeUstawia identyfikator systemu z zewnętrznych podzbioru danych w węźle DocumentType.

Document

Metody

MetodaZwracany typKrótki opis
addContent(content)DocumentDołącza dany węzeł na końcu dokumentu.
addContent(index, content)DocumentWstawia dany węzeł w danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu.
cloneContent()Content[]Tworzy niedołączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
detachRootElement()ElementOdłącza i zwraca główny węzeł Element dokumentu.
getAllContent()Content[]Pobiera wszystkie węzły, które są bezpośrednimi węzłami podrzędnymi dokumentu.
getContent(index)ContentPobiera węzeł o podanym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu.
getContentSize()IntegerPobiera liczbę węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
getDescendants()Content[]Pobiera wszystkie węzły, które są bezpośrednimi lub pośrednimi elementami podrzędnymi dokumentu, w kolejności, w jakiej występują w dokumencie.
getDocType()DocTypePobiera deklarację DocType dokumentu.
getRootElement()ElementPobiera główny węzeł Element dokumentu.
hasRootElement()BooleanOkreśla, czy dokument ma główny węzeł Element.
removeContent()Content[]Usuwa wszystkie węzły, które są bezpośrednimi węzłami podrzędnymi dokumentu.
removeContent(content)BooleanUsuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym dokumentu.
removeContent(index)ContentUsuwa węzeł w danym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu.
setDocType(docType)DocumentUstawia deklarację DocType dokumentu.
setRootElement(element)DocumentUstawia główny węzeł Element dokumentu.

Element

Metody

MetodaZwracany typKrótki opis
addContent(content)ElementDodaje dany węzeł jako ostatni węzeł podrzędny węzła Element.
addContent(index, content)ElementWstawia dany węzeł w danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła Element.
cloneContent()Content[]Tworzy niedołączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getAllContent()Content[]Pobiera wszystkie węzły, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}.
getAttribute(name)AttributePobiera atrybut tego węzła Element o danej nazwie bez przestrzeni nazw.
getAttribute(name, namespace)AttributePobiera atrybut tego węzła Element o podanej nazwie i przestrzeni nazw.
getAttributes()Attribute[]Pobiera wszystkie atrybuty z tego węzła Element w kolejności, w jakiej występują w dokumencie.
getChild(name)ElementPobiera pierwszy węzeł Element o podanej nazwie i nie ma przestrzeni nazw, która jest bezpośrednim elementem podrzędnym tego węzła Element.
getChild(name, namespace)ElementPobiera pierwszy węzeł Element o podanej nazwie i przestrzeni nazw, który jest bezpośrednim elementem podrzędnym tego węzła Element.
getChildText(name)StringPobiera wartość tekstową węzła z podaną nazwą bez przestrzeni nazw, jeśli węzeł jest bezpośrednim elementem podrzędnym węzła Element.
getChildText(name, namespace)StringPobiera wartość tekstową węzła o danej nazwie i przestrzeni nazw, jeśli węzeł jest bezpośrednim elementem podrzędnym węzła Element.
getChildren()Element[]Pobiera wszystkie węzły Element, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.
getChildren(name)Element[]Pobiera wszystkie węzły Element o podanej nazwie i bez przestrzeni nazw, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.
getChildren(name, namespace)Element[]Pobiera wszystkie węzły Element o podanej nazwie i przestrzeni nazw, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.
getContent(index)ContentPobiera węzeł o podanym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}.
getContentSize()IntegerPobiera liczbę węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
getDescendants()Content[]Pobiera wszystkie węzły, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła {@code Element}, w kolejności, w jakiej występują w dokumencie.
getDocument()DocumentPobiera dokument XML zawierający węzeł {@code Element}.
getName()StringPobiera lokalną nazwę węzła Element.
getNamespace()NamespacePobiera przestrzeń nazw węzła Element.
getNamespace(prefix)NamespacePobiera przestrzeń nazw z podanym prefiksem węzła Element.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getQualifiedName()StringPobiera lokalną nazwę i prefiks przestrzeni nazw węzła Element w postaci [namespacePrefix]:[localName].
getText()StringPobiera wartość tekstową węzła Element.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
isAncestorOf(other)BooleanOkreśla, czy ten węzeł Element jest bezpośrednim czy pośrednim elementem nadrzędnym danego węzła Element.
isRootElement()BooleanOkreśla, czy węzeł Element jest węzłem głównym dokumentu.
removeAttribute(attribute)BooleanUsuwa podany atrybut dla tego węzła Element, jeśli taki atrybut istnieje.
removeAttribute(attributeName)BooleanUsuwa atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje.
removeAttribute(attributeName, namespace)BooleanUsuwa atrybut tego węzła Element o podanej nazwie i przestrzeni nazw, jeśli taki atrybut istnieje.
removeContent()Content[]Usuwa wszystkie węzły, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
removeContent(content)BooleanUsuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}.
removeContent(index)ContentUsuwa węzeł w danym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}.
setAttribute(attribute)ElementUstawia podany atrybut dla tego węzła Element.
setAttribute(name, value)ElementUstawia atrybut tego węzła Element z podaną nazwą, wartością i bez przestrzeni nazw.
setAttribute(name, value, namespace)ElementUstawia atrybut tego węzła Element z podaną nazwą, wartością i przestrzenią nazw.
setName(name)ElementUstawia lokalną nazwę węzła Element.
setNamespace(namespace)ElementUstawia przestrzeń nazw węzła Element.
setText(text)ElementUstawia wartość tekstową węzła Element.

EntityRef

Metody

MetodaZwracany typKrótki opis
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getName()StringPobiera nazwę węzła EntityReference.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getPublicId()StringPobiera publiczny identyfikator węzła EntityReference.
getSystemId()StringPobiera identyfikator systemu węzła EntityReference.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
setName(name)EntityRefUstawia nazwę węzła EntityReference.
setPublicId(id)EntityRefUstawia identyfikator publiczny węzła EntityReference.
setSystemId(id)EntityRefUstawia identyfikator systemu węzła EntityReference.

Format

Metody

MetodaZwracany typKrótki opis
format(document)StringNa wyjściu generuje podany Document jako sformatowany ciąg znaków.
format(element)StringNa wyjściu generuje dany węzeł Element jako sformatowany ciąg znaków.
setEncoding(encoding)FormatUstawia kodowanie znaków, których ma używać formater.
setIndent(indent)FormatUstawia ciąg znaków używany do wcięcia węzłów podrzędnych względem ich elementów nadrzędnych.
setLineSeparator(separator)FormatUstawia ciąg znaków, który będzie wstawiany za każdym razem, gdy narzędzie formatowania normalnie wstawia podział wiersza.
setOmitDeclaration(omitDeclaration)FormatOkreśla, czy narzędzie formatowania ma pomijać deklarację XML, np. <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatOkreśla, czy narzędzie formatowania ma pomijać kodowanie w deklaracji XML, np. pole kodowania w <?xml version="1.0" encoding="UTF-8"?>.

Namespace

Metody

MetodaZwracany typKrótki opis
getPrefix()StringPobiera prefiks przestrzeni nazw.
getURI()StringPobiera identyfikator URI przestrzeni nazw.

ProcessingInstruction

Metody

MetodaZwracany typKrótki opis
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getData()StringPobiera nieprzetworzone dane dla każdej instrukcji w węźle ProcessingInstruction.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getTarget()StringPobiera wartość docelową węzła ProcessingInstruction.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.

Text

Metody

MetodaZwracany typKrótki opis
append(text)TextDołącza podany tekst do dowolnej treści, która już istnieje w węźle.
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getText()StringPobiera wartość tekstową węzła Text.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
setText(text)TextUstawia wartość tekstową węzła Text.

XmlService

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.