XML Service

سرویس XML

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

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

کلاس‌ها

نام شرح مختصر
Attribute نمایشی از یک ویژگی XML.
Cdata نمایشی از یک گره XML CDATASection .
Comment نمایشی از یک گره Comment XML.
Content نمایشی از یک گره XML عمومی.
Content Type یک شمارش که انواع گره‌های محتوای XML را نشان می‌دهد.
Doc Type نمایشی از یک گره Document Type XML.
Document نمایشی از یک سند XML.
Element نمایشی از یک گره Element XML.
Entity Ref نمایشی از یک گره Entity Reference XML.
Format یک قالب‌بندی برای خروجی گرفتن از یک سند XML، با سه قالب از پیش تعریف‌شده که می‌توانند بیشتر سفارشی‌سازی شوند.
Namespace نمایشی از یک فضای نام XML.
Processing Instruction نمایشی از یک گره Processing Instruction XML.
Text نمایشی از یک گره Text XML.
Xml Service این سرویس به اسکریپت‌ها اجازه می‌دهد تا اسناد XML را تجزیه، پیمایش و از طریق برنامه‌نویسی ایجاد کنند.

Attribute

روش‌ها

روش نوع بازگشتی شرح مختصر
get Name() String نام محلی ویژگی را برمی‌گرداند.
get Namespace() Namespace |null فضای نام مربوط به ویژگی را دریافت می‌کند.
get Value() String مقدار ویژگی را دریافت می‌کند.
set Name(name) Attribute نام محلی ویژگی را تنظیم می‌کند.
set Namespace(namespace) Attribute فضای نامی را برای ویژگی تنظیم می‌کند.
set Value(value) Attribute مقدار ویژگی را تنظیم می‌کند.

Cdata

روش‌ها

روش نوع بازگشتی شرح مختصر
append(text) Text متن داده شده را به هر محتوایی که از قبل در گره وجود دارد، اضافه می‌کند.
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Text() String مقدار متن گره Text را دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
set Text(text) Text مقدار متن گره Text را تنظیم می‌کند.

Comment

روش‌ها

روش نوع بازگشتی شرح مختصر
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Text() String مقدار متنی گره Comment را برمی‌گرداند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
set Text(text) Comment مقدار متن گره Comment را تنظیم می‌کند.

Content

روش‌ها

روش نوع بازگشتی شرح مختصر
as Cdata() Cdata |null برای تکمیل خودکار، گره را به عنوان یک گره CDATASection تبدیل می‌کند.
as Comment() Comment |null برای تکمیل خودکار، گره را به عنوان یک گره Comment تبدیل می‌کند.
as Doc Type() Doc Type |null برای تکمیل خودکار، گره را به عنوان یک گره Document Type تبدیل می‌کند.
as Element() Element |null برای تکمیل خودکار، گره را به عنوان یک گره Element تبدیل می‌کند.
as Entity Ref() Entity Ref |null برای تکمیل خودکار، گره را به عنوان یک گره Entity Reference تبدیل می‌کند.
as Processing Instruction() Processing Instruction |null گره را به عنوان یک گره Processing Instruction برای اهداف تکمیل خودکار تبدیل می‌کند.
as Text() Text |null برای تکمیل خودکار، گره را به عنوان یک گره Text تبدیل می‌کند.
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Type() Content Type نوع محتوای گره را دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.

Content Type

خواص

ملک نوع توضیحات
CDATA Enum یک گره XML CDATASection .
COMMENT Enum یک گره Comment XML.
DOCTYPE Enum یک گره Document Type XML.
ELEMENT Enum یک گره Element XML.
ENTITYREF Enum یک گره Entity Reference XML.
PROCESSINGINSTRUCTION Enum یک گره Processing Instruction XML.
TEXT Enum یک گره Text XML.

Doc Type

روش‌ها

روش نوع بازگشتی شرح مختصر
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get Element Name() String نام گره Element ریشه که در تعریف Doc Type مشخص شده است را برمی‌گرداند.
get Internal Subset() String داده‌های زیرمجموعه داخلی را برای گره Document Type دریافت می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Public Id() String شناسه عمومی داده‌های زیرمجموعه خارجی را برای گره Document Type دریافت می‌کند.
get System Id() String شناسه سیستم داده‌های زیرمجموعه خارجی را برای گره Document Type دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
set Element Name(name) Doc Type نام گره Element ریشه را برای مشخص شدن در اعلان Doc Type تنظیم می‌کند.
set Internal Subset(data) Doc Type داده‌های زیرمجموعه داخلی را برای گره Document Type تنظیم می‌کند.
set Public Id(id) Doc Type شناسه عمومی داده‌های زیرمجموعه خارجی را برای گره Document Type تنظیم می‌کند.
set System Id(id) Doc Type شناسه سیستم داده‌های زیرمجموعه خارجی را برای گره Document Type تنظیم می‌کند.

Document

روش‌ها

روش نوع بازگشتی شرح مختصر
add Content(content) Document گره داده شده را به انتهای سند اضافه می‌کند.
add Content(index, content) Document گره داده شده را در اندیس داده شده، در میان تمام گره‌هایی که فرزند بلافصل سند هستند، درج می‌کند.
clone Content() Content[] کپی‌های غیراتصالی از تمام گره‌هایی که فرزندان بلافصل سند هستند، ایجاد می‌کند.
detach Root Element() Element |null گره Element ریشه سند را جدا کرده و برمی‌گرداند.
get All Content() Content[] تمام گره‌هایی که فرزند بلافصل سند هستند را دریافت می‌کند.
get Content(index) Content |null گره موجود در اندیس داده شده را از بین تمام گره‌هایی که فرزند بلافصل سند هستند، برمی‌گرداند.
get Content Size() Integer تعداد گره‌هایی که فرزند بلافصل سند هستند را برمی‌گرداند.
get Descendants() Content[] تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم سند هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Doc Type() Doc Type |null نوع سند Doc Type را دریافت می‌کند.
get Root Element() Element |null گره Element ریشه سند را دریافت می‌کند.
has Root Element() Boolean تعیین می‌کند که آیا سند دارای گره Element ریشه است یا خیر.
remove Content() Content[] تمام گره‌هایی که فرزند بلافصل سند هستند را حذف می‌کند.
remove Content(content) Boolean اگر گره، فرزند بلافصل سند باشد، گره داده شده را حذف می‌کند.
remove Content(index) Content |null گره موجود در اندیس داده شده را از بین تمام گره‌هایی که فرزند بلافصل سند هستند، حذف می‌کند.
set Doc Type(docType) Document نوع سند Doc Type را تعیین می‌کند.
set Root Element(element) Document گره Element ریشه سند را تنظیم می‌کند.

Element

روش‌ها

روش نوع بازگشتی شرح مختصر
add Content(content) Element گره داده شده را به عنوان آخرین فرزند گره Element اضافه می‌کند.
add Content(index, content) Element گره داده شده را در اندیس داده شده، در بین تمام گره‌هایی که فرزند بلافصل گره Element هستند، درج می‌کند.
clone Content() Content[] کپی‌های غیراتصالی از تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند، ایجاد می‌کند.
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get All Content() Content[] تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند را برمی‌گرداند.
get Attribute(name) Attribute |null ویژگی این گره Element را با نام داده شده و بدون فضای نام دریافت می‌کند.
get Attribute(name, namespace) Attribute |null ویژگی این گره Element را با نام و فضای نام داده شده دریافت می‌کند.
get Attributes() Attribute[] تمام ویژگی‌های این گره Element را به ترتیبی که در سند ظاهر می‌شوند، دریافت می‌کند.
get Child(name) Element |null اولین گره Element ) را با نام داده شده و بدون فضای نامی که فرزند بلافصل این گره Element باشد، برمی‌گرداند.
get Child(name, namespace) Element |null اولین گره Element را با نام و فضای نام داده شده که فرزند بلافصل این گره Element است، برمی‌گرداند.
get Child Text(name) String|null اگر گره، فرزند بلافصل گره Element باشد، مقدار متنی گره با نام داده شده و بدون فضای نام را برمی‌گرداند.
get Child Text(name, namespace) String|null اگر گره، فرزند بلافصل گره Element باشد، مقدار متنی گره را با نام و فضای نام داده شده برمی‌گرداند.
get Children() Element[] تمام گره‌های Element که فرزندان بلافصل این گره Element هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Children(name) Element[] تمام گره‌های Element با نام داده شده و بدون فضای نام (namespace) که فرزندان بلافصل این گره Element node) هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Children(name, namespace) Element[] تمام گره‌های Element با نام و فضای نام داده شده که فرزندان بلافصل این گره Element هستند را به ترتیبی که در سند ظاهر می‌شوند، دریافت می‌کند.
get Content(index) Content |null گره‌ای را که در اندیس داده شده قرار دارد، از بین تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند، برمی‌گرداند.
get Content Size() Integer تعداد گره‌هایی که فرزند بلافصل گره {@code Element} هستند را برمی‌گرداند.
get Descendants() Content[] تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره {@code Element} هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Document() Document سند XML که شامل گره {@code Element} است را دریافت می‌کند.
get Name() String نام محلی گره Element را برمی‌گرداند.
get Namespace() Namespace فضای نام (namespace) مربوط به گره Element را دریافت می‌کند.
get Namespace(prefix) Namespace فضای نامی را با پیشوند داده شده برای گره Element دریافت می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Qualified Name() String نام محلی و پیشوند فضای نام گره Element را به شکل [namespacePrefix]:[localName] دریافت می‌کند.
get Text() String مقدار متن گره Element را دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
is Ancestor Of(other) Boolean مشخص می‌کند که آیا این گره Element والد مستقیم یا غیرمستقیم یک گره Element مشخص است یا خیر.
is Root Element() Boolean تعیین می‌کند که آیا گره Element ، گره ریشه سند است یا خیر.
remove Attribute(attribute) Boolean در صورت وجود، ویژگی داده شده برای این گره Element را حذف می‌کند.
remove Attribute(attributeName) Boolean ویژگی این گره Element را با نام داده شده و بدون فضای نام، در صورت وجود، حذف می‌کند.
remove Attribute(attributeName, namespace) Boolean ویژگی این گره Element با نام و فضای نام داده شده را در صورت وجود، حذف می‌کند.
remove Content() Content[] تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند را حذف می‌کند.
remove Content(content) Boolean اگر گره، فرزند بلافصل گره {@code Element} باشد، گره داده شده را حذف می‌کند.
remove Content(index) Content |null گره‌ای را که در اندیس داده شده قرار دارد، از بین تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند، حذف می‌کند.
set Attribute(attribute) Element ویژگی داده شده را برای این گره Element تنظیم می‌کند.
set Attribute(name, value) Element ویژگی این گره Element را با نام و مقدار داده شده و بدون فضای نام تنظیم می‌کند.
set Attribute(name, value, namespace) Element ویژگی این گره Element را با نام، مقدار و فضای نام داده شده تنظیم می‌کند.
set Name(name) Element نام محلی گره Element را تنظیم می‌کند.
set Namespace(namespace) Element فضای نام را برای گره Element تنظیم می‌کند.
set Text(text) Element مقدار متن گره Element را تنظیم می‌کند.

Entity Ref

روش‌ها

روش نوع بازگشتی شرح مختصر
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get Name() String نام گره Entity Reference را دریافت می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Public Id() String|null شناسه عمومی گره Entity Reference را دریافت می‌کند.
get System Id() String|null شناسه سیستم گره Entity Reference را دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
set Name(name) Entity Ref نام گره Entity Reference را تنظیم می‌کند.
set Public Id(id) Entity Ref شناسه عمومی گره Entity Reference را تنظیم می‌کند.
set System Id(id) Entity Ref شناسه سیستم گره Entity Reference را تنظیم می‌کند.

Format

روش‌ها

روش نوع بازگشتی شرح مختصر
format(document) String Document داده شده را به صورت یک رشته فرمت شده خروجی می‌دهد.
format(element) String گره Element داده شده را به عنوان یک رشته فرمت شده خروجی می‌دهد.
set Encoding(encoding) Format کدگذاری کاراکتری را که قالب‌بندی‌کننده باید استفاده کند، تنظیم می‌کند.
set Indent(indent) Format رشته‌ای را که برای ایجاد تورفتگی در گره‌های فرزند نسبت به والدینشان استفاده می‌شود، تنظیم می‌کند.
set Line Separator(separator) Format رشته را طوری تنظیم می‌کند که هر زمان قالب‌بندی به طور معمول یک شکست خط ایجاد می‌کند، درج شود.
set Omit Declaration(omitDeclaration) Format تعیین می‌کند که آیا قالب‌بندی‌کننده باید اعلان XML، مانند <?xml version="1.0" encoding="UTF-8"?> را حذف کند یا خیر.
set Omit Encoding(omitEncoding) Format تعیین می‌کند که آیا قالب‌بندی‌کننده باید کدگذاری را در اعلان XML حذف کند یا خیر، مانند فیلد کدگذاری در <?xml version="1.0" encoding="UTF-8"?> .

Namespace

روش‌ها

روش نوع بازگشتی شرح مختصر
get Prefix() String پیشوند فضای نام را دریافت می‌کند.
get URI() String URI مربوط به فضای نام را دریافت می‌کند.

Processing Instruction

روش‌ها

روش نوع بازگشتی شرح مختصر
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get Data() String داده‌های خام را برای هر دستورالعمل در گره Processing Instruction دریافت می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Target() String هدف گره Processing Instruction را دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.

Text

روش‌ها

روش نوع بازگشتی شرح مختصر
append(text) Text متن داده شده را به هر محتوایی که از قبل در گره وجود دارد، اضافه می‌کند.
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Text() String مقدار متن گره Text را دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
set Text(text) Text مقدار متن گره Text را تنظیم می‌کند.

Xml Service

خواص

ملک نوع توضیحات
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 ریشه با نام داده شده، و شناسه عمومی (public ID) و شناسه سیستم (system ID) داده شده برای داده‌های زیرمجموعه خارجی ایجاد می‌کند.
create Document() Document یک سند XML خالی ایجاد می‌کند.
create Document(rootElement) Document یک سند XML با گره Element ریشه داده شده ایجاد می‌کند.
create Element(name) Element یک گره Element غیرمتصل با نام محلی داده شده و بدون فضای نام (namespace) ایجاد می‌کند.
create Element(name, namespace) Element یک گره Element غیرمتصل با نام محلی و فضای نام داده شده ایجاد می‌کند.
create Text(text) Text یک گره Text غیرمتصل با مقدار داده شده ایجاد می‌کند.
get Compact Format() Format یک شیء Format برای خروجی گرفتن از یک سند XML فشرده ایجاد می‌کند.
get Namespace(uri) Namespace یک Namespace با URI داده شده ایجاد می‌کند.
get Namespace(prefix, uri) Namespace یک Namespace با پیشوند و آدرس داده شده ایجاد می‌کند.
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 بدون اعتبارسنجی XML، یک Document از XML داده شده ایجاد می‌کند.