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ייצוג של צומת CDATASection XML.
Commentייצוג של צומת Comment XML.
Contentייצוג של צומת XML כללי.
ContentTypeספירה שמייצגת את הסוגים של צמתי תוכן ב-XML.
DocTypeייצוג של צומת DocumentType XML.
Documentייצוג של מסמך XML.
Elementייצוג של צומת Element XML.
EntityRefייצוג של צומת EntityReference XML.
Formatמעצב לפלט של מסמך XML, עם שלושה פורמטים מוגדרים מראש שאפשר להתאים אישית.
Namespaceייצוג של מרחב שמות XML.
ProcessingInstructionייצוג של צומת ProcessingInstruction XML.
Textייצוג של צומת Text XML.
XmlServiceהשירות הזה מאפשר לסקריפטים לנתח מסמכי XML, לנווט בהם וליצור אותם באופן פרוגרמטי.

Attribute

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getName()Stringמחזירה את השם המקומי של המאפיין.
getNamespace()Namespace|nullמחזירה את מרחב השמות של המאפיין.
getValue()Stringקבלת הערך של המאפיין.
setName(name)Attributeמגדיר את השם המקומי של המאפיין.
setNamespace(namespace)Attributeמגדיר את מרחב השמות של המאפיין.
setValue(value)Attributeהגדרת הערך של המאפיין.

Cdata

Methods

שיטהסוג הערך שמוחזרתיאור קצר
append(text)Textהפונקציה מוסיפה את הטקסט שצוין לתוכן שכבר קיים בצומת.
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getParentElement()Element|nullמחזירה את צומת ההורה של הצומת Element.
getText()Stringמקבלת את ערך הטקסט של הצומת Text.
getValue()Stringמחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.
setText(text)Textמגדירה את ערך הטקסט של הצומת Text.

Comment

Methods

שיטהסוג הערך שמוחזרתיאור קצר
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getParentElement()Element|nullמקבל את צומת ההורה Element של הצומת.
getText()Stringמקבלת את ערך הטקסט של הצומת Comment.
getValue()Stringמחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.
setText(text)Commentמגדירה את ערך הטקסט של הצומת Comment.

Content

Methods

שיטהסוג הערך שמוחזרתיאור קצר
asCdata()Cdata|nullהפונקציה מעבירה את הצומת כצומת CDATASection לצורך השלמה אוטומטית.
asComment()Comment|nullהפונקציה מעבירה את הצומת כצומת Comment לצורך השלמה אוטומטית.
asDocType()DocType|nullהפונקציה מעבירה את הצומת כצומת DocumentType לצורך השלמה אוטומטית.
asElement()Element|nullהפונקציה מעבירה את הצומת כצומת Element לצורך השלמה אוטומטית.
asEntityRef()EntityRef|nullהפונקציה מעבירה את הצומת כצומת EntityReference לצורך השלמה אוטומטית.
asProcessingInstruction()ProcessingInstruction|nullהפונקציה מעבירה את הצומת כצומת ProcessingInstruction לצורך השלמה אוטומטית.
asText()Text|nullהפונקציה מעבירה את הצומת כצומת Text לצורך השלמה אוטומטית.
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getParentElement()Element|nullמקבל את צומת ההורה Element של הצומת.
getType()ContentTypeמחזירה את סוג התוכן של הצומת.
getValue()Stringמחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.

ContentType

מאפיינים

נכססוגתיאור
CDATAEnumצומת CDATASection ב-XML.
COMMENTEnumצומת Comment ב-XML.
DOCTYPEEnumצומת DocumentType ב-XML.
ELEMENTEnumצומת Element ב-XML.
ENTITYREFEnumצומת EntityReference ב-XML.
PROCESSINGINSTRUCTIONEnumצומת ProcessingInstruction של XML.
TEXTEnumצומת Text של XML.

DocType

Methods

שיטהסוג הערך שמוחזרתיאור קצר
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getElementName()Stringמקבל את השם של צומת הבסיס Element שצוין בהצהרת DocType.
getInternalSubset()Stringקבלת נתוני קבוצת המשנה הפנימית של הצומת DocumentType.
getParentElement()Element|nullמקבל את צומת ההורה 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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addContent(content)Documentמוסיף את הצומת הנתון לסוף המסמך.
addContent(index, content)Documentמוסיף את הצומת הנתון באינדקס הנתון בין כל הצמתים שהם צאצאים ישירים של המסמך.
cloneContent()Content[]יוצר עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של המסמך.
detachRootElement()Element|nullמנתק את צומת השורש Element של המסמך ומחזיר אותו.
getAllContent()Content[]מחזירה את כל הצמתים שהם צאצאים ישירים של המסמך.
getContent(index)Content|nullמחזירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של המסמך.
getContentSize()Integerהפונקציה מחזירה את מספר הצמתים שהם צאצאים ישירים של המסמך.
getDescendants()Content[]מחזירה את כל הצמתים שהם צאצאים ישירים או עקיפים של המסמך, לפי הסדר שבו הם מופיעים במסמך.
getDocType()DocType|nullמחזירה את DocTypeההצהרה של המסמך.
getRootElement()Element|nullמחזירה את צומת השורש Element של המסמך.
hasRootElement()Booleanהפונקציה קובעת אם במסמך יש צומת Element בסיס.
removeContent()Content[]הסרת כל הצמתים שהם צאצאים ישירים של המסמך.
removeContent(content)Booleanהפונקציה מסירה את הצומת שצוין, אם הצומת הוא צאצא ישיר של המסמך.
removeContent(index)Content|nullהפונקציה מסירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של המסמך.
setDocType(docType)Documentהגדרת ההצהרה DocType של המסמך.
setRootElement(element)Documentהגדרת צומת השורש Element של המסמך.

Element

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addContent(content)Elementמוסיף את הצומת הנתון כצאצא האחרון של הצומת Element.
addContent(index, content)Elementהפונקציה מוסיפה את הצומת הנתון באינדקס הנתון בין כל הצמתים שהם צאצאים ישירים של הצומת Element.
cloneContent()Content[]יוצר עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של צומת {@code Element}.
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getAllContent()Content[]מחזירה את כל הצמתים שהם צאצאים ישירים של צומת {@code Element}.
getAttribute(name)Attribute|nullמחזירה את המאפיין של צומת Element הזה עם השם הנתון וללא מרחב שמות.
getAttribute(name, namespace)Attribute|nullמחזירה את המאפיין של צומת Element הזה עם השם ומרחב השמות שצוינו.
getAttributes()Attribute[]מקבל את כל המאפיינים של הצומת Element הזה, לפי הסדר שבו הם מופיעים במסמך.
getChild(name)Element|nullמחזירה את הצומת הראשון Element עם השם הנתון וללא מרחב שמות, שהוא צאצא מיידי של הצומת Element.
getChild(name, namespace)Element|nullמחזירה את הצומת הראשון Element עם השם ומרחב השמות הנתונים, שהוא צאצא ישיר של הצומת Element הזה.
getChildText(name)String|nullהפונקציה מחזירה את ערך הטקסט של הצומת עם השם הנתון וללא מרחב שמות, אם הצומת הוא צאצא ישיר של הצומת Element.
getChildText(name, namespace)String|nullהפונקציה מחזירה את ערך הטקסט של הצומת עם השם ומרחב השמות שצוינו, אם הצומת הוא צאצא ישיר של הצומת Element.
getChildren()Element[]מחזירה את כל הצמתים מסוג Element שהם צאצאים ישירים של הצומת Element הזה, בסדר שבו הם מופיעים במסמך.
getChildren(name)Element[]מחזירה את כל הצמתים Element עם השם הנתון וללא מרחב שמות, שהם צאצאים ישירים של הצומת Element הזה, לפי הסדר שבו הם מופיעים במסמך.
getChildren(name, namespace)Element[]מחזירה את כל הצמתים Element עם השם ומרחב השמות שצוינו, שהם צאצאים ישירים של הצומת Element, לפי הסדר שבו הם מופיעים במסמך.
getContent(index)Content|nullמחזירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של הצומת {@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|nullמחזירה את צומת ההורה של הצומת 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|nullמסירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של הצומת {@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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getName()Stringהפונקציה מחזירה את השם של צומת EntityReference.
getParentElement()Element|nullמחזירה את צומת ההורה של הצומת Element.
getPublicId()String|nullמקבל את המזהה הציבורי של הצומת EntityReference.
getSystemId()String|nullהפונקציה מחזירה את מזהה המערכת של הצומת EntityReference.
getValue()Stringמחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.
setName(name)EntityRefמגדיר את השם של צומת EntityReference.
setPublicId(id)EntityRefמגדירה את המזהה הציבורי של הצומת EntityReference.
setSystemId(id)EntityRefמגדירה את מזהה המערכת של הצומת EntityReference.

Format

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getPrefix()Stringקבלת הקידומת של מרחב השמות.
getURI()Stringקבלת ה-URI של מרחב השמות.

ProcessingInstruction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getData()Stringמקבל את הנתונים הגולמיים של כל הוראה בצומת ProcessingInstruction.
getParentElement()Element|nullמקבל את צומת ההורה Element של הצומת.
getTarget()Stringהפונקציה מחזירה את היעד של הצומת ProcessingInstruction.
getValue()Stringמחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.

Text

Methods

שיטהסוג הערך שמוחזרתיאור קצר
append(text)Textהוספת הטקסט הנתון לתוכן שכבר קיים בצומת.
detach()Content|nullמנתק את הצומת מצומת ההורה Element.
getParentElement()Element|nullמקבל את צומת ההורה Element של הצומת.
getText()Stringמקבלת את ערך הטקסט של הצומת Text.
getValue()Stringמחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.
setText(text)Textמגדירה את ערך הטקסט של הצומת Text.

XmlService

מאפיינים

נכססוגתיאור
ContentTypesContentTypeספירה שמייצגת את הסוגים של צמתי תוכן ב-XML.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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הפונקציה יוצרת Namespace עם ה-URI שצוין.
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.