Class XmlService

XmlService

این سرویس به اسکریپت ها اجازه می دهد تا اسناد XML را تجزیه، ناوبری و برنامه نویسی کنند.

// Log the title and labels for the first page of blog posts on the
// Google Workspace Developer blog.
function parseXml() {
  var url = 'https://gsuite-developers.googleblog.com/atom.xml';
  var xml = UrlFetchApp.fetch(url).getContentText();
  var document = XmlService.parse(xml);
  var root = document.getRootElement();
  var atom = XmlService.getNamespace('http://www.w3.org/2005/Atom');

  var entries = root.getChildren('entry', atom);
  for (var i = 0; i < entries.length; i++) {
    var title = entries[i].getChild('title', atom).getText();
    var categoryElements = entries[i].getChildren('category', atom);
    var labels = [];
    for (var 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() {
  var root = XmlService.createElement('threads');
  var threads = GmailApp.getInboxThreads();
  for (var i = 0; i < threads.length; i++) {
    var child = XmlService.createElement('thread')
        .setAttribute('messageCount', threads[i].getMessageCount())
        .setAttribute('isUnread', threads[i].isUnread())
        .setText(threads[i].getFirstMessageSubject());
    root.addContent(child);
  }
  var document = XmlService.createDocument(root);
  var xml = XmlService.getPrettyFormat().format(document);
  Logger.log(xml);
}

خواص

ویژگی تایپ کنید شرح
ContentTypes ContentType شمارشی که نشان دهنده انواع گره های محتوای XML است.

مواد و روش ها

روش نوع برگشت توضیح مختصر
createCdata(text) Cdata یک گره CDATASection غیر متصل با مقدار داده شده ایجاد می کند.
createComment(text) Comment یک گره Comment غیر پیوست با مقدار داده شده ایجاد می کند.
createDocType(elementName) DocType یک گره DocumentType غیر متصل برای گره Element ریشه با نام داده شده ایجاد می کند.
createDocType(elementName, systemId) DocType یک گره DocumentType غیر متصل برای گره Element ریشه با نام داده شده و شناسه سیستم داده شده برای داده های زیرمجموعه خارجی ایجاد می کند.
createDocType(elementName, publicId, systemId) DocType یک گره DocumentType متصل نشده برای گره Element ریشه با نام داده شده و شناسه عمومی و شناسه سیستم برای داده های زیرمجموعه خارجی ایجاد می کند.
createDocument() Document یک سند XML خالی ایجاد می کند.
createDocument(rootElement) Document یک سند XML با گره Element ریشه داده شده ایجاد می کند.
createElement(name) Element یک گره Element غیر متصل با نام محلی داده شده و بدون فضای نام ایجاد می کند.
createElement(name, namespace) Element یک گره Element غیر متصل با نام محلی و فضای نام داده شده ایجاد می کند.
createText(text) Text یک گره Text غیر متصل با مقدار داده شده ایجاد می کند.
getCompactFormat() Format یک شی Format برای خروجی یک سند XML فشرده ایجاد می کند.
getNamespace(uri) Namespace با URI داده شده یک Namespace ایجاد می کند.
getNamespace(prefix, uri) Namespace یک Namespace با پیشوند و URI داده شده ایجاد می کند.
getNoNamespace() Namespace یک Namespace ایجاد می کند که نشان دهنده عدم وجود فضای نام واقعی است.
getPrettyFormat() Format یک شی Format برای خروجی یک سند XML قابل خواندن توسط انسان ایجاد می کند.
getRawFormat() Format یک شی Format برای خروجی یک سند XML خام ایجاد می کند.
getXmlNamespace() Namespace یک Namespace با پیشوند استاندارد xml ایجاد می کند.
parse(xml) Document یک Document از XML داده شده، بدون اعتبارسنجی XML ایجاد می کند.

مستندات دقیق

createCdata(text)

یک گره CDATASection غیر متصل با مقدار داده شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
text String مقدار برای تنظیم

برگشت

Cdata - گره CDATASection تازه ایجاد شده


createComment(text)

یک گره Comment غیر پیوست با مقدار داده شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
text String مقدار برای تنظیم

برگشت

Comment - گره Comment تازه ایجاد شده


createDocType(elementName)

یک گره DocumentType غیر متصل برای گره Element ریشه با نام داده شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
elementName String نام گره Element ریشه که باید در اعلان DocType مشخص شود

برگشت

DocType - گره DocumentType تازه ایجاد شده


createDocType(elementName, systemId)

یک گره DocumentType غیر متصل برای گره Element ریشه با نام داده شده و شناسه سیستم داده شده برای داده های زیرمجموعه خارجی ایجاد می کند.

مولفه های

نام تایپ کنید شرح
elementName String نام گره Element ریشه که باید در اعلان DocType مشخص شود
systemId String شناسه سیستم داده های زیر مجموعه خارجی برای تنظیم

برگشت

DocType - گره DocumentType تازه ایجاد شده


createDocType(elementName, publicId, systemId)

یک گره DocumentType متصل نشده برای گره Element ریشه با نام داده شده و شناسه عمومی و شناسه سیستم برای داده های زیرمجموعه خارجی ایجاد می کند.

مولفه های

نام تایپ کنید شرح
elementName String نام گره Element ریشه که باید در اعلان DocType مشخص شود
publicId String شناسه عمومی داده های زیرمجموعه خارجی برای تنظیم
systemId String شناسه سیستم داده های زیر مجموعه خارجی برای تنظیم

برگشت

DocType - گره DocumentType تازه ایجاد شده


createDocument()

یک سند XML خالی ایجاد می کند.

برگشت

Document - سند تازه ایجاد شده


createDocument(rootElement)

یک سند XML با گره Element ریشه داده شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
rootElement Element گره Element ریشه برای تنظیم

برگشت

Document - سند تازه ایجاد شده


createElement(name)

یک گره Element غیر متصل با نام محلی داده شده و بدون فضای نام ایجاد می کند.

مولفه های

نام تایپ کنید شرح
name String نام محلی برای تنظیم

برگشت

Element - گره Element تازه ایجاد شده


createElement(name, namespace)

یک گره Element غیر متصل با نام محلی و فضای نام داده شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
name String نام محلی برای تنظیم
namespace Namespace فضای نام برای تنظیم

برگشت

Element - گره Element تازه ایجاد شده


createText(text)

یک گره Text غیر متصل با مقدار داده شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
text String مقدار برای تنظیم

برگشت

Text - گره Text تازه ایجاد شده


getCompactFormat()

یک شی Format برای خروجی یک سند XML فشرده ایجاد می کند. فرمت‌کننده به‌طور پیش‌فرض روی کدگذاری UTF-8 ، بدون تورفتگی، و بدون خط‌شکن اضافی است، اما شامل اعلان XML و رمزگذاری آن می‌شود.

// Log an XML document in compact form.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getCompactFormat()
    .format(document);
Logger.log(output);

برگشت

Format - فرمت کننده تازه ایجاد شده


getNamespace(uri)

با URI داده شده یک Namespace ایجاد می کند.

مولفه های

نام تایپ کنید شرح
uri String URI برای فضای نام

برگشت

Namespace - فضای نام جدید ایجاد شده


getNamespace(prefix, uri)

یک Namespace با پیشوند و URI داده شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
prefix String پیشوند فضای نام
uri String URI برای فضای نام

برگشت

Namespace - فضای نام جدید ایجاد شده


getNoNamespace()

یک Namespace ایجاد می کند که نشان دهنده عدم وجود فضای نام واقعی است.

برگشت

Namespace - فضای نام جدید ایجاد شده


getPrettyFormat()

یک شی Format برای خروجی یک سند XML قابل خواندن توسط انسان ایجاد می کند. فرمت‌کننده به‌طور پیش‌فرض روی کدگذاری UTF-8 ، تورفتگی دو فضایی، \r\n جداکننده‌های خط بعد از هر گره قرار می‌گیرد و شامل اعلان XML و رمزگذاری آن می‌شود.

// Log an XML document in human-readable form.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getPrettyFormat()
    .format(document);
Logger.log(output);

برگشت

Format - فرمت کننده تازه ایجاد شده


getRawFormat()

یک شی Format برای خروجی یک سند XML خام ایجاد می کند. فرمت‌کننده کدگذاری UTF-8 را به‌طور پیش‌فرض تنظیم می‌کند، بدون تورفتگی و هیچ خط شکنی غیر از مواردی که در خود سند XML ارائه شده است، و شامل اعلان XML و رمزگذاری آن است.

// Log an XML document in raw form.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getRawFormat()
    .format(document);
Logger.log(output);

برگشت

Format - فرمت کننده تازه ایجاد شده


getXmlNamespace()

یک Namespace با پیشوند استاندارد xml ایجاد می کند.

برگشت

Namespace - فضای نام جدید ایجاد شده


parse(xml)

یک Document از XML داده شده، بدون اعتبارسنجی XML ایجاد می کند.

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

مولفه های

نام تایپ کنید شرح
xml String XML برای تجزیه

برگشت

Document - سند تازه ایجاد شده