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

`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`	הגדרת השם של צומת הרמה הבסיסית (root) `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` הוא צומת הרמה הבסיסית (root) של המסמך.
`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 עם צומת הרמה הבסיסית (root) `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.