Class HtmlService

HtmlService

スクリプトから HTML などのテキスト コンテンツを返すサービス。

セキュリティ上の理由から、スクリプトはコンテンツをブラウザに直接返すことはできません。代わりに、HTML をサニタイズして、悪意のある操作を実行できないようにする必要があります。返品可能な商品にどのような制限が適用されるかについては、HtmlOutput の説明をご覧ください。

プロパティ

プロパティタイプ説明
SandboxModeSandboxModeクライアントサイドの HtmlService スクリプトで使用できるサンドボックス モードを表す列挙型。
XFrameOptionsModeXFrameOptionsModeクライアントサイドの HtmlService スクリプトで使用できる X-Frame-Options モードを表す列挙型。

メソッド

メソッド戻り値の型概要
createHtmlOutput()HtmlOutputスクリプトから返すことができる新しい HtmlOutput オブジェクトを作成します。
createHtmlOutput(blob)HtmlOutputBlobSource リソースから新しい HtmlOutput オブジェクトを作成します。
createHtmlOutput(html)HtmlOutputスクリプトから返すことができる新しい HtmlOutput オブジェクトを作成します。
createHtmlOutputFromFile(filename)HtmlOutputコードエディタのファイルから新しい HtmlOutput オブジェクトを作成します。
createTemplate(blob)HtmlTemplateBlobSource リソースから新しい HtmlTemplate オブジェクトを作成します。
createTemplate(html)HtmlTemplateスクリプトから返すことができる新しい HtmlTemplate オブジェクトを作成します。
createTemplateFromFile(filename)HtmlTemplateコードエディタのファイルから新しい HtmlTemplate オブジェクトを作成します。
getUserAgent()String現在のブラウザのユーザー エージェント文字列を取得します。

詳細なドキュメント

createHtmlOutput()

スクリプトから返すことができる新しい HtmlOutput オブジェクトを作成します。

const output = HtmlService.createHtmlOutput();

戻る

HtmlOutput - 新しい HtmlOutput オブジェクト

createHtmlOutput(blob)

BlobSource リソースから新しい HtmlOutput オブジェクトを作成します。

function createFromBlob(blob) {
  const output = HtmlService.createHtmlOutput(blob);
  return output;
}

パラメータ

名前型説明
blobBlobSourceHTML を取得するオブジェクト

戻る

HtmlOutput - 新しい HtmlOutput オブジェクト

例外

Error - blob に HTML が含まれていない場合、または HTML の形式が正しくない

createHtmlOutput(html)

スクリプトから返すことができる新しい HtmlOutput オブジェクトを作成します。

const output = HtmlService.createHtmlOutput('<b>Hello world!</b>');

パラメータ

名前型説明
htmlString配信するコンテンツ

戻る

HtmlOutput - 新しい HtmlOutput オブジェクト

例外

Error - html の形式が正しくない場合

createHtmlOutputFromFile(filename)

コードエディタのファイルから新しい HtmlOutput オブジェクトを作成します。

const output = HtmlService.createHtmlOutputFromFile('myPage');

パラメータ

名前型説明
filenameString使用するファイルの名前

戻る

HtmlOutput - 新しい HtmlOutput オブジェクト

例外

Error - ファイルが見つからない、またはファイル内の HTML の形式が正しくない場合

createTemplate(blob)

BlobSource リソースから新しい HtmlTemplate オブジェクトを作成します。

function createFromBlob(blob) {
  const template = HtmlService.createTemplate(blob);
  const output = template.evaluate();
  return output;
}

パラメータ

名前型説明
blobBlobSourceHTML を取得するオブジェクト。

戻る

HtmlTemplate - 新しい HtmlTemplate オブジェクト

例外

Error - blob に HTML が含まれていない場合

createTemplate(html)

スクリプトから返すことができる新しい HtmlTemplate オブジェクトを作成します。

const template = HtmlService.createTemplate(
    '<b>The time is &lt;?= new Date() ?&gt;</b>',
);

パラメータ

名前型説明
htmlStringテンプレートのコンテンツ

戻る

HtmlTemplate - 新しい HtmlTemplate オブジェクト

createTemplateFromFile(filename)

コードエディタのファイルから新しい HtmlTemplate オブジェクトを作成します。

const template = HtmlService.createTemplateFromFile('myTemplate');

パラメータ

名前型説明
filenameString使用するファイルの名前

戻る

HtmlTemplate - 新しい HtmlTemplate オブジェクト

例外

Error - ファイルが見つからない場合

getUserAgent()

現在のブラウザのユーザー エージェント文字列を取得します。ウェブアプリの doGet() 関数または doPost() 関数で使用されていない場合、ほとんどのスクリプト実行で null を返します。

戻る

String - ユーザー エージェント文字列