Class XmlService

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
XmlService

שירות זה מאפשר לסקריפטים לנתח, לנווט וליצור מסמכי XML באופן פרוגרמטי.

// Log the title and labels for the first page of blog posts on the
// Google Workspace Developer blog.
function parseXml() {
  var url = 'https://gsuite-developers.googleblog.com/atom.xml';
  var xml = UrlFetchApp.fetch(url).getContentText();
  var document = XmlService.parse(xml);
  var root = document.getRootElement();
  var atom = XmlService.getNamespace('http://www.w3.org/2005/Atom');

  var entries = root.getChildren('entry', atom);
  for (var i = 0; i < entries.length; i++) {
    var title = entries[i].getChild('title', atom).getText();
    var categoryElements = entries[i].getChildren('category', atom);
    var labels = [];
    for (var j = 0; j < categoryElements.length; j++) {
      labels.push(categoryElements[j].getAttribute('term').getValue());
    }
    Logger.log('%s (%s)', title, labels.join(', '));
  }
}

// Create and log an XML representation of the threads in your Gmail inbox.
function createXml() {
  var root = XmlService.createElement('threads');
  var threads = GmailApp.getInboxThreads();
  for (var i = 0; i < threads.length; i++) {
    var child = XmlService.createElement('thread')
        .setAttribute('messageCount', threads[i].getMessageCount())
        .setAttribute('isUnread', threads[i].isUnread())
        .setText(threads[i].getFirstMessageSubject());
    root.addContent(child);
  }
  var document = XmlService.createDocument(root);
  var xml = XmlService.getPrettyFormat().format(document);
  Logger.log(xml);
}

נכסים

מאפיין (property)סוגתיאור
ContentTypesContentTypeמספור שמייצג את סוגי צומתי התוכן של 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.

תיעוד מפורט

createCdata(text)

יצירת צומת CDATASection לא מצורף עם הערך הנתון.

פרמטרים

שםסוגתיאור
textStringהערך שיש להגדיר

הלוך ושוב

Cdata — הצומת CDATASection החדש שנוצר


createComment(text)

יצירת צומת Comment לא מצורף עם הערך הנתון.

פרמטרים

שםסוגתיאור
textStringהערך שיש להגדיר

הלוך ושוב

Comment — הצומת Comment החדש שנוצר


createDocType(elementName)

יצירת צומת DocumentType לא מצורף לצומת Element הבסיסי עם השם הנתון.

פרמטרים

שםסוגתיאור
elementNameStringשם הצומת Element המקורי שיש לציין בהצהרת DocType

הלוך ושוב

DocType — הצומת DocumentType החדש שנוצר


createDocType(elementName, systemId)

יצירת צומת DocumentType לא מצורף לצומת Element הבסיסי עם השם הנתון, ומזהה המערכת הנתון עבור נתוני קבוצת המשנה החיצונית.

פרמטרים

שםסוגתיאור
elementNameStringשם הצומת Element המקורי שיש לציין בהצהרת DocType
systemIdStringמזהה המערכת של נתוני קבוצת המשנה החיצונית להגדרה

הלוך ושוב

DocType — הצומת DocumentType החדש שנוצר


createDocType(elementName, publicId, systemId)

יצירה של צומת DocumentType לא מצורף לצומת Element הראשי עם השם הנתון, ומזהה ציבורי ומזהה מערכת נתונים של קבוצת משנה חיצונית.

פרמטרים

שםסוגתיאור
elementNameStringשם הצומת Element המקורי שיש לציין בהצהרת DocType
publicIdStringהמזהה הציבורי של נתוני קבוצת המשנה החיצונית להגדרה
systemIdStringמזהה המערכת של נתוני קבוצת המשנה החיצונית להגדרה

הלוך ושוב

DocType — הצומת DocumentType החדש שנוצר


createDocument()

יצירת מסמך XML ריק.

הלוך ושוב

Document — המסמך החדש שנוצר


createDocument(rootElement)

יצירת מסמך XML עם צומת הבסיס Element.

פרמטרים

שםסוגתיאור
rootElementElementהצומת הבסיסי (Element) שיש להגדיר

הלוך ושוב

Document — המסמך החדש שנוצר


createElement(name)

יוצרת צומת Element לא מצורף עם השם המקומי הנתון וללא מרחב שמות.

פרמטרים

שםסוגתיאור
nameStringהשם המקומי שרוצים להגדיר

הלוך ושוב

Element — הצומת Element החדש שנוצר


createElement(name, namespace)

פעולה זו יוצרת צומת Element לא מצורף עם השם המקומי ומרחב השמות הנתונים.

פרמטרים

שםסוגתיאור
nameStringהשם המקומי שרוצים להגדיר
namespaceNamespaceמרחב השמות שיש להגדיר

הלוך ושוב

Element — הצומת Element החדש שנוצר


createText(text)

יצירת צומת Text לא מצורף עם הערך הנתון.

פרמטרים

שםסוגתיאור
textStringהערך שיש להגדיר

הלוך ושוב

Text — הצומת Text החדש שנוצר


getCompactFormat()

יצירת אובייקט Format לפלט של מסמך XML קומפקטי. הפורמט מוגדר כברירת מחדל לקידוד UTF-8, ללא כניסת פסקה וללא מעברי שורה נוספים, אבל כולל את הצהרת ה-XML ואת הקידוד שלה.

// Log an XML document in compact form.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getCompactFormat()
    .format(document);
Logger.log(output);

הלוך ושוב

Format — הפורמט החדש שנוצר


getNamespace(uri)

יצירת Namespace עם ה-URI הנתון.

פרמטרים

שםסוגתיאור
uriStringה-URI של מרחב השמות

הלוך ושוב

Namespace — מרחב השמות החדש שנוצר


getNamespace(prefix, uri)

יצירת Namespace עם הקידומת הנתונה וה-URI.

פרמטרים

שםסוגתיאור
prefixStringהקידומת של מרחב השמות
uriStringה-URI של מרחב השמות

הלוך ושוב

Namespace — מרחב השמות החדש שנוצר


getNoNamespace()

פונקציה זו יוצרת Namespace שמייצגת את ההיעדר של מרחב שמות אמיתי.

הלוך ושוב

Namespace — מרחב השמות החדש שנוצר


getPrettyFormat()

יצירת אובייקט Format לפלט מסמך XML שקריא למשתמשים. ברירת המחדל של הפורמט היא קידוד UTF-8, כניסת פסקה בת שני רווחים ומפרידי שורות \r\n אחרי כל צומת. כמו כן, היא כוללת את הצהרת ה-XML ואת הקידוד שלה.

// Log an XML document in human-readable form.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getPrettyFormat()
    .format(document);
Logger.log(output);

הלוך ושוב

Format — הפורמט החדש שנוצר


getRawFormat()

יצירת אובייקט Format לפלט של מסמך XML גולמי. ברירת המחדל של הפורמט היא קידוד UTF-8, ללא כניסת פסקה ואין מעברי שורה מעבר לאלה שצוינו במסמך ה-XML עצמו. היא כוללת את הצהרת ה-XML ואת הקידוד שלה.

// Log an XML document in raw form.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getRawFormat()
    .format(document);
Logger.log(output);

הלוך ושוב

Format — הפורמט החדש שנוצר


getXmlNamespace()

הפונקציה יוצרת Namespace עם קידומת xml רגילה.

הלוך ושוב

Namespace — מרחב השמות החדש שנוצר


parse(xml)

יוצרת Document מה-XML הנתון, בלי לאמת את ה-XML.

var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var doc = XmlService.parse(xml);

פרמטרים

שםסוגתיאור
xmlStringה-XML לניתוח

הלוך ושוב

Document — המסמך החדש שנוצר