השירות הזה מאפשר לסקריפטים לנתח, לנווט וליצור מסמכי 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 באופן פרוגרמטי. |
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 | מגדירה את השם של צומת הבסיס 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 | הפונקציה יוצרת 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. |