Class HtmlOutput

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
HtmlOutput

스크립트에서 제공할 수 있는 HtmlOutput 객체 보안상의 이유로 스크립트는 브라우저에 직접 HTML을 반환할 수 없습니다. 대신 악의적인 작업을 실행할 수 없도록 파일을 정리해야 합니다. 다음과 같이 정리된 HTML을 반환할 수 있습니다.

function doGet() {
  return HtmlService.createHtmlOutput('<b>Hello, world!</b>');
}
HtmlOutput의 코드에는 삽입된 자바스크립트 및 CSS가 포함될 수 있습니다. 이는 Apps Script가 아닌 DOM을 조작하는 표준 클라이언트 측 자바스크립트입니다. 이 모든 콘텐츠는 iframe 샌드박스를 통해 샌드박스 처리됩니다. 자세한 내용은 HTML 서비스의 제한사항 가이드를 참고하세요.

메서드

메서드반환 유형간략한 설명
addMetaTag(name, content)HtmlOutput페이지에 메타 태그를 추가합니다.
append(addedContent)HtmlOutputHtmlOutput의 콘텐츠에 새 콘텐츠를 추가합니다.
appendUntrusted(addedContent)HtmlOutput컨텍스트 이스케이프를 사용하여 이 HtmlOutput의 콘텐츠에 새 콘텐츠를 추가합니다.
asTemplate()HtmlTemplateHtmlOutput에서 지원되는 HtmlTemplate를 반환합니다.
clear()HtmlOutput현재 콘텐츠를 지웁니다.
getAs(contentType)Blob이 객체 내의 데이터를 지정된 콘텐츠 유형으로 변환된 blob으로 반환합니다.
getBlob()Blob이 객체 내의 데이터를 blob으로 반환합니다.
getContent()StringHtmlOutput의 콘텐츠를 가져옵니다.
getFaviconUrl()StringsetFaviconUrl(iconUrl)을 호출하여 페이지에 추가된 파비콘 링크 태그의 URL을 가져옵니다.
getHeight()IntegerGoogle Docs, Sheets, Forms에서 맞춤 대화상자의 초기 높이를 가져옵니다.
getMetaTags()HtmlOutputMetaTag[]addMetaTag(name, content)를 호출하여 페이지에 추가된 메타 태그를 나타내는 객체의 배열을 가져옵니다.
getTitle()String출력 페이지의 제목을 가져옵니다.
getWidth()IntegerGoogle Docs, Sheets, Forms에서 맞춤 대화상자의 초기 너비를 가져옵니다.
setContent(content)HtmlOutputHtmlOutput의 콘텐츠를 설정합니다.
setFaviconUrl(iconUrl)HtmlOutput페이지에 파비콘 링크 태그를 추가합니다.
setHeight(height)HtmlOutputGoogle Docs, Sheets, Forms에서 맞춤 대화상자의 초기 높이를 설정합니다.
setSandboxMode(mode)HtmlOutput이 메서드는 이제 아무런 영향을 미치지 않습니다. 이전에는 클라이언트 측 스크립트에 사용되는 sandbox mode를 설정했습니다.
setTitle(title)HtmlOutput출력 페이지의 제목을 설정합니다.
setWidth(width)HtmlOutputGoogle Docs, Sheets, Forms에서 맞춤 대화상자의 초기 너비를 설정합니다.
setXFrameOptionsMode(mode)HtmlOutput클릭재킹 방지를 제어하는 페이지의 X-Frame-Options 헤더 상태를 설정합니다.

자세한 문서

addMetaTag(name, content)

페이지에 메타 태그를 추가합니다. 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="..."/>
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
output.addMetaTag('viewport', 'width=device-width, initial-scale=1');

매개변수

이름유형설명
nameString메타 태그의 이름 속성 값입니다.
contentString메타 태그의 콘텐츠 속성 값입니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.


append(addedContent)

HtmlOutput의 콘텐츠에 새 콘텐츠를 추가합니다. 이스케이프되지 않으므로 신뢰할 수 있는 소스의 콘텐츠에만 사용하세요.

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

매개변수

이름유형설명
addedContentString추가할 콘텐츠입니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.

예외 처리

Error — HTML 형식이 잘못된 경우

참고 항목


appendUntrusted(addedContent)

컨텍스트 이스케이프를 사용하여 이 HtmlOutput의 콘텐츠에 새 콘텐츠를 추가합니다.

이 메서드는 HtmlOutput의 현재 상태에 따라 콘텐츠를 올바르게 이스케이프 처리합니다. 따라서 결과가 마크업이나 측면에 영향을 미치지 않는 안전한 문자열입니다. 신뢰할 수 없는 출처(예: 사용자의 콘텐츠)에서 콘텐츠를 추가할 때마다 추가를 사용하지 말고 이 코드를 사용하세요. 추가하는 콘텐츠 또는 마크업으로 인해 예상치 못한 코드 실행이 발생하는 교차 사이트 스크립팅(XSS) 버그를 실수로 허용하지 않도록 해야 합니다.

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

매개변수

이름유형설명
addedContentString추가할 콘텐츠입니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.

예외 처리

Error: HTML 형식이 잘못된 경우

참고 항목


asTemplate()

HtmlOutput에서 지원되는 HtmlTemplate를 반환합니다. 이 방법을 사용하여 템플릿을 점진적으로 빌드할 수 있습니다. HtmlOutput의 향후 변경사항은 HtmlTemplate의 콘텐츠에도 영향을 미칩니다.

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

Return

HtmlTemplate: 새 HtmlTemplate입니다.


clear()

현재 콘텐츠를 지웁니다.

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

Return

HtmlOutput: 이 출력으로 체이닝용입니다.


getAs(contentType)

이 객체 내의 데이터를 지정된 콘텐츠 유형으로 변환된 blob으로 반환합니다. 이 방법은 파일 이름에 적절한 확장자를 추가합니다(예: "myfile.pdf"). 그러나 마지막 마침표 다음에 오는 파일 이름 부분이 (있는 경우) 대체되어야 하는 기존 확장 프로그램이라고 가정합니다. 따라서 'ShoppingList.12.25.2014"는 'ShoppingList.12.25.pdf"가 됩니다.

전환의 일일 할당량을 보려면 Google 서비스 할당량을 참조하세요. 새로 생성된 Google Workspace 도메인에는 일시적으로 더 엄격한 할당량이 적용될 수 있습니다.

매개변수

이름유형설명
contentTypeString변환할 MIME 유형입니다. 대부분의 blob에서 'application/pdf'가 유효한 유일한 옵션입니다. BMP, GIF, JPEG 또는 PNG 형식의 이미지도 'image/bmp', 'image/gif', 'image/jpeg' 또는 'image/png' 모두 유효합니다.

Return

Blob: blob 데이터입니다.


getBlob()

이 객체 내의 데이터를 blob으로 반환합니다.

Return

Blob: blob 데이터입니다.


getContent()

HtmlOutput의 콘텐츠를 가져옵니다.

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

Return

String: 제공되는 콘텐츠입니다.


getFaviconUrl()

setFaviconUrl(iconUrl)을 호출하여 페이지에 추가된 파비콘 링크 태그의 URL을 가져옵니다. Apps Script HTML 파일에 직접 포함된 파비콘 링크 태그는 무시됩니다.

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

Return

String: 파비콘 이미지의 URL입니다.


getHeight()

Google Docs, Sheets, Forms에서 맞춤 대화상자의 초기 높이를 가져옵니다. 대신 HtmlOutput가 웹 앱으로 게시되면 이 메서드는 null를 반환합니다. 이미 열려 있는 대화상자의 크기를 조절하려면 클라이언트 측 코드에서 google.script.host.setHeight(height)를 호출합니다.

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

Return

Integer — 높이(픽셀)입니다.


getMetaTags()

addMetaTag(name, content)를 호출하여 페이지에 추가된 메타 태그를 나타내는 객체의 배열을 가져옵니다. Apps Script HTML 파일에 직접 포함된 메타 태그는 무시됩니다.

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

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

Return

HtmlOutputMetaTag[]: addMetaTag(name, content)를 호출하여 페이지에 추가된 메타 태그를 나타내는 객체의 배열입니다.


getTitle()

출력 페이지의 제목을 가져옵니다. '제목' HTML 요소는 무시됩니다.

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

Return

String — 페이지 제목입니다.


getWidth()

Google Docs, Sheets, Forms에서 맞춤 대화상자의 초기 너비를 가져옵니다. 대신 HtmlOutput가 웹 앱으로 게시되면 이 메서드는 null를 반환합니다. 이미 열려 있는 대화상자의 크기를 조절하려면 클라이언트 측 코드에서 google.script.host.setWidth(width)를 호출합니다.

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

Return

Integer — 픽셀 단위의 너비입니다.


setContent(content)

HtmlOutput의 콘텐츠를 설정합니다.

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

매개변수

이름유형설명
contentString게재할 콘텐츠입니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.

예외 처리

Error — HTML 형식이 잘못된 경우


setFaviconUrl(iconUrl)

페이지에 파비콘 링크 태그를 추가합니다. Apps Script HTML 파일에 직접 포함된 파비콘 링크 태그는 무시됩니다.

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

매개변수

이름유형설명
iconUrlString파비콘 이미지의 URL이며, 이미지 확장자는 이미지 유형을 나타냅니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.


setHeight(height)

Google Docs, Sheets, Forms에서 맞춤 대화상자의 초기 높이를 설정합니다. 대신 HtmlOutput가 웹 앱으로 게시되면 이 메서드는 적용되지 않습니다. 이미 열려 있는 대화상자의 크기를 조절하려면 클라이언트 측 코드에서 google.script.host.setHeight(height)를 호출합니다.

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

매개변수

이름유형설명
heightInteger새 높이(픽셀)입니다. null을 사용하면 기본값이 생성됩니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.


setSandboxMode(mode)

이 메서드는 이제 아무런 영향을 미치지 않습니다. 이전에는 클라이언트 측 스크립트에 사용되는 sandbox mode를 설정했습니다. 사용자에게 악성 HTML 또는 자바스크립트가 제공되지 않도록 보호하기 위해 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>

매개변수

이름유형설명
modeSandboxMode사용할 샌드박스 모드입니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.


setTitle(title)

출력 페이지의 제목을 설정합니다. 웹 앱의 경우 전체 페이지의 제목이고 Google Sheets의 경우 HtmlOutput이 대화상자 제목입니다.

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

매개변수

이름유형설명
titleString새 제목

Return

HtmlOutput: 이 출력으로 체이닝용입니다.


setWidth(width)

Google Docs, Sheets, Forms에서 맞춤 대화상자의 초기 너비를 설정합니다. 대신 HtmlOutput가 웹 앱으로 게시되면 이 메서드는 적용되지 않습니다. 이미 열려 있는 대화상자의 크기를 조절하려면 클라이언트 측 코드에서 google.script.host.setWidth(width)를 호출합니다.

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

매개변수

이름유형설명
widthInteger새 너비(픽셀)입니다. null을 사용하면 기본값이 생성됩니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.


setXFrameOptionsMode(mode)

클릭재킹 방지를 제어하는 페이지의 X-Frame-Options 헤더 상태를 설정합니다.

XFrameOptionsMode.ALLOWALL를 설정하면 모든 사이트에서 페이지를 iframe할 수 있으므로 개발자는 클릭재킹에 대한 자체 보호 기능을 구현해야 합니다.

스크립트에 X-Frame-Options 모드가 설정되어 있지 않으면 Apps Script가 XFrameOptionsMode.DEFAULT 모드를 기본값으로 사용합니다.

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

매개변수

이름유형설명
modeXFrameOptionsMode설정할 XFrame 옵션 모드입니다.

Return

HtmlOutput: 이 출력으로 체이닝용입니다.