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 .
Format یک قالب‌کننده برای خروجی یک سند XML، با سه قالب از پیش تعریف‌شده که می‌توانند بیشتر سفارشی شوند.
Namespace نمایشی از فضای نام XML.
Processing Instruction نمایش گره Processing Instruction XML.
Text نمایشی از یک گره Text XML.
Xml Service این سرویس به اسکریپت ها اجازه می دهد تا اسناد XML را تجزیه، ناوبری و برنامه نویسی کنند.

Attribute

روش ها

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

Cdata

روش ها

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

Comment

روش ها

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

Content

روش ها

روش نوع برگشت شرح مختصر
as Cdata() Cdata گره را به عنوان یک گره CDATASection برای اهداف تکمیل خودکار ارسال می کند.
as Comment() Comment گره را به عنوان یک گره Comment برای اهداف تکمیل خودکار ارسال می کند.
as Doc Type() Doc Type گره را به عنوان یک گره Document Type برای اهداف تکمیل خودکار ارسال می کند.
as Element() Element گره را به عنوان یک گره Element برای اهداف تکمیل خودکار ارسال می کند.
as Entity Ref() Entity Ref گره را به عنوان یک گره Entity Reference برای اهداف تکمیل خودکار ارسال می کند.
as Processing Instruction() Processing Instruction گره را به عنوان یک گره Processing Instruction برای اهداف تکمیل خودکار ارسال می کند.
as Text() Text گره را به عنوان یک گره Text به منظور تکمیل خودکار ارسال می کند.
detach() Content گره را از گره Element والد خود جدا می کند.
get Parent Element() Element گره 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 .
PROCESSINGINSTRUCTION Enum یک گره Processing Instruction XML.
TEXT Enum یک گره Text XML.

Doc Type

روش ها

روش نوع برگشت شرح مختصر
detach() Content گره را از گره Element والد خود جدا می کند.
get Element Name() String نام گره Element ریشه مشخص شده در اعلان Doc Type را دریافت می کند.
get Internal Subset() String داده های زیر مجموعه داخلی گره Document Type را دریافت می کند.
get Parent Element() Element گره 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 گره Element ریشه سند را جدا می کند و برمی گرداند.
get All Content() Content[] تمام گره هایی را که فرزندان مستقیم سند هستند دریافت می کند.
get Content(index) Content گره را در شاخص داده شده در بین تمام گره هایی که فرزندان مستقیم سند هستند، دریافت می کند.
get Content Size() Integer تعداد گره هایی را می گیرد که فرزندان مستقیم سند هستند.
get Descendants() Content[] تمام گره هایی را که مستقیم یا غیرمستقیم فرزندان سند هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
get Doc Type() Doc Type اعلان Doc Type سند را دریافت می کند.
get Root Element() Element گره Element ریشه سند را دریافت می کند.
has Root Element() Boolean تعیین می کند که آیا سند دارای گره Element ریشه است یا خیر.
remove Content() Content[] تمام گره هایی را که فرزندان مستقیم سند هستند حذف می کند.
remove Content(content) Boolean اگر گره فرزند فوری سند باشد، گره داده شده را حذف می کند.
remove Content(index) Content گره موجود در شاخص داده شده را از بین تمام گره هایی که فرزندان مستقیم سند هستند حذف می کند.
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 گره را از گره Element والد خود جدا می کند.
get All Content() Content[] همه گره هایی را که فرزندان مستقیم گره {@code Element} هستند را دریافت می کند.
get Attribute(name) Attribute ویژگی این گره Element را با نام داده شده و بدون فضای نام دریافت می کند.
get Attribute(name, namespace) Attribute ویژگی این گره Element با نام و فضای نام داده شده دریافت می کند.
get Attributes() Attribute[] تمام ویژگی‌های این گره Element را به ترتیبی که در سند ظاهر می‌شوند، دریافت می‌کند.
get Child(name) Element اولین گره Element را با نام داده شده و بدون فضای نام که فرزند مستقیم این گره Element است، دریافت می کند.
get Child(name, namespace) Element اولین گره Element را با نام و فضای نام داده شده دریافت می کند که فرزند مستقیم این گره Element است.
get Child Text(name) String اگر گره فرزند مستقیم گره Element باشد، مقدار متن گره را با نام داده شده و بدون فضای نام دریافت می کند.
get Child Text(name, namespace) String مقدار متن گره را با نام و فضای نام داده شده دریافت می کند، اگر گره فرزند مستقیم گره Element باشد.
get Children() Element[] تمام گره های Element را که فرزندان مستقیم این گره Element هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
get Children(name) Element[] تمام گره های Element را با نام مشخص شده و بدون فضای نام که فرزندان مستقیم این گره Element هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
get Children(name, namespace) Element[] همه گره های Element را با نام و فضای نام داده شده که فرزندان مستقیم این گره Element هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
get Content(index) Content گره را در شاخص داده شده در بین همه گره هایی که فرزندان مستقیم گره {@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 فضای نام گره Element را دریافت می کند.
get Namespace(prefix) Namespace فضای نام را با پیشوند داده شده برای گره Element دریافت می کند.
get Parent Element() Element گره 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 گره را در نمایه داده شده از بین همه گره هایی که فرزندان مستقیم گره {@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 گره را از گره Element والد خود جدا می کند.
get Name() String نام گره Entity Reference را دریافت می کند.
get Parent Element() Element گره Element والد گره را دریافت می کند.
get Public Id() String شناسه عمومی گره Entity Reference را دریافت می کند.
get System Id() String شناسه سیستم گره 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 گره را از گره Element والد خود جدا می کند.
get Data() String داده های خام را برای هر دستورالعمل در گره Processing Instruction دریافت می کند.
get Parent Element() Element گره Element والد گره را دریافت می کند.
get Target() String هدف گره Processing Instruction را دریافت می کند.
get Value() String مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.

Text

روش ها

روش نوع برگشت شرح مختصر
append(text) Text متن داده شده را به هر محتوایی که از قبل در گره وجود دارد اضافه می کند.
detach() Content گره را از گره Element والد خود جدا می کند.
get Parent Element() Element گره 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 ریشه با نام داده شده و شناسه عمومی و شناسه سیستم برای داده های زیرمجموعه خارجی ایجاد می کند.
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 ایجاد می کند.