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
Nazwa | Krótki opis |
---|---|
Attribute | Reprezentacja atrybutu XML. |
Cdata | Reprezentacja węzła XML CDATASection . |
Comment | Reprezentacja węzła XML Comment . |
Content | Reprezentacja ogólnego węzła XML. |
ContentType | Wyliczenie reprezentujące typy węzłów treści XML. |
DocType | Reprezentacja węzła XML DocumentType . |
Document | Reprezentacja dokumentu XML. |
Element | Reprezentacja węzła XML Element . |
EntityRef | Reprezentacja węzła XML EntityReference . |
Format | Narzędzie do formatowania służące do generowania dokumentu XML z 3 wstępnie zdefiniowanymi formatami, które można dostosowywać. |
Namespace | Reprezentacja przestrzeni nazw XML. |
ProcessingInstruction | Reprezentacja węzła XML ProcessingInstruction . |
Text | Reprezentacja węzła XML Text . |
XmlService | Ta usługa umożliwia skryptom analizowanie, nawigację i programowe tworzenie dokumentów XML. |
Attribute
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getName() | String | Pobiera lokalną nazwę atrybutu. |
getNamespace() | Namespace | Pobiera przestrzeń nazw dla atrybutu. |
getValue() | String | Pobiera wartość atrybutu. |
setName(name) | Attribute | Ustawia lokalną nazwę atrybutu. |
setNamespace(namespace) | Attribute | Ustawia przestrzeń nazw dla atrybutu. |
setValue(value) | Attribute | Ustawia wartość atrybutu. |
Cdata
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
append(text) | Text | Dołącza podany tekst do dowolnej treści, która już istnieje w węźle. |
detach() | Content | Odłącza węzeł od jego nadrzędnego węzła Element . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getText() | String | Pobiera wartość tekstową węzła Text . |
getValue() | String | Pobiera 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) | Text | Ustawia wartość tekstową węzła Text . |
Comment
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
detach() | Content | Odłącza węzeł od jego nadrzędnego węzła Element . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getText() | String | Pobiera wartość tekstową węzła Comment . |
getValue() | String | Pobiera 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) | Comment | Ustawia wartość tekstową węzła Comment . |
Content
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
asCdata() | Cdata | Przesyła węzeł jako węzeł CDATASection na potrzeby autouzupełniania. |
asComment() | Comment | Przesyła węzeł jako węzeł Comment na potrzeby autouzupełniania. |
asDocType() | DocType | Przesyła węzeł jako węzeł DocumentType na potrzeby autouzupełniania. |
asElement() | Element | Na potrzeby autouzupełniania węzeł przesyła węzeł jako węzeł Element . |
asEntityRef() | EntityRef | Przesyła węzeł jako węzeł EntityReference na potrzeby autouzupełniania. |
asProcessingInstruction() | ProcessingInstruction | Przesyła węzeł jako węzeł ProcessingInstruction na potrzeby autouzupełniania. |
asText() | Text | Przesyła węzeł jako węzeł Text na potrzeby autouzupełniania. |
detach() | Content | Odłącza węzeł od jego nadrzędnego węzła Element . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getType() | ContentType | Pobiera typ treści węzła. |
getValue() | String | Pobiera 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ść | Typ | Opis |
---|---|---|
CDATA | Enum | Węzeł XML CDATASection . |
COMMENT | Enum | Węzeł XML Comment . |
DOCTYPE | Enum | Węzeł XML DocumentType . |
ELEMENT | Enum | Węzeł XML Element . |
ENTITYREF | Enum | Węzeł XML EntityReference . |
PROCESSINGINSTRUCTION | Enum | Węzeł XML ProcessingInstruction . |
TEXT | Enum | Węzeł XML Text . |
DocType
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
detach() | Content | Odłącza węzeł od jego nadrzędnego węzła Element . |
getElementName() | String | Pobiera nazwę głównego węzła Element określoną w deklaracji DocType . |
getInternalSubset() | String | Pobiera wewnętrzne dane podzbioru węzła DocumentType . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getPublicId() | String | Pobiera publiczny identyfikator zewnętrznego podzbioru danych węzła DocumentType . |
getSystemId() | String | Pobiera identyfikator systemu z zewnętrznych podzbioru danych węzła DocumentType . |
getValue() | String | Pobiera 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) | DocType | Ustawia nazwę głównego węzła Element do określenia w deklaracji DocType . |
setInternalSubset(data) | DocType | Ustawia podzbiór wewnętrzne danych węzła DocumentType . |
setPublicId(id) | DocType | Ustawia publiczny identyfikator zewnętrznego podzbioru danych w węźle DocumentType . |
setSystemId(id) | DocType | Ustawia identyfikator systemu z zewnętrznych podzbioru danych w węźle DocumentType . |
Document
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addContent(content) | Document | Dołącza dany węzeł na końcu dokumentu. |
addContent(index, content) | Document | Wstawia 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() | Element | Odłą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) | Content | Pobiera węzeł o podanym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu. |
getContentSize() | Integer | Pobiera 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() | DocType | Pobiera deklarację DocType dokumentu. |
getRootElement() | Element | Pobiera główny węzeł Element dokumentu. |
hasRootElement() | Boolean | Okreś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) | Boolean | Usuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym dokumentu. |
removeContent(index) | Content | Usuwa węzeł w danym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu. |
setDocType(docType) | Document | Ustawia deklarację DocType dokumentu. |
setRootElement(element) | Document | Ustawia główny węzeł Element dokumentu. |
Element
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addContent(content) | Element | Dodaje dany węzeł jako ostatni węzeł podrzędny węzła Element . |
addContent(index, content) | Element | Wstawia 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() | Content | Odłą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) | Attribute | Pobiera atrybut tego węzła Element o danej nazwie bez przestrzeni nazw. |
getAttribute(name, namespace) | Attribute | Pobiera 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) | Element | Pobiera 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) | Element | Pobiera 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) | String | Pobiera 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) | String | Pobiera 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) | Content | Pobiera 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() | Integer | Pobiera 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() | Document | Pobiera dokument XML zawierający węzeł {@code Element}. |
getName() | String | Pobiera lokalną nazwę węzła Element . |
getNamespace() | Namespace | Pobiera przestrzeń nazw węzła Element . |
getNamespace(prefix) | Namespace | Pobiera przestrzeń nazw z podanym prefiksem węzła Element . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getQualifiedName() | String | Pobiera lokalną nazwę i prefiks przestrzeni nazw węzła Element w postaci [namespacePrefix]:[localName] . |
getText() | String | Pobiera wartość tekstową węzła Element . |
getValue() | String | Pobiera 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) | Boolean | Określa, czy ten węzeł Element jest bezpośrednim czy pośrednim elementem nadrzędnym danego węzła Element . |
isRootElement() | Boolean | Określa, czy węzeł Element jest węzłem głównym dokumentu. |
removeAttribute(attribute) | Boolean | Usuwa podany atrybut dla tego węzła Element , jeśli taki atrybut istnieje. |
removeAttribute(attributeName) | Boolean | Usuwa atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje. |
removeAttribute(attributeName, namespace) | Boolean | Usuwa 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) | Boolean | Usuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}. |
removeContent(index) | Content | Usuwa 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) | Element | Ustawia podany atrybut dla tego węzła Element . |
setAttribute(name, value) | Element | Ustawia atrybut tego węzła Element z podaną nazwą, wartością i bez przestrzeni nazw. |
setAttribute(name, value, namespace) | Element | Ustawia atrybut tego węzła Element z podaną nazwą, wartością i przestrzenią nazw. |
setName(name) | Element | Ustawia lokalną nazwę węzła Element . |
setNamespace(namespace) | Element | Ustawia przestrzeń nazw węzła Element . |
setText(text) | Element | Ustawia wartość tekstową węzła Element . |
EntityRef
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
detach() | Content | Odłącza węzeł od jego nadrzędnego węzła Element . |
getName() | String | Pobiera nazwę węzła EntityReference . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getPublicId() | String | Pobiera publiczny identyfikator węzła EntityReference . |
getSystemId() | String | Pobiera identyfikator systemu węzła EntityReference . |
getValue() | String | Pobiera 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) | EntityRef | Ustawia nazwę węzła EntityReference . |
setPublicId(id) | EntityRef | Ustawia identyfikator publiczny węzła EntityReference . |
setSystemId(id) | EntityRef | Ustawia identyfikator systemu węzła EntityReference . |
Format
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
format(document) | String | Na wyjściu generuje podany Document jako sformatowany ciąg znaków. |
format(element) | String | Na wyjściu generuje dany węzeł Element jako sformatowany ciąg znaków. |
setEncoding(encoding) | Format | Ustawia kodowanie znaków, których ma używać formater. |
setIndent(indent) | Format | Ustawia ciąg znaków używany do wcięcia węzłów podrzędnych względem ich elementów nadrzędnych. |
setLineSeparator(separator) | Format | Ustawia ciąg znaków, który będzie wstawiany za każdym razem, gdy narzędzie formatowania normalnie wstawia podział wiersza. |
setOmitDeclaration(omitDeclaration) | Format | Określa, czy narzędzie formatowania ma pomijać deklarację XML, np. <?xml version="1.0"
encoding="UTF-8"?> . |
setOmitEncoding(omitEncoding) | Format | Określa, czy narzędzie formatowania ma pomijać kodowanie w deklaracji XML, np. pole kodowania w <?xml version="1.0" encoding="UTF-8"?> . |
Namespace
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getPrefix() | String | Pobiera prefiks przestrzeni nazw. |
getURI() | String | Pobiera identyfikator URI przestrzeni nazw. |
ProcessingInstruction
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
detach() | Content | Odłącza węzeł od jego nadrzędnego węzła Element . |
getData() | String | Pobiera nieprzetworzone dane dla każdej instrukcji w węźle ProcessingInstruction . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getTarget() | String | Pobiera wartość docelową węzła ProcessingInstruction . |
getValue() | String | Pobiera 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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
append(text) | Text | Dołącza podany tekst do dowolnej treści, która już istnieje w węźle. |
detach() | Content | Odłącza węzeł od jego nadrzędnego węzła Element . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getText() | String | Pobiera wartość tekstową węzła Text . |
getValue() | String | Pobiera 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) | Text | Ustawia wartość tekstową węzła Text . |
XmlService
Właściwości
Właściwość | Typ | Opis |
---|---|---|
ContentTypes | ContentType | Wyliczenie reprezentujące typy węzłów treści XML. |
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
createCdata(text) | Cdata | Tworzy niedołączony węzeł CDATASection o podanej wartości. |
createComment(text) | Comment | Tworzy niedołączony węzeł Comment o podanej wartości. |
createDocType(elementName) | DocType | Tworzy niedołączony węzeł DocumentType dla głównego węzła Element o podanej nazwie. |
createDocType(elementName, systemId) | DocType | 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. |
createDocType(elementName, publicId, systemId) | DocType | 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. |
createDocument() | Document | Tworzy pusty dokument XML. |
createDocument(rootElement) | Document | Tworzy dokument XML z danym głównym węzłem Element . |
createElement(name) | Element | Tworzy niedołączony węzeł Element o podanej nazwie lokalnej bez przestrzeni nazw. |
createElement(name, namespace) | Element | Tworzy niedołączony węzeł Element o podanej nazwie lokalnej i przestrzeni nazw. |
createText(text) | Text | Tworzy niedołączony węzeł Text o podanej wartości. |
getCompactFormat() | Format | Tworzy obiekt Format do przesyłania kompaktowego dokumentu XML. |
getNamespace(uri) | Namespace | Tworzy element Namespace o podanym identyfikatorze URI. |
getNamespace(prefix, uri) | Namespace | Tworzy element Namespace o podanym prefiksie i identyfikatorze URI. |
getNoNamespace() | Namespace | Tworzy element Namespace reprezentujący brak rzeczywistej przestrzeni nazw. |
getPrettyFormat() | Format | Tworzy obiekt Format do umieszczenia na wyjściu zrozumiałego dla człowieka dokumentu XML. |
getRawFormat() | Format | Tworzy obiekt Format do przesyłania nieprzetworzonego dokumentu XML. |
getXmlNamespace() | Namespace | Tworzy element Namespace ze standardowym prefiksem xml . |
parse(xml) | Document | Tworzy Document z danego kodu XML bez weryfikacji kodu XML. |