דף זה תורגם על ידי 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`	ייצוג של צומת `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`	הפונקציה מקבלת את מרחב השמות של המאפיין.
`getValue()`	`String`	הפונקציה מקבלת את הערך של המאפיין.
`setName(name)`	`Attribute`	הגדרת השם המקומי של המאפיין.
`setNamespace(namespace)`	`Attribute`	הגדרת מרחב השמות של המאפיין.
`setValue(value)`	`Attribute`	הגדרת הערך של המאפיין.

`Cdata`

Methods

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

`Comment`

Methods

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

`Content`

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`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`	צומת `CDATASection` ב-XML.
`COMMENT`	`Enum`	צומת `Comment` ב-XML.
`DOCTYPE`	`Enum`	צומת `DocumentType` ב-XML.
`ELEMENT`	`Enum`	צומת `Element` ב-XML.
`ENTITYREF`	`Enum`	צומת `EntityReference` ב-XML.
`PROCESSINGINSTRUCTION`	`Enum`	צומת `ProcessingInstruction` ב-XML.
`TEXT`	`Enum`	צומת `Text` ב-XML.

`DocType`

Methods

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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`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` ברמה הבסיסית (root).
`removeContent()`	`Content[]`	הסרה של כל הצמתים שהם צאצאים מיידיים של המסמך.
`removeContent(content)`	`Boolean`	הסרת הצומת הנתון, אם הצומת הוא צאצא מיידי של המסמך.
`removeContent(index)`	`Content`	הסרת הצומת שבאינדקס הנתון מבין כל הצמתים שהם צאצאים מיידיים של המסמך.
`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`	ניתוק הצומת מצומת ההורה `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`

Methods

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

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`	ניתוק הצומת מצומת ההורה `Element`.
`getData()`	`String`	הפונקציה מקבלת את הנתונים הגולמיים של כל הוראה בצומת `ProcessingInstruction`.
`getParentElement()`	`Element`	הפונקציה מקבלת את צומת ההורה `Element` של הצומת.
`getTarget()`	`String`	הפונקציה מקבלת את היעד של הצומת `ProcessingInstruction`.
`getValue()`	`String`	הפונקציה מקבלת את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.

`Text`

Methods

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

`XmlService`

מאפיינים

נכס	סוג	תיאור
`ContentTypes`	`ContentType`	ספירה מייצגת את סוגי צמתים של תוכן 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.