Class Format

形式

XML ドキュメントを出力するためのフォーマッタ。事前定義された 3 つのフォーマットがあります。 カスタマイズします。 

// Log an XML document with specified formatting options.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getCompactFormat()
    .setLineSeparator('\n')
    .setEncoding('UTF-8')
    .setIndent('   ')
    .format(document);
Logger.log(output);

メソッド

メソッド戻り値の型概要
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"?> のエンコード フィールド。

詳細なドキュメント

format(document)

指定された Document をフォーマット済み文字列として出力します。

パラメータ

名前型説明
documentDocument書式設定するドキュメント

戻る

String - 書式設定されたドキュメント

format(element)

指定された Element ノードをフォーマット済み文字列として出力します。

パラメータ

名前型説明
elementElement書式設定する要素

戻る

String - 書式設定された要素

setEncoding(encoding)

フォーマッタで使用する文字エンコードを設定します。encoding 引数は、 使用可能な XML エンコード（ISO-8859-1、US-ASCII、UTF-8、UTF-16 など）であること。 

// Log an XML document with encoding that does not support certain special characters.
var xml = '<root><a><b>ಠ‿ಠ</b><b>ಠ‿ಠ</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getRawFormat()
    .setEncoding('ISO-8859-1')
    .format(document);
Logger.log(output);

パラメータ

名前型説明
encodingString使用するエンコードは

戻る

Format - チェーン用のフォーマッタ

setIndent(indent)

子ノードを親に対して相対的にインデントするために使用される文字列を設定します。インデント（その他）の設定 null よりも大きいと、フォーマッタによって各ノードの後に改行が挿入されます。 

// Log an XML document with each child node indented four spaces.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getCompactFormat()
    .setIndent('    ')
    .format(document);
Logger.log(output);

パラメータ

名前型説明
indentString使用するインデント

戻る

Format - チェーン用のフォーマッタ

setLineSeparator(separator)

フォーマッタによって通常改行が挿入されるたびに挿入する文字列を設定します。3 つの 事前定義されたフォーマッタでは、改行を挿入する条件が異なります。「 デフォルトの行区切り文字は \r\n です。 

// Log an XML document with several spaces and a pipe character in place of line breaks.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getRawFormat()
    .setLineSeparator(' | ')
    .format(document);
Logger.log(output);

パラメータ

名前型説明
separatorString使用する区切り文字

戻る

Format - チェーン用のフォーマッタ

setOmitDeclaration(omitDeclaration)

フォーマッタが <?xml version="1.0" encoding="UTF-8"?> などの XML 宣言を省略するかどうかを設定します。

パラメータ

名前型説明
omitDeclarationBooleantrue: XML 宣言を省略します。falseして含める

戻る

Format - チェーン用のフォーマッタ

setOmitEncoding(omitEncoding)

フォーマッタが XML 宣言のエンコード（ <?xml version="1.0" encoding="UTF-8"?> のエンコード フィールド。

パラメータ

名前型説明
omitEncodingBooleantrue: XML 宣言のエンコードを省略します。false～ 含める

戻る

Format - チェーン用のフォーマッタ