Esse serviço permite que os scripts analisem, naveguem e criem documentos XML de maneira programática.
// 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); }
Classes
Nome | Breve descrição |
---|---|
Attribute | Uma representação de um atributo XML. |
Cdata | Uma representação de um nó CDATASection XML. |
Comment | Uma representação de um nó Comment XML. |
Content | Uma representação de um nó XML genérico. |
ContentType | Uma enumeração que representa os tipos de nós de conteúdo XML. |
DocType | Uma representação de um nó DocumentType XML. |
Document | Representação de um documento XML. |
Element | Uma representação de um nó Element XML. |
EntityRef | Uma representação de um nó EntityReference XML. |
Format | Um formatador para a saída de um documento XML, com três formatos predefinidos que podem ser personalizados. |
Namespace | Uma representação de um namespace XML. |
ProcessingInstruction | Uma representação de um nó ProcessingInstruction XML. |
Text | Uma representação de um nó Text XML. |
XmlService | Esse serviço permite que os scripts analisem, naveguem e criem documentos XML de maneira programática. |
Attribute
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getName() | String | Recebe o nome local do atributo. |
getNamespace() | Namespace | Recebe o namespace do atributo. |
getValue() | String | Acessa o valor do atributo. |
setName(name) | Attribute | Define o nome local do atributo. |
setNamespace(namespace) | Attribute | Define o namespace do atributo. |
setValue(value) | Attribute | Define o valor do atributo. |
Cdata
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
append(text) | Text | Anexa o texto fornecido a qualquer conteúdo que já exista no nó. |
detach() | Content | Remove o nó do nó pai Element . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getText() | String | Acessa o valor de texto do nó Text . |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
setText(text) | Text | Define o valor de texto do nó Text . |
Comment
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
detach() | Content | Remove o nó do nó pai Element . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getText() | String | Acessa o valor de texto do nó Comment . |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
setText(text) | Comment | Define o valor de texto do nó Comment . |
Content
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asCdata() | Cdata | Transmitir o nó como um nó CDATASection para fins de preenchimento automático |
asComment() | Comment | Transmitir o nó como um nó Comment para fins de preenchimento automático |
asDocType() | DocType | Transmitir o nó como um nó DocumentType para fins de preenchimento automático |
asElement() | Element | Transmitir o nó como um nó Element para fins de preenchimento automático |
asEntityRef() | EntityRef | Transmitir o nó como um nó EntityReference para fins de preenchimento automático |
asProcessingInstruction() | ProcessingInstruction | Transmitir o nó como um nó ProcessingInstruction para fins de preenchimento automático |
asText() | Text | Transmitir o nó como um nó Text para fins de preenchimento automático |
detach() | Content | Remove o nó do nó pai Element . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getType() | ContentType | Recebe o tipo de conteúdo do nó. |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
ContentType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
CDATA | Enum | Um nó CDATASection XML. |
COMMENT | Enum | Um nó Comment XML. |
DOCTYPE | Enum | Um nó DocumentType XML. |
ELEMENT | Enum | Um nó Element XML. |
ENTITYREF | Enum | Um nó EntityReference XML. |
PROCESSINGINSTRUCTION | Enum | Um nó ProcessingInstruction XML. |
TEXT | Enum | Um nó Text XML. |
DocType
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
detach() | Content | Remove o nó do nó pai Element . |
getElementName() | String | Recebe o nome do nó raiz Element especificado na declaração DocType . |
getInternalSubset() | String | Recebe os dados do subconjunto interno para o nó DocumentType . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getPublicId() | String | Recebe o ID público dos dados do subconjunto externo para o nó DocumentType . |
getSystemId() | String | Recebe o ID do sistema dos dados do subconjunto externo para o nó DocumentType . |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
setElementName(name) | DocType | Define o nome do nó Element raiz a ser especificado na declaração
DocType . |
setInternalSubset(data) | DocType | Define os dados do subconjunto interno para o nó DocumentType . |
setPublicId(id) | DocType | Define o ID público dos dados do subconjunto externo para o nó DocumentType . |
setSystemId(id) | DocType | Define o ID do sistema dos dados do subconjunto externo para o nó DocumentType . |
Document
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addContent(content) | Document | Anexa o nó especificado no final do documento. |
addContent(index, content) | Document | Insere determinado nó no índice especificado entre todos os nós que são filhos imediatos do documento. |
cloneContent() | Content[] | Cria cópias não anexadas de todos os nós que são filhos imediatos do documento. |
detachRootElement() | Element | Removendo e retorna o nó Element raiz do documento. |
getAllContent() | Content[] | Recebe todos os nós que são filhos imediatos do documento. |
getContent(index) | Content | Recebe o nó no índice especificado entre todos os nós que são filhos imediatos do documento. |
getContentSize() | Integer | Recebe o número de nós que são filhos imediatos do documento. |
getDescendants() | Content[] | Recebe todos os nós que são filhos diretos ou indiretos do documento, na ordem em que eles aparecem no documento. |
getDocType() | DocType | Recebe a declaração DocType do documento. |
getRootElement() | Element | Recebe o nó raiz Element do documento. |
hasRootElement() | Boolean | Determina se o documento tem um nó raiz Element . |
removeContent() | Content[] | Remove todos os nós que são filhos imediatos do documento. |
removeContent(content) | Boolean | Remove o nó especificado se o nó for um filho imediato do documento. |
removeContent(index) | Content | Remove o nó no índice especificado entre todos os nós que são filhos imediatos do documento. |
setDocType(docType) | Document | Define a declaração DocType do documento. |
setRootElement(element) | Document | Define o nó Element raiz do documento. |
Element
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addContent(content) | Element | Anexa o nó fornecido como o último filho do nó Element . |
addContent(index, content) | Element | Insere o nó especificado no índice entre todos os nós que são filhos imediatos do
nó Element . |
cloneContent() | Content[] | Cria cópias não anexadas de todos os nós que são filhos imediatos do nó {6}code Element}. |
detach() | Content | Remove o nó do nó pai Element . |
getAllContent() | Content[] | Recebe todos os nós que são filhos imediatos do nó PLURALcode Element}. |
getAttribute(name) | Attribute | Recebe o atributo para este nó Element com o nome informado e sem namespace. |
getAttribute(name, namespace) | Attribute | Recebe o atributo para este nó Element com o nome e o namespace fornecidos. |
getAttributes() | Attribute[] | Recebe todos os atributos do nó Element na ordem em que aparecem no documento. |
getChild(name) | Element | Recebe o primeiro nó Element com o nome fornecido e nenhum namespace que seja um filho imediato
desse nó Element . |
getChild(name, namespace) | Element | Recebe o primeiro nó Element com o nome e o namespace fornecidos que são filhos imediatos desse nó Element . |
getChildText(name) | String | Acessa o valor de texto do nó com o nome fornecido e sem namespace, se o nó for um
filho imediato do nó Element . |
getChildText(name, namespace) | String | Acessa o valor de texto do nó com o nome e o namespace fornecidos, se o nó for um filho
imediato do nó Element . |
getChildren() | Element[] | Recebe todos os nós Element que são filhos imediatos desse nó Element , na
ordem que aparecem no documento. |
getChildren(name) | Element[] | Recebe todos os nós Element com o nome fornecido e nenhum namespace que sejam filhos imediatos desse nó Element , na ordem em que aparecem no documento. |
getChildren(name, namespace) | Element[] | Recebe todos os nós Element com o nome e o namespace fornecidos que são filhos imediatos desse nó Element , na ordem em que aparecem no documento. |
getContent(index) | Content | Recebe o nó no índice especificado entre todos os nós que são filhos imediatos do nó do {6}código do elemento}. |
getContentSize() | Integer | Recebe o número de nós que são filhos imediatos do nó PLURALcode Element}. |
getDescendants() | Content[] | Recebe todos os nós que são filhos diretos ou indiretos do nó PLURALcode Element}, na ordem em que eles aparecem no documento. |
getDocument() | Document | Recebe o documento XML que contém o nó PLURALcode Element}. |
getName() | String | Recebe o nome local do nó Element . |
getNamespace() | Namespace | Recebe o namespace para o nó Element . |
getNamespace(prefix) | Namespace | Recebe o namespace com o prefixo especificado para o nó Element . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getQualifiedName() | String | Acessa o prefixo local de nome e namespace do nó Element , na forma [namespacePrefix]:[localName] . |
getText() | String | Acessa o valor de texto do nó Element . |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
isAncestorOf(other) | Boolean | Determina se este nó Element é um pai direto ou indireto de um determinado nó Element . |
isRootElement() | Boolean | Determina se o nó Element é o nó raiz do documento. |
removeAttribute(attribute) | Boolean | Remove o atributo especificado para este nó Element , se esse atributo existir. |
removeAttribute(attributeName) | Boolean | Remove o atributo para este nó Element com o nome informado e nenhum namespace, se
esse atributo existir. |
removeAttribute(attributeName, namespace) | Boolean | Remove o atributo para este nó Element com o nome e o namespace fornecidos, se esse atributo existir. |
removeContent() | Content[] | Remove todos os nós que são filhos imediatos do nó {6}code Element}. |
removeContent(content) | Boolean | Remove o nó especificado se o nó for um filho imediato do nó {6}code Element}. |
removeContent(index) | Content | Remove o nó no índice especificado entre todos os nós que são filhos imediatos do nó do {0/}code Element}. |
setAttribute(attribute) | Element | Define o atributo especificado para este nó do Element . |
setAttribute(name, value) | Element | Define o atributo para este nó Element com o nome, o valor e nenhum namespace fornecidos. |
setAttribute(name, value, namespace) | Element | Define o atributo para este nó Element com o nome, o valor e o namespace fornecidos. |
setName(name) | Element | Define o nome local do nó Element . |
setNamespace(namespace) | Element | Define o namespace do nó Element . |
setText(text) | Element | Define o valor de texto do nó Element . |
EntityRef
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
detach() | Content | Remove o nó do nó pai Element . |
getName() | String | Recebe o nome do nó EntityReference . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getPublicId() | String | Recebe o ID público do nó EntityReference . |
getSystemId() | String | Recebe o ID do sistema do nó EntityReference . |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
setName(name) | EntityRef | Define o nome do nó EntityReference . |
setPublicId(id) | EntityRef | Define o ID público do nó EntityReference . |
setSystemId(id) | EntityRef | Define o ID do sistema do nó EntityReference . |
Format
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
format(document) | String | Mostra a Document fornecida como uma string formatada. |
format(element) | String | Mostra o nó Element fornecido como uma string formatada. |
setEncoding(encoding) | Format | Define a codificação de caracteres que o formatador deve usar. |
setIndent(indent) | Format | Define a string usada para recuar os nós filhos em relação aos pais. |
setLineSeparator(separator) | Format | Define a string a ser inserida sempre que o formatador normalmente inseriria uma quebra de linha. |
setOmitDeclaration(omitDeclaration) | Format | Define se o formatador precisa omitir a declaração XML, como <?xml version="1.0"
encoding="UTF-8"?> . |
setOmitEncoding(omitEncoding) | Format | Define se o formatador precisa omitir a codificação na declaração XML, como o
campo de codificação em <?xml version="1.0" encoding="UTF-8"?> . |
Namespace
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getPrefix() | String | Recebe o prefixo do namespace. |
getURI() | String | Recebe o URI do namespace. |
ProcessingInstruction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
detach() | Content | Remove o nó do nó pai Element . |
getData() | String | Recebe os dados brutos para cada instrução no nó ProcessingInstruction . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getTarget() | String | Recebe o destino do nó ProcessingInstruction . |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
Text
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
append(text) | Text | Anexa o texto fornecido a qualquer conteúdo que já exista no nó. |
detach() | Content | Remove o nó do nó pai Element . |
getParentElement() | Element | Recebe o nó pai do nó Element . |
getText() | String | Acessa o valor de texto do nó Text . |
getValue() | String | Acessa o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento. |
setText(text) | Text | Define o valor de texto do nó Text . |
XmlService
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
ContentTypes | ContentType | Uma enumeração que representa os tipos de nós de conteúdo XML. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
createCdata(text) | Cdata | Cria um nó CDATASection não anexado com o valor informado. |
createComment(text) | Comment | Cria um nó Comment não anexado com o valor informado. |
createDocType(elementName) | DocType | Cria um nó DocumentType não anexado para o nó raiz Element
com o nome fornecido. |
createDocType(elementName, systemId) | DocType | Cria um nó DocumentType não anexado para o nó Element raiz
com o nome informado e o ID do sistema informado para os dados de subconjuntos externos. |
createDocType(elementName, publicId, systemId) | DocType | Cria um nó DocumentType não anexado para o nó Element raiz
com o nome informado e o código público e do sistema informados para os dados de subconjuntos externos. |
createDocument() | Document | Cria um documento XML vazio. |
createDocument(rootElement) | Document | Cria um documento XML com o nó raiz Element fornecido. |
createElement(name) | Element | Cria um nó Element não anexado com o nome local fornecido e sem namespace. |
createElement(name, namespace) | Element | Cria um nó Element não anexado com o nome e o namespace locais fornecidos. |
createText(text) | Text | Cria um nó Text não anexado com o valor informado. |
getCompactFormat() | Format | Cria um objeto Format para gerar um documento XML compacto. |
getNamespace(uri) | Namespace | Cria um Namespace com o URI informado. |
getNamespace(prefix, uri) | Namespace | Cria um Namespace com o prefixo e o URI fornecidos. |
getNoNamespace() | Namespace | Cria um Namespace que representa a ausência de um namespace real. |
getPrettyFormat() | Format | Cria um objeto Format para gerar um documento XML legível. |
getRawFormat() | Format | Cria um objeto Format para gerar um documento XML bruto. |
getXmlNamespace() | Namespace | Cria um Namespace com o prefixo padrão xml . |
parse(xml) | Document | Cria um Document do XML fornecido, sem validar o XML. |