Class XmlService

سرویس Xml

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

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

خواص

اموال تایپ کنید توضیحات
Content Types Content Type شمارشی که نشان دهنده انواع گره های محتوای XML است.

روش ها

روش نوع برگشت شرح مختصر
create Cdata(text) Cdata یک گره CDATASection غیر متصل با مقدار داده شده ایجاد می کند.
create Comment(text) Comment یک گره Comment غیر پیوست با مقدار داده شده ایجاد می کند.
create Doc Type(elementName) Doc Type یک گره Document Type غیر متصل برای گره Element ریشه با نام داده شده ایجاد می کند.
create Doc Type(elementName, systemId) Doc Type یک گره Document Type متصل نشده برای گره Element ریشه با نام داده شده و شناسه سیستم داده شده برای داده های زیرمجموعه خارجی ایجاد می کند.
create Doc Type(elementName, publicId, systemId) Doc Type یک گره Document Type متصل نشده برای گره Element ریشه با نام داده شده و شناسه عمومی و شناسه سیستم برای داده های زیرمجموعه خارجی ایجاد می کند.
create Document() Document یک سند XML خالی ایجاد می کند.
create Document(rootElement) Document یک سند XML با گره Element ریشه داده شده ایجاد می کند.
create Element(name) Element یک گره Element غیر متصل با نام محلی داده شده و بدون فضای نام ایجاد می کند.
create Element(name, namespace) Element یک گره Element غیر متصل با نام محلی و فضای نام داده شده ایجاد می کند.
create Text(text) Text یک گره Text غیر متصل با مقدار داده شده ایجاد می کند.
get Compact Format() Format یک شی Format برای خروجی یک سند XML فشرده ایجاد می کند.
get Namespace(uri) Namespace با URI داده شده یک Namespace ایجاد می کند.
get Namespace(prefix, uri) Namespace یک Namespace با پیشوند و URI داده شده ایجاد می کند.
get No Namespace() Namespace یک Namespace ایجاد می کند که نشان دهنده عدم وجود فضای نام واقعی است.
get Pretty Format() Format یک شی Format برای خروجی یک سند XML قابل خواندن توسط انسان ایجاد می کند.
get Raw Format() Format یک شی Format برای خروجی یک سند XML خام ایجاد می کند.
get Xml Namespace() Namespace یک Namespace با پیشوند استاندارد xml ایجاد می کند.
parse(xml) Document یک Document از XML داده شده، بدون اعتبارسنجی XML ایجاد می کند.

مستندات دقیق

create Cdata(text)

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

پارامترها

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

بازگشت

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


create Comment(text)

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

پارامترها

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

بازگشت

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


create Doc Type(elementName)

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

پارامترها

نام تایپ کنید توضیحات
element Name String نام گره Element ریشه که باید در اعلان Doc Type مشخص شود

بازگشت

Doc Type - گره Document Type جدید ایجاد شده


create Doc Type(elementName, systemId)

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

پارامترها

نام تایپ کنید توضیحات
element Name String نام گره Element ریشه که باید در اعلان Doc Type مشخص شود
system Id String شناسه سیستم داده های زیر مجموعه خارجی برای تنظیم

بازگشت

Doc Type - گره Document Type جدید ایجاد شده


create Doc Type(elementName, publicId, systemId)

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

پارامترها

نام تایپ کنید توضیحات
element Name String نام گره Element ریشه که باید در اعلان Doc Type مشخص شود
public Id String شناسه عمومی داده های زیرمجموعه خارجی برای تنظیم
system Id String شناسه سیستم داده های زیر مجموعه خارجی برای تنظیم

بازگشت

Doc Type - گره Document Type جدید ایجاد شده


create Document()

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

بازگشت

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


create Document(rootElement)

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

پارامترها

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

بازگشت

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


create Element(name)

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

پارامترها

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

بازگشت

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


create Element(name, namespace)

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

پارامترها

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

بازگشت

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


create Text(text)

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

پارامترها

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

بازگشت

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


get Compact Format()

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

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

بازگشت

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


get Namespace(uri)

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

پارامترها

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

بازگشت

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


get Namespace(prefix, uri)

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

پارامترها

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

بازگشت

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


get No Namespace()

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

بازگشت

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


get Pretty Format()

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

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

بازگشت

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


get Raw Format()

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

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

بازگشت

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


get Xml Namespace()

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

بازگشت

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


parse(xml)

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

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

پارامترها

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

بازگشت

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