این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

XML Service

این سرویس به اسکریپت ها اجازه می دهد تا اسناد 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 عمومی.
`ContentType`	شمارشی که نشان دهنده انواع گره های محتوای XML است.
`DocType`	نمایشی از یک گره XML `DocumentType` .
`Document`	نمایش یک سند XML.
`Element`	نمایشی از یک گره `Element` XML.
`EntityRef`	نمایشی از یک گره `EntityReference` XML.
`Format`	یک قالب‌کننده برای خروجی یک سند XML، با سه قالب از پیش تعریف‌شده که می‌توانند بیشتر سفارشی شوند.
`Namespace`	نمایشی از فضای نام XML.
`ProcessingInstruction`	نمایشی از یک گره XML `ProcessingInstruction` .
`Text`	نمایشی از یک گره `Text` XML.
`XmlService`	این سرویس به اسکریپت ها اجازه می دهد تا اسناد XML را تجزیه، ناوبری و برنامه نویسی کنند.

`Attribute`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`getName()`	`String`	نام محلی ویژگی را دریافت می کند.
`getNamespace()`	`Namespace`	فضای نام مشخصه را دریافت می کند.
`getValue()`	`String`	مقدار صفت را دریافت می کند.
`setName(name)`	`Attribute`	نام محلی ویژگی را تنظیم می کند.
`setNamespace(namespace)`	`Attribute`	فضای نام را برای ویژگی تنظیم می کند.
`setValue(value)`	`Attribute`	مقدار ویژگی را تعیین می کند.

`Cdata`

مواد و روش ها

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

`Comment`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`detach()`	`Content`	گره را از گره `Element` والد خود جدا می کند.
`getParentElement()`	`Element`	گره `Element` والد گره را دریافت می کند.
`getText()`	`String`	مقدار متن گره `Comment` را دریافت می کند.
`getValue()`	`String`	مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`setText(text)`	`Comment`	مقدار متن گره `Comment` را تنظیم می کند.

`Content`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`asCdata()`	`Cdata`	گره را به عنوان یک گره `CDATASection` برای اهداف تکمیل خودکار ارسال می کند.
`asComment()`	`Comment`	گره را به عنوان یک گره `Comment` برای اهداف تکمیل خودکار ارسال می کند.
`asDocType()`	`DocType`	گره را به عنوان یک گره `DocumentType` برای اهداف تکمیل خودکار ارسال می کند.
`asElement()`	`Element`	گره را به عنوان یک گره `Element` برای اهداف تکمیل خودکار ارسال می کند.
`asEntityRef()`	`EntityRef`	گره را به عنوان یک گره `EntityReference` برای اهداف تکمیل خودکار ارسال می کند.
`asProcessingInstruction()`	`ProcessingInstruction`	گره را به عنوان یک گره `ProcessingInstruction` برای اهداف تکمیل خودکار ارسال می کند.
`asText()`	`Text`	گره را به عنوان یک گره `Text` به منظور تکمیل خودکار ارسال می کند.
`detach()`	`Content`	گره را از گره `Element` والد خود جدا می کند.
`getParentElement()`	`Element`	گره `Element` والد گره را دریافت می کند.
`getType()`	`ContentType`	نوع محتوای گره را دریافت می کند.
`getValue()`	`String`	مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.

`ContentType`

خواص

ویژگی	تایپ کنید	شرح
`CDATA`	`Enum`	یک گره XML `CDATASection` .
`COMMENT`	`Enum`	یک گره `Comment` XML.
`DOCTYPE`	`Enum`	یک گره XML `DocumentType` .
`ELEMENT`	`Enum`	یک گره `Element` XML.
`ENTITYREF`	`Enum`	یک گره XML `EntityReference` .
`PROCESSINGINSTRUCTION`	`Enum`	یک گره XML `ProcessingInstruction` .
`TEXT`	`Enum`	یک گره `Text` XML.

`DocType`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`detach()`	`Content`	گره را از گره `Element` والد خود جدا می کند.
`getElementName()`	`String`	نام گره `Element` ریشه مشخص شده در اعلان `DocType` را دریافت می کند.
`getInternalSubset()`	`String`	داده های زیر مجموعه داخلی گره `DocumentType` را دریافت می کند.
`getParentElement()`	`Element`	گره `Element` والد گره را دریافت می کند.
`getPublicId()`	`String`	شناسه عمومی داده های زیرمجموعه خارجی را برای گره `DocumentType` دریافت می کند.
`getSystemId()`	`String`	شناسه سیستم داده های زیرمجموعه خارجی را برای گره `DocumentType` دریافت می کند.
`getValue()`	`String`	مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`setElementName(name)`	`DocType`	نام گره `Element` ریشه را برای تعیین در اعلان `DocType` تنظیم می کند.
`setInternalSubset(data)`	`DocType`	داده های زیرمجموعه داخلی را برای گره `DocumentType` تنظیم می کند.
`setPublicId(id)`	`DocType`	شناسه عمومی داده های زیرمجموعه خارجی را برای گره `DocumentType` تنظیم می کند.
`setSystemId(id)`	`DocType`	شناسه سیستم داده های زیرمجموعه خارجی را برای گره `DocumentType` تنظیم می کند.

`Document`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`addContent(content)`	`Document`	گره داده شده را به انتهای سند اضافه می کند.
`addContent(index, content)`	`Document`	گره داده شده را در شاخص داده شده در میان تمام گره هایی که فرزندان مستقیم سند هستند درج می کند.
`cloneContent()`	`Content[]`	کپی های بدون پیوست از تمام گره هایی که فرزندان مستقیم سند هستند ایجاد می کند.
`detachRootElement()`	`Element`	گره `Element` ریشه سند را جدا می کند و برمی گرداند.
`getAllContent()`	`Content[]`	تمام گره هایی را که فرزندان مستقیم سند هستند دریافت می کند.
`getContent(index)`	`Content`	گره را در شاخص داده شده در بین تمام گره هایی که فرزندان مستقیم سند هستند، دریافت می کند.
`getContentSize()`	`Integer`	تعداد گره هایی را می گیرد که فرزندان مستقیم سند هستند.
`getDescendants()`	`Content[]`	تمام گره هایی را که مستقیم یا غیرمستقیم فرزندان سند هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`getDocType()`	`DocType`	اعلامیه `DocType` سند را دریافت می کند.
`getRootElement()`	`Element`	گره `Element` ریشه سند را دریافت می کند.
`hasRootElement()`	`Boolean`	تعیین می کند که آیا سند دارای گره `Element` ریشه است یا خیر.
`removeContent()`	`Content[]`	تمام گره هایی را که فرزندان مستقیم سند هستند حذف می کند.
`removeContent(content)`	`Boolean`	اگر گره فرزند فوری سند باشد، گره داده شده را حذف می کند.
`removeContent(index)`	`Content`	گره موجود در شاخص داده شده را از بین تمام گره هایی که فرزندان مستقیم سند هستند حذف می کند.
`setDocType(docType)`	`Document`	اعلان `DocType` سند را تنظیم می کند.
`setRootElement(element)`	`Document`	گره `Element` ریشه سند را تنظیم می کند.

`Element`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`addContent(content)`	`Element`	گره داده شده را به عنوان آخرین فرزند گره `Element` اضافه می کند.
`addContent(index, content)`	`Element`	گره داده شده را در شاخص داده شده در بین تمام گره هایی که فرزندان مستقیم گره `Element` هستند درج می کند.
`cloneContent()`	`Content[]`	کپی‌های پیوست‌نشده از همه گره‌هایی که فرزندان مستقیم گره {@code Element} هستند ایجاد می‌کند.
`detach()`	`Content`	گره را از گره `Element` والد خود جدا می کند.
`getAllContent()`	`Content[]`	همه گره هایی را که فرزندان مستقیم گره {@code Element} هستند را دریافت می کند.
`getAttribute(name)`	`Attribute`	ویژگی این گره `Element` را با نام داده شده و بدون فضای نام دریافت می کند.
`getAttribute(name, namespace)`	`Attribute`	ویژگی این گره `Element` را با نام و فضای نام داده شده دریافت می کند.
`getAttributes()`	`Attribute[]`	تمام ویژگی‌های این گره `Element` را به ترتیبی که در سند ظاهر می‌شوند، دریافت می‌کند.
`getChild(name)`	`Element`	اولین گره `Element` را با نام داده شده و بدون فضای نام که فرزند مستقیم این گره `Element` است، دریافت می کند.
`getChild(name, namespace)`	`Element`	اولین گره `Element` را با نام و فضای نام داده شده دریافت می کند که فرزند مستقیم این گره `Element` است.
`getChildText(name)`	`String`	اگر گره فرزند مستقیم گره `Element` باشد، مقدار متن گره را با نام داده شده و بدون فضای نام دریافت می کند.
`getChildText(name, namespace)`	`String`	مقدار متن گره را با نام و فضای نام داده شده دریافت می کند، اگر گره فرزند مستقیم گره `Element` باشد.
`getChildren()`	`Element[]`	تمام گره های `Element` را که فرزندان مستقیم این گره `Element` هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`getChildren(name)`	`Element[]`	تمام گره های `Element` را با نام مشخص شده و بدون فضای نام که فرزندان مستقیم این گره `Element` هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`getChildren(name, namespace)`	`Element[]`	همه گره های `Element` را با نام و فضای نام داده شده که فرزندان مستقیم این گره `Element` هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`getContent(index)`	`Content`	گره را در شاخص داده شده در بین همه گره هایی که فرزندان مستقیم گره {@code Element} هستند، دریافت می کند.
`getContentSize()`	`Integer`	تعداد گره‌هایی را می‌گیرد که فرزندان مستقیم گره {@code Element} هستند.
`getDescendants()`	`Content[]`	همه گره هایی را که فرزندان مستقیم یا غیرمستقیم گره {@code Element} هستند، به ترتیبی که در سند نشان داده می شوند، دریافت می کند.
`getDocument()`	`Document`	سند XML را دریافت می کند که حاوی گره {@code Element} است.
`getName()`	`String`	نام محلی گره `Element` را دریافت می کند.
`getNamespace()`	`Namespace`	فضای نام گره `Element` را دریافت می کند.
`getNamespace(prefix)`	`Namespace`	فضای نام را با پیشوند داده شده برای گره `Element` دریافت می کند.
`getParentElement()`	`Element`	گره `Element` والد گره را دریافت می کند.
`getQualifiedName()`	`String`	نام محلی و پیشوند فضای نام گره `Element` را به شکل `[namespacePrefix]:[localName]` دریافت می‌کند.
`getText()`	`String`	مقدار متن گره `Element` را دریافت می کند.
`getValue()`	`String`	مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`isAncestorOf(other)`	`Boolean`	تعیین می کند که آیا این گره `Element` والد مستقیم یا غیرمستقیم یک گره `Element` معین است.
`isRootElement()`	`Boolean`	تعیین می کند که آیا گره `Element` ، گره اصلی سند است یا خیر.
`removeAttribute(attribute)`	`Boolean`	در صورت وجود چنین ویژگی، ویژگی داده شده را برای این گره `Element` حذف می کند.
`removeAttribute(attributeName)`	`Boolean`	در صورت وجود چنین ویژگی، ویژگی این گره `Element` را با نام داده شده و بدون فضای نام حذف می کند.
`removeAttribute(attributeName, namespace)`	`Boolean`	در صورت وجود چنین ویژگی، ویژگی این گره `Element` را با نام و فضای نام داده شده حذف می کند.
`removeContent()`	`Content[]`	همه گره هایی را که فرزندان مستقیم گره {@code Element} هستند حذف می کند.
`removeContent(content)`	`Boolean`	اگر گره فرزند مستقیم گره {@code Element} باشد، گره داده شده را حذف می کند.
`removeContent(index)`	`Content`	گره را در نمایه داده شده از بین همه گره هایی که فرزندان مستقیم گره {@code Element} هستند حذف می کند.
`setAttribute(attribute)`	`Element`	ویژگی داده شده را برای این گره `Element` تنظیم می کند.
`setAttribute(name, value)`	`Element`	ویژگی را برای این گره `Element` با نام، مقدار و بدون فضای نام مشخص می کند.
`setAttribute(name, value, namespace)`	`Element`	ویژگی این گره `Element` را با نام، مقدار و فضای نام داده شده تنظیم می کند.
`setName(name)`	`Element`	نام محلی گره `Element` را تنظیم می کند.
`setNamespace(namespace)`	`Element`	فضای نام را برای گره `Element` تنظیم می کند.
`setText(text)`	`Element`	مقدار متن گره `Element` را تنظیم می کند.

`EntityRef`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`detach()`	`Content`	گره را از گره `Element` والد خود جدا می کند.
`getName()`	`String`	نام گره `EntityReference` را دریافت می کند.
`getParentElement()`	`Element`	گره `Element` والد گره را دریافت می کند.
`getPublicId()`	`String`	شناسه عمومی گره `EntityReference` را دریافت می کند.
`getSystemId()`	`String`	شناسه سیستم گره `EntityReference` را دریافت می کند.
`getValue()`	`String`	مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
`setName(name)`	`EntityRef`	نام گره `EntityReference` را تنظیم می کند.
`setPublicId(id)`	`EntityRef`	شناسه عمومی گره `EntityReference` را تنظیم می کند.
`setSystemId(id)`	`EntityRef`	شناسه سیستم گره `EntityReference` را تنظیم می کند.

`Format`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`format(document)`	`String`	`Document` داده شده را به عنوان یک رشته فرمت شده خروجی می دهد.
`format(element)`	`String`	گره `Element` داده شده را به عنوان یک رشته فرمت شده خروجی می دهد.
`setEncoding(encoding)`	`Format`	رمزگذاری کاراکتری را که قالب‌کننده باید استفاده کند را تنظیم می‌کند.
`setIndent(indent)`	`Format`	رشته مورد استفاده برای تورفتگی گره های فرزند نسبت به والدینشان را تنظیم می کند.
`setLineSeparator(separator)`	`Format`	رشته را طوری تنظیم می‌کند که هر زمان که فرمت‌کننده معمولاً یک خط شکسته را وارد می‌کند، درج شود.
`setOmitDeclaration(omitDeclaration)`	`Format`	تنظیم می‌کند که آیا قالب‌کننده باید اعلان XML را حذف کند، مانند `<?xml version="1.0" encoding="UTF-8"?>` .
`setOmitEncoding(omitEncoding)`	`Format`	تنظیم می‌کند که آیا قالب‌کننده باید کدگذاری را در اعلان XML حذف کند، مانند قسمت رمزگذاری در `<?xml version="1.0" encoding="UTF-8"?>` .

`Namespace`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`getPrefix()`	`String`	پیشوند فضای نام را دریافت می کند.
`getURI()`	`String`	URI فضای نام را دریافت می کند.

`ProcessingInstruction`

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`detach()`	`Content`	گره را از گره `Element` والد خود جدا می کند.
`getData()`	`String`	داده های خام را برای هر دستورالعمل در گره `ProcessingInstruction` دریافت می کند.
`getParentElement()`	`Element`	گره `Element` والد گره را دریافت می کند.
`getTarget()`	`String`	هدف گره `ProcessingInstruction` را دریافت می کند.
`getValue()`	`String`	مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.

`Text`

مواد و روش ها

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

`XmlService`

خواص

ویژگی	تایپ کنید	شرح
`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 ایجاد می کند.