Class HtmlOutput

ページにメタタグを追加します。Apps Script HTML ファイルに直接含まれるメタタグは無視されます。使用できるのは次のメタタグのみです。

<meta name="apple-mobile-web-app-capable" content="..."/>
<meta name="google-site-verification" content="..."/>
<meta name="mobile-web-app-capable" content="..."/>
<meta name="viewport" content="..."/>

const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.addMetaTag('viewport', 'width=device-width, initial-scale=1');

パラメータ

戻る

HtmlOutput - チェーン用の出力。

この HtmlOutput のコンテンツに新しいコンテンツを追加します。エスケープされないため、信頼できるソースのコンテンツにのみ使用してください。

// Log "<b>Hello, world!</b><p>Hello again, world.</p>"
const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.append('<p>Hello again, world.</p>');
Logger.log(output.getContent());

パラメータ

戻る

HtmlOutput - チェーン用の出力。

例外

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

関連情報

• appendUntrusted(addedContent)

コンテキスト エスケープを使用して、この HtmlOutput のコンテンツに新しいコンテンツを追加します。

このメソッドは、HtmlOutput の現在の状態に基づいてコンテンツを正しくエスケープするため、結果はマークアップや副作用のない安全な文字列になります。ユーザーなど、信頼できないソースからコンテンツを追加するときは、append ではなくこれを使用します。append したコンテンツやマークアップが原因で予期しないコード実行が発生するクロスサイト スクリプティング（XSS）バグを誤って許可しないようにするためです。

// Log "<b>Hello, world!</b>&lt;p&gt;Hello again, world.&lt;/p&gt;"
const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.appendUntrusted('<p>Hello again, world.</p>');
Logger.log(output.getContent());

パラメータ

戻る

HtmlOutput - チェーン用の出力。

例外

Error - HTML の形式が非常に不適切である場合

関連情報

• append(addedContent)

この HtmlOutput を基盤とする HtmlTemplate を返します。この方法を使用すると、テンプレートを段階的に構築できます。HtmlOutput の今後の変更は、HtmlTemplate の内容にも影響します。

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

戻る

HtmlTemplate - 新しい HtmlTemplate。

現在のコンテンツを消去します。

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

戻る

HtmlOutput - チェーン用の出力。

このオブジェクト内のデータを指定したコンテンツ タイプに変換された BLOB として返します。この方法では、適切な拡張子がファイル名に追加されます（例: myfile.pdf）。ただし、最後のピリオド（存在する場合）の後のファイル名の部分は、置き換えが必要な既存の拡張子であると想定しています。そのため、「ShoppingList.12.25.2014」は「ShoppingList.12.25.pdf」になります。

コンバージョンの日別割り当てを表示するには、Google サービスの割り当てをご覧ください。新しく作成された Google Workspace ドメインには、一時的に厳しい割り当てが適用される場合があります。

パラメータ

戻る

Blob - BLOB としてのデータ。

このオブジェクト内のデータを blob として返します。

戻る

Blob - BLOB としてのデータ。

この HtmlOutput の内容を取得します。

// Log "<b>Hello, world!</b>"
const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
Logger.log(output.getContent());

戻る

String - 配信されるコンテンツ。

setFaviconUrl(iconUrl) を呼び出して、ページに追加されたファビコン リンクタグの URL を取得します。Apps Script HTML ファイルに直接含まれるファビコン リンクタグは無視されます。

const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.setFaviconUrl('http://www.example.com/image.png');
Logger.log(output.getFaviconUrl());

戻る

String - ファビコン画像の URL。

Google ドキュメント、スプレッドシート、フォームのカスタム ダイアログの初期の高さを取得します。HtmlOutput がウェブアプリとして公開されている場合、このメソッドは null を返します。すでに開いているダイアログのサイズを変更するには、クライアントサイド コードで google.script.host.setHeight(height) を呼び出します。

const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.setHeight(200);
Logger.log(output.getHeight());

戻る

Integer - 高さ（ピクセル単位）。

addMetaTag(name, content) を呼び出して、ページに追加されたメタタグを表すオブジェクトの配列を取得します。Apps Script HTML ファイルに直接含まれるメタタグは無視されます。

const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.addMetaTag('viewport', 'width=device-width, initial-scale=1');

const tags = output.getMetaTags();
Logger.log(
    '<meta name="%s" content="%s"/>',
    tags[0].getName(),
    tags[0].getContent(),
);

戻る

HtmlOutputMetaTag[] - addMetaTag(name, content) を呼び出してページに追加されたメタタグを表すオブジェクトの配列。

出力ページのタイトルを取得します。HTML の <title> 要素は無視されます。

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

戻る

String - ページのタイトル。

Google ドキュメント、スプレッドシート、フォームのカスタム ダイアログの初期幅を取得します。HtmlOutput がウェブアプリとして公開されている場合、このメソッドは null を返します。すでに開いているダイアログのサイズを変更するには、クライアントサイド コードで google.script.host.setWidth(width) を呼び出します。

const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.setWidth(200);
Logger.log(output.getWidth());

戻る

Integer - 幅（ピクセル単位）。

この HtmlOutput のコンテンツを設定します。

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

パラメータ

戻る

HtmlOutput - チェーン用の出力。

例外

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

ページにファビコンのリンクタグを追加します。Apps Script HTML ファイルに直接含まれているファビコン リンクタグは無視されます。

const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.setFaviconUrl('http://www.example.com/image.png');

パラメータ

戻る

HtmlOutput - チェーン用の出力。

Google ドキュメント、スプレッドシート、フォームのカスタム ダイアログの初期の高さを設定します。HtmlOutput がウェブアプリとして公開されている場合、このメソッドは効果がありません。すでに開いているダイアログのサイズを変更するには、クライアントサイド コードで google.script.host.setHeight(height) を呼び出します。

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

パラメータ

戻る

HtmlOutput - チェーン用の出力。

このメソッドは、クライアントサイド スクリプトに使用される sandbox mode を設定していましたが、現在は影響しません。悪意のある HTML や JavaScript がユーザーに提供されるのを防ぐため、HTML サービスから提供されるクライアントサイド コードは、コードに制限を課すセキュリティ サンドボックスで実行されます。当初、このメソッドではスクリプト作成者がサンドボックスの異なるバージョンを選択できましたが、現在は、どのサンドボックス モードが設定されているかにかかわらず、すべてのスクリプトで IFRAME モードが使用されます。詳細については、HTML サービスの制限に関するガイドをご覧ください。

IFRAME モードは、他のサンドボックス モードよりも制限が大幅に少なく、最も高速に実行されますが、Internet Explorer 9 など、特定の古いブラウザではまったく機能しません。サンドボックス モードは、google.script.sandbox.mode を調べることでクライアントサイド スクリプトで読み取ることができます。このプロパティは、クライアント上の実際のモードを返します。リクエストされたモードがユーザーのブラウザでサポートされていない場合、サーバー上でリクエストされたモードとは異なる場合があります。

<!-- Read the sandbox mode (in a client-side script). -->
<script>
  alert(google.script.sandbox.mode);
</script>

パラメータ

戻る

HtmlOutput - チェーン用の出力。

出力ページのタイトルを設定します。ウェブアプリの場合、これはページ全体のタイトルですが、Google スプレッドシートに表示される HtmlOutput の場合はダイアログ タイトルです。

const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.setTitle('My First Page');

パラメータ

戻る

HtmlOutput - チェーン用の出力。

Google ドキュメント、スプレッドシート、フォームのカスタム ダイアログの初期幅を設定します。HtmlOutput がウェブアプリとして公開されている場合、このメソッドは効果がありません。すでに開いているダイアログのサイズを変更するには、クライアントサイド コードで google.script.host.setWidth(width) を呼び出します。

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

パラメータ

戻る

HtmlOutput - チェーン用の出力。

ページの X-Frame-Options ヘッダーの状態を設定します。これにより、クリックジャッキングの防止を制御します。

XFrameOptionsMode.ALLOWALL を設定すると、どのサイトでもページを iframe できるため、デベロッパーはクリックジャッキングに対する独自の保護を実装する必要があります。

スクリプトで X-Frame-Options モードが設定されていない場合、デフォルトで XFrameOptionsMode.DEFAULT モードが使用されます。

// Serve HTML with no X-Frame-Options header (in Apps Script server-side code).
const output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.setXFrameOptionsMode(HtmlService.XFrameOptionsMode.ALLOWALL);

パラメータ

戻る

HtmlOutput - チェーン用の出力。