このページは 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 ドキュメントを出力するためのフォーマッタ。さらにカスタマイズできる 3 つの事前定義済み形式が存在します。
`Namespace`	XML 名前空間の表現。
`ProcessingInstruction`	XML `ProcessingInstruction` ノードの表現。
`Text`	XML `Text` ノードの表現。
`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`	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`

Methods

メソッド	戻り値の型	概要
`detach()`	`Content`	親の `Element` ノードから接続を解除します。
`getElementName()`	`String`	`DocType` 宣言で指定されたルート `Element` ノードの名前を取得します。
`getInternalSubset()`	`String`	`DocumentType` ノードの内部サブセットデータを取得します。
`getParentElement()`	`Element`	ノードの親 `Element` ノードを取得します。
`getPublicId()`	`String`	`DocumentType` ノードの外部サブセットデータの公開 ID を取得します。
`getSystemId()`	`String`	`DocumentType` ノードの外部サブセットデータのシステム ID を取得します。
`getValue()`	`String`	ノードの直接または間接の子であるすべてのノードのテキスト値を、ドキュメントに表示されている順序で取得します。
`setElementName(name)`	`DocType`	`DocType` 宣言で指定するルート `Element` ノードの名前を設定します。
`setInternalSubset(data)`	`DocType`	`DocumentType` ノードの内部サブセットデータを設定します。
`setPublicId(id)`	`DocType`	`DocumentType` ノードの外部サブセットデータの公開 ID を設定します。
`setSystemId(id)`	`DocType`	`DocumentType` ノードの外部サブセットデータのシステム ID を設定します。

`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` ノードがあるかどうかを判断します。
`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`	指定された名前と Namespace を使用して、この `Element` ノードの属性を取得します。
`getAttributes()`	`Attribute[]`	この `Element` ノードのすべての属性を、ドキュメントに表示されている順序で取得します。
`getChild(name)`	`Element`	指定された名前で、この `Element` ノードの直接の子である名前空間を持たない最初の `Element` ノードを取得します。
`getChild(name, namespace)`	`Element`	指定された名前と Namespace が、この `Element` ノードの直接の子である最初の `Element` ノードを取得します。
`getChildText(name)`	`String`	ノードが `Element` ノードの直接の子である場合、指定された名前を持つ名前空間なしのノードのテキスト値を取得します。
`getChildText(name, namespace)`	`String`	ノードが `Element` ノードの直接の子である場合、指定された名前と名前空間を持つノードのテキスト値を取得します。
`getChildren()`	`Element[]`	この `Element` ノードの直接の子であるすべての `Element` ノードを、ドキュメントに表示されている順序で取得します。
`getChildren(name)`	`Element[]`	指定された名前を持ち、この `Element` ノードの直接の子である名前空間がないすべての `Element` ノードを、ドキュメントに表示されている順序で取得します。
`getChildren(name, namespace)`	`Element[]`	指定された名前と Namespace を持つ、この `Element` ノードの直接の子である `Element` ノードをすべて、ドキュメントに表示されている順序で取得します。
`getContent(index)`	`Content`	{@code Element} ノードの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを取得します。
`getContentSize()`	`Integer`	{@code Element} ノードの直接の子であるノードの数を取得します。
`getDescendants()`	`Content[]`	{@code Element} ノードの直接または間接の子であるすべてのノードを、ドキュメントに表示されている順序で取得します。
`getDocument()`	`Document`	{@code Element} ノードを含む XML ドキュメントを取得します。
`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`	指定された名前と Namespace を持つこの `Element` ノードの属性が存在する場合は、それらを削除します。
`removeContent()`	`Content[]`	{@code Element} ノードの直接の子であるノードをすべて削除します。
`removeContent(content)`	`Boolean`	指定されたノードが {@code Element} ノードの直接の子である場合、そのノードを削除します。
`removeContent(index)`	`Content`	{@code Element} ノードの直接の子であるすべてのノードのうち、指定されたインデックスにあるノードを削除します。
`setAttribute(attribute)`	`Element`	この `Element` ノードの指定された属性を設定します。
`setAttribute(name, value)`	`Element`	指定された名前、値で、Namespace は設定せずに、この `Element` ノードの属性を設定します。
`setAttribute(name, value, namespace)`	`Element`	指定された名前、値、Namespace を使用して、この `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` ノードの公開 ID を取得します。
`getSystemId()`	`String`	`EntityReference` ノードのシステム ID を取得します。
`getValue()`	`String`	ノードの直接または間接の子であるすべてのノードのテキスト値を、ドキュメントに表示されている順序で取得します。
`setName(name)`	`EntityRef`	`EntityReference` ノードの名前を設定します。
`setPublicId(id)`	`EntityRef`	`EntityReference` ノードの公開 ID を設定します。
`setSystemId(id)`	`EntityRef`	`EntityReference` ノードのシステム ID を設定します。

`Format`

Methods

メソッド	戻り値の型	概要
`format(document)`	`String`	指定された `Document` をフォーマットされた文字列として出力します。
`format(element)`	`String`	指定された `Element` ノードをフォーマット済み文字列として出力します。
`setEncoding(encoding)`	`Format`	フォーマッタが使用する文字エンコードを設定します。
`setIndent(indent)`	`Format`	親ノードに対して相対的に子ノードをインデントするために使用する文字列を設定します。
`setLineSeparator(separator)`	`Format`	フォーマッタによる改行の挿入時に挿入する文字列を設定します。
`setOmitDeclaration(omitDeclaration)`	`Format`	フォーマッタで `<?xml version="1.0" encoding="UTF-8"?>` などの XML 宣言を省略するかどうかを設定します。
`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`	指定された名前でルート `Element` ノード用に未接続の `DocumentType` ノードを作成します。
`createDocType(elementName, systemId)`	`DocType`	指定された名前と外部のサブセットデータ用に指定されたシステム ID で、ルート `Element` ノード用に接続されていない `DocumentType` ノードを作成します。
`createDocType(elementName, publicId, systemId)`	`DocType`	ルート `Element` ノードの接続されていない `DocumentType` ノードを、指定された名前と、外部のサブセットデータ用に指定された公開 ID とシステム ID で作成します。
`createDocument()`	`Document`	空の XML ドキュメントを作成します。
`createDocument(rootElement)`	`Document`	指定されたルート `Element` ノードで XML ドキュメントを作成します。
`createElement(name)`	`Element`	指定されたローカル名で名前空間のない、接続されていない `Element` ノードを作成します。
`createElement(name, namespace)`	`Element`	指定されたローカル名と Namespace で接続されていない `Element` ノードを作成します。
`createText(text)`	`Text`	指定された値で、接続されていない `Text` ノードを作成します。
`getCompactFormat()`	`Format`	コンパクトな XML ドキュメントを出力するための `Format` オブジェクトを作成します。
`getNamespace(uri)`	`Namespace`	指定された URI で `Namespace` を作成します。
`getNamespace(prefix, uri)`	`Namespace`	指定された接頭辞と URI を持つ `Namespace` を作成します。
`getNoNamespace()`	`Namespace`	実際の Namespace がないことを表す `Namespace` を作成します。
`getPrettyFormat()`	`Format`	人が読める XML ドキュメントを出力するための `Format` オブジェクトを作成します。
`getRawFormat()`	`Format`	未加工の XML ドキュメントを出力するための `Format` オブジェクトを作成します。
`getXmlNamespace()`	`Namespace`	標準の `xml` 接頭辞が付いた `Namespace` を作成します。
`parse(xml)`	`Document`	指定された XML から、XML を検証せずに `Document` を作成します。