Class XmlService

XmlService

Bu hizmet, komut dosyalarının XML dokümanlarını ayrıştırmasına, dokümanlarda gezinmesine ve programatik olarak oluşturmasına olanak tanır.

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

Özellikler

MülkTürAçıklama
ContentTypesContentTypeXML içerik düğümlerinin türlerini temsil eden bir liste.

Yöntemler

YöntemDönüş türüKısa açıklama
createCdata(text)CdataBelirtilen değere sahip, bağlanmamış bir CDATASection düğümü oluşturur.
createComment(text)CommentBelirtilen değere sahip, bağlanmamış bir Comment düğümü oluşturur.
createDocType(elementName)DocTypeBelirtilen ada sahip kök Element düğümü için eklenmemiş bir DocumentType düğümü oluşturur.
createDocType(elementName, systemId)DocTypeKök Element düğümü için belirtilen ada sahip ve harici alt küme verileri için belirtilen sistem kimliğine sahip, bağlı olmayan bir DocumentType düğümü oluşturur.
createDocType(elementName, publicId, systemId)DocTypeKök Element düğümü için belirtilen ada sahip ve harici alt küme verileri için belirtilen herkese açık kimliğe ve sistem kimliğine sahip, bağlı olmayan bir DocumentType düğümü oluşturur.
createDocument()DocumentBoş bir XML dokümanı oluşturur.
createDocument(rootElement)DocumentBelirtilen kök Element düğümünü içeren bir XML belgesi oluşturur.
createElement(name)ElementBelirtilen yerel ada sahip ve ad alanı içermeyen, bağlanmamış bir Element düğümü oluşturur.
createElement(name, namespace)ElementBelirtilen yerel ada ve ad alanına sahip, bağlanmamış bir Element düğümü oluşturur.
createText(text)TextBelirtilen değere sahip, bağlanmamış bir Text düğümü oluşturur.
getCompactFormat()FormatKompakt bir XML dokümanı oluşturmak için bir Format nesnesi oluşturur.
getNamespace(uri)NamespaceBelirtilen URI ile bir Namespace oluşturur.
getNamespace(prefix, uri)NamespaceBelirtilen ön ek ve URI ile bir Namespace oluşturur.
getNoNamespace()NamespaceGerçek bir ad alanının olmadığını gösteren bir Namespace oluşturur.
getPrettyFormat()FormatKullanıcı tarafından okunabilir bir XML belgesi oluşturmak için bir Format nesnesi oluşturur.
getRawFormat()FormatHam XML dokümanı yayınlamak için bir Format nesnesi oluşturur.
getXmlNamespace()NamespaceStandart xml ön ekiyle bir Namespace oluşturur.
parse(xml)DocumentXML'yi doğrulamadan, belirtilen XML'den bir Document oluşturur.

Ayrıntılı dokümanlar

createCdata(text)

Belirtilen değere sahip, bağlanmamış bir CDATASection düğümü oluşturur.

Parametreler

AdTürAçıklama
textStringayarlanacak değer

Return

Cdata: Yeni oluşturulan CDATASection düğümü


createComment(text)

Belirtilen değere sahip, bağlanmamış bir Comment düğümü oluşturur.

Parametreler

AdTürAçıklama
textStringayarlanacak değer

Return

Comment: Yeni oluşturulan Comment düğümü


createDocType(elementName)

Belirtilen ada sahip kök Element düğümü için eklenmemiş bir DocumentType düğümü oluşturur.

Parametreler

AdTürAçıklama
elementNameStringDocType beyanında belirtilecek kök Element düğümünün adı

Return

DocType: Yeni oluşturulan DocumentType düğümü


createDocType(elementName, systemId)

Kök Element düğümü için belirtilen ada sahip ve harici alt küme verileri için belirtilen sistem kimliğine sahip, bağlı olmayan bir DocumentType düğümü oluşturur.

Parametreler

AdTürAçıklama
elementNameStringDocType beyanında belirtilecek kök Element düğümünün adı
systemIdStringAyarlanacak harici alt küme verilerinin sistem kimliği

Return

DocType: Yeni oluşturulan DocumentType düğümü


createDocType(elementName, publicId, systemId)

Kök Element düğümü için belirtilen ada sahip ve harici alt küme verileri için belirtilen herkese açık kimliğe ve sistem kimliğine sahip, bağlı olmayan bir DocumentType düğümü oluşturur.

Parametreler

AdTürAçıklama
elementNameStringDocType beyanında belirtilecek kök Element düğümünün adı
publicIdStringAyarlanacak harici alt küme verilerinin herkese açık kimliği
systemIdStringAyarlanacak harici alt küme verilerinin sistem kimliği

Return

DocType: Yeni oluşturulan DocumentType düğümü


createDocument()

Boş bir XML dokümanı oluşturur.

Return

Document: Yeni oluşturulan doküman


createDocument(rootElement)

Belirtilen kök Element düğümünü içeren bir XML belgesi oluşturur.

Parametreler

AdTürAçıklama
rootElementElementayarlanacak kök Element düğümü

Return

Document: Yeni oluşturulan doküman


createElement(name)

Belirtilen yerel ada sahip ve ad alanı içermeyen, bağlanmamış bir Element düğümü oluşturur.

Parametreler

AdTürAçıklama
nameStringAyarlanacak yerel ad

Return

Element: Yeni oluşturulan Element düğümü


createElement(name, namespace)

Belirtilen yerel ada ve ad alanına sahip, bağlanmamış bir Element düğümü oluşturur.

Parametreler

AdTürAçıklama
nameStringAyarlanacak yerel ad
namespaceNamespaceayarlanacak ad alanı

Return

Element: Yeni oluşturulan Element düğümü


createText(text)

Belirtilen değere sahip, bağlanmamış bir Text düğümü oluşturur.

Parametreler

AdTürAçıklama
textStringayarlanacak değer

Return

Text: Yeni oluşturulan Text düğümü


getCompactFormat()

Kompakt bir XML dokümanı oluşturmak için bir Format nesnesi oluşturur. Düzenleyici varsayılan olarak UTF-8 kodlamayı, girinti eklememeyi ve ek satır sonlarını kullanır ancak XML beyanını ve kodlamasını içerir.

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

Return

Format: Yeni oluşturulan biçimlendirici


getNamespace(uri)

Belirtilen URI ile bir Namespace oluşturur.

Parametreler

AdTürAçıklama
uriStringad alanının URI'si

Return

Namespace: Yeni oluşturulan ad alanı


getNamespace(prefix, uri)

Belirtilen ön ek ve URI ile bir Namespace oluşturur.

Parametreler

AdTürAçıklama
prefixStringad alanının ön eki
uriStringad alanının URI'si

Return

Namespace: Yeni oluşturulan ad alanı


getNoNamespace()

Gerçek bir ad alanının olmadığını gösteren bir Namespace oluşturur.

Return

Namespace: Yeni oluşturulan ad alanı


getPrettyFormat()

Kullanıcı tarafından okunabilir bir XML belgesi oluşturmak için bir Format nesnesi oluşturur. Düzenleyici varsayılan olarak UTF-8 kodlaması, iki boşluk girintisi, her düğümden sonra \r\n satır ayırıcıları kullanır ve XML beyanını ve kodlamasını içerir.

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

Return

Format: Yeni oluşturulan biçimlendirici


getRawFormat()

Ham XML dokümanı yayınlamak için bir Format nesnesi oluşturur. Düzenleyici varsayılan olarak UTF-8 kodlamasını kullanır, XML dokümanında sağlananlar dışında girinti ve satır sonu kullanmaz ve XML beyanını ve kodlamasını içerir.

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

Return

Format: Yeni oluşturulan biçimlendirici


getXmlNamespace()

Standart xml ön ekiyle bir Namespace oluşturur.

Return

Namespace: Yeni oluşturulan ad alanı


parse(xml)

XML'yi doğrulamadan, belirtilen XML'den bir Document oluşturur.

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

Parametreler

AdTürAçıklama
xmlStringayrıştırılacak XML

Return

Document: Yeni oluşturulan doküman