Class XmlService

XmlService

Bu hizmet, komut dosyalarının XML belgelerini ayrıştırmasına, belgelerde gezinmesine ve programatik olarak XML belgeleri 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ülk	Tür	Açıklama
ContentTypes	ContentType	XML içerik düğümlerinin türlerini temsil eden bir numaralandırma.

Yöntemler

Yöntem	Dönüş türü	Kısa açıklama
createCdata(text)	Cdata	Belirtilen değere sahip, bağlantısız bir CDATASection düğümü oluşturur.
createComment(text)	Comment	Belirtilen değere sahip, bağlantısız bir Comment düğümü oluşturur.
createDocType(elementName)	DocType	Belirtilen ada sahip kök Element düğümü için eklenmemiş bir DocumentType düğümü oluşturur.
createDocType(elementName, systemId)	DocType	Kök Element düğümü için, verilen adla ve harici alt küme verileri için verilen sistem kimliğiyle birlikte eklenmemiş bir DocumentType düğümü oluşturur.
createDocType(elementName, publicId, systemId)	DocType	Kök Element düğümü için, verilen adla, harici alt küme verileri için verilen genel kimlik ve sistem kimliğiyle birlikte, eklenmemiş bir DocumentType düğümü oluşturur.
createDocument()	Document	Boş bir XML dokümanı oluşturur.
createDocument(rootElement)	Document	Belirtilen kök Element düğümüyle bir XML dokümanı oluşturur.
createElement(name)	Element	Belirtilen yerel ada sahip ve ad alanı olmayan, ayrılmış bir Element düğümü oluşturur.
createElement(name, namespace)	Element	Belirtilen yerel ada ve ad alanına sahip, ayrılmamış bir Element düğümü oluşturur.
createText(text)	Text	Belirtilen değere sahip, bağlantısız bir Text düğümü oluşturur.
getCompactFormat()	Format	Kısa bir XML belgesi oluşturmak için Format nesnesi oluşturur.
getNamespace(uri)	Namespace	Belirtilen URI ile Namespace oluşturur.
getNamespace(prefix, uri)	Namespace	Belirtilen önek ve URI ile bir Namespace oluşturur.
getNoNamespace()	Namespace	Gerçek bir ad alanının olmadığını gösteren bir Namespace oluşturur.
getPrettyFormat()	Format	Okunabilir bir XML belgesi oluşturmak için Format nesnesi oluşturur.
getRawFormat()	Format	Ham XML dokümanı çıkışı için Format nesnesi oluşturur.
getXmlNamespace()	Namespace	Standart xml önekine sahip bir Namespace oluşturur.
parse(xml)	Document	XML'yi doğrulamadan, verilen XML'den bir Document oluşturur.

Ayrıntılı belgeler

createCdata(text)

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

Parametreler

Ad	Tür	Açıklama
text	String	Ayarlanacak değer.

Return

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

---

createComment(text)

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

Parametreler

Ad	Tür	Açıklama
text	String	Ayarlanacak 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

Ad	Tür	Açıklama
elementName	String	Element bildiriminde belirtilecek kök DocType düğümünün adı.

Return

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

---

createDocType(elementName, systemId)

Kök Element düğümü için, verilen adla ve harici alt küme verileri için verilen sistem kimliğiyle birlikte eklenmemiş bir DocumentType düğümü oluşturur.

Parametreler

Ad	Tür	Açıklama
elementName	String	Element bildiriminde belirtilecek kök DocType düğümünün adı.
systemId	String	Ayarlanacak 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, verilen adla, harici alt küme verileri için verilen genel kimlik ve sistem kimliğiyle birlikte, eklenmemiş bir DocumentType düğümü oluşturur.

Parametreler

Ad	Tür	Açıklama
elementName	String	Element bildiriminde belirtilecek kök DocType düğümünün adı.
publicId	String	Ayarlanacak harici alt küme verilerinin herkese açık kimliği.
systemId	String	Ayarlanacak 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üyle bir XML dokümanı oluşturur.

Parametreler

Ad	Tür	Açıklama
rootElement	Element	Ayarlanacak kök Element düğümü.

Return

Document: Yeni oluşturulan doküman.

---

createElement(name)

Belirtilen yerel ada sahip ve ad alanı olmayan, ayrılmış bir Element düğümü oluşturur.

Parametreler

Ad	Tür	Açıklama
name	String	Ayarlanacak yerel ad.

Return

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

---

createElement(name, namespace)

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

Parametreler

Ad	Tür	Açıklama
name	String	Ayarlanacak yerel ad.
namespace	Namespace	Ayarlanacak ad alanı.

Return

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

---

createText(text)

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

Parametreler

Ad	Tür	Açıklama
text	String	Ayarlanacak değer.

Return

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

---

getCompactFormat()

Kısa bir XML belgesi oluşturmak için Format nesnesi oluşturur. Biçimlendirici, varsayılan olarak UTF-8 kodlamasını, girintilemeyi ve ek satır sonlarını kullanmaz ancak XML bildirimini 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 Namespace oluşturur.

Parametreler

Ad	Tür	Açıklama
uri	String	Ad alanının URI'si.

Return

Namespace: Yeni oluşturulan ad alanı.

---

getNamespace(prefix, uri)

Belirtilen önek ve URI ile bir Namespace oluşturur.

Parametreler

Ad	Tür	Açıklama
prefix	String	Ad alanının ön eki.
uri	String	Ad 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()

Okunabilir bir XML belgesi oluşturmak için Format nesnesi oluşturur. Biçimlendirici, varsayılan olarak UTF-8 kodlamasını, iki boşluklu girintiyi, her düğümden sonra \r\n satır ayırıcılarını kullanır ve XML bildirimini 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ı çıkışı için Format nesnesi oluşturur. Biçimlendirici, varsayılan olarak UTF-8 kodlamasını kullanır, girinti ve XML dokümanında sağlananlar dışında satır sonu içermez, XML bildirimini 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 önekine sahip bir Namespace oluşturur.

Return

Namespace: Yeni oluşturulan ad alanı.

---

parse(xml)

XML'yi doğrulamadan, verilen 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

Ad	Tür	Açıklama
xml	String	Ayrıştırılacak XML.

Return

Document: Yeni oluşturulan doküman.