Class HtmlOutput

HtmlOutput

Obiekt HtmlOutput, który może być wyświetlany ze skryptu. Ze względów bezpieczeństwa skrypty nie mogą bezpośrednio zwracać kodu HTML do przeglądarki. Zamiast tego muszą być oczyszczone, nie mogą wykonywać szkodliwych działań. Przetworzony kod HTML możesz zwrócić w ten sposób:

function doGet() {
  return HtmlService.createHtmlOutput('<b>Hello, world!</b>');
}
Kod w HtmlOutput może zawierać osadzony JavaScript i CSS. (To standard JavaScript po stronie klienta, który modyfikuje model DOM, a nie Apps Script). Wszystkie te treści w piaskownicy za pomocą iframe w piaskownicy. Więcej informacji znajdziesz w przewodniku po ograniczeniach w usłudze HTML.

Metody

MetodaZwracany typKrótki opis
addMetaTag(name, content)HtmlOutputDodaje metatag do strony.
append(addedContent)HtmlOutputDołącza nowe treści do zawartości tego elementu HtmlOutput.
appendUntrusted(addedContent)HtmlOutputDołącza nowe treści do treści tego elementu HtmlOutput przy użyciu kontekstowego zmiany znaczenia.
asTemplate()HtmlTemplateZwraca HtmlTemplate wspierany przez ten argument HtmlOutput.
clear()HtmlOutputUsuwa bieżącą zawartość.
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane wewnątrz tego obiektu jako obiekt blob.
getContent()StringPobiera zawartość tego zasobu (HtmlOutput).
getFaviconUrl()StringPobiera adres URL tagu linku favikony dodanego do strony przez wywołanie metody setFaviconUrl(iconUrl).
getHeight()IntegerPobiera początkową wysokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze.
getMetaTags()HtmlOutputMetaTag[]Pobiera tablicę obiektów reprezentujących metatagi dodane do strony przez wywołanie metody addMetaTag(name, content).
getTitle()StringPobiera tytuł strony wyjściowej.
getWidth()IntegerPobiera początkową szerokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze.
setContent(content)HtmlOutputUstawia zawartość tego elementu (HtmlOutput).
setFaviconUrl(iconUrl)HtmlOutputDodaje do strony tag linku dla favikony.
setHeight(height)HtmlOutputUstawia początkową wysokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze.
setSandboxMode(mode)HtmlOutputTa metoda nie działa – poprzednio ustawiała właściwość sandbox mode używaną w przypadku skryptów po stronie klienta.
setTitle(title)HtmlOutputUstawia tytuł strony wyjściowej.
setWidth(width)HtmlOutputOkreśla początkową szerokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze.
setXFrameOptionsMode(mode)HtmlOutputUstawia stan nagłówka X-Frame-Options strony, który kontroluje przechwytywanie kliknięć profilaktyki.

Szczegółowa dokumentacja

addMetaTag(name, content)

Dodaje metatag do strony. Metatagi umieszczone bezpośrednio w pliku HTML Apps Script są zignorowano. Dozwolone są tylko te metatagi:

<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');

Parametry

NazwaTypOpis
nameStringWartość atrybutu name tagu meta.
contentStringWartość atrybutu content tagu meta.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.


append(addedContent)

Dołącza nowe treści do treści tego elementu HtmlOutput. Używaj go tylko w przypadku treści z zaufanego źródła, ponieważ nie ma on znaczenia.

// 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());

Parametry

NazwaTypOpis
addedContentStringTreść do dołączenia.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.

Rzuty

Error – jeśli kod HTML jest nieprawidłowy

Zobacz też


appendUntrusted(addedContent)

Dołącza nowe treści do treści tego elementu HtmlOutput przy użyciu kontekstowego zmiany znaczenia.

Ta metoda prawidłowo zmienia znaczenie treści na podstawie bieżącego stanu obiektu HtmlOutput, aby uzyskać bezpieczny ciąg znaków bez znaczników i elementów dodatkowych. Używaj zamiast dołączaj przy każdym dodawaniu treści z niezaufanego źródła, np. od użytkownika, aby uniknąć przypadkowe zezwalanie na błąd typu cross-site scripting (XSS), który powoduje dodanie dodanych treści lub znaczników. powoduje nieoczekiwane uruchomienie kodu.

// 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());

Parametry

NazwaTypOpis
addedContentStringTreść do dołączenia.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.

Rzuty

Error – jeśli kod HTML jest bardzo nieprawidłowy

Zobacz też


asTemplate()

Zwraca HtmlTemplate wspierany przez ten argument HtmlOutput. Można jej używać do: tworzyć szablony stopniowo. Przyszłe zmiany w usłudze HtmlOutput będą miały wpływ na zawartość tych usług: HtmlTemplate.

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

Powrót

HtmlTemplate – nowe HtmlTemplate.


clear()

Usuwa bieżącą zawartość.

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

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.


getAs(contentType)

Zwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści. Ten dodaje do nazwy pliku odpowiednie rozszerzenie, na przykład „mojplik.pdf”. Jednak zakłada, że część nazwy pliku, która następuje po ostatnim kropce (jeśli występuje), jest już , które należy zastąpić. W rezultacie „ShoppingList.12.25.2014” zmienia się w „ShoppingList.12.25.pdf”.

Aby wyświetlić dzienne limity konwersji, zobacz Limity dla Google Usługi. Nowo utworzone domeny Google Workspace mogą być tymczasowo bardziej rygorystyczne limity.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME do skonwertowania. W przypadku większości blobów atrybut 'application/pdf' to jedyną prawidłową opcją. W przypadku zdjęć w formacie BMP, GIF, JPEG lub PNG możesz też użyć dowolnego z tych atrybutów: 'image/bmp', 'image/gif', 'image/jpeg' lub 'image/png'. prawidłowe. W przypadku dokumentów w Dokumentach Google prawidłowa jest też wartość 'text/markdown'.

Powrót

Blob – dane w postaci obiektu blob.


getBlob()

Zwraca dane wewnątrz tego obiektu jako obiekt blob.

Powrót

Blob – dane w postaci obiektu blob.


getContent()

Pobiera zawartość tego zasobu (HtmlOutput).

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

Powrót

String – wyświetlana treść.


getFaviconUrl()

Pobiera adres URL tagu linku favikony dodanego do strony przez wywołanie metody setFaviconUrl(iconUrl). Tagi linku favikony umieszczone bezpośrednio w pliku HTML Apps Script są zignorowano.

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

Powrót

String – adres URL favikony.


getHeight()

Pobiera początkową wysokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze. Jeśli HtmlOutput została opublikowana jako aplikacja internetowa, ten zwraca wartość null. Aby zmienić rozmiar okna, które jest już otwarte, wywołaj google.script.host.setHeight(height) w kodzie po stronie klienta.

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

Powrót

Integer – wysokość w pikselach.


getMetaTags()

Pobiera tablicę obiektów reprezentujących metatagi dodane do strony przez wywołanie metody addMetaTag(name, content). Metatagi umieszczone bezpośrednio w pliku HTML Apps Script są zignorowano.

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());

Powrót

HtmlOutputMetaTag[] – tablica obiektów reprezentujących metatagi dodanych do strony przez wywołanie addMetaTag(name, content).


getTitle()

Pobiera tytuł strony wyjściowej. Pamiętaj, że w tagu <title> Element HTML jest ignorowany.

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

Powrót

String – tytuł strony.


getWidth()

Pobiera początkową szerokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze. Jeśli HtmlOutput została opublikowana jako aplikacja internetowa, ten zwraca wartość null. Aby zmienić rozmiar okna, które jest już otwarte, wywołaj google.script.host.setWidth(width) w kodzie po stronie klienta.

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

Powrót

Integer – szerokość w pikselach.


setContent(content)

Ustawia zawartość tego elementu (HtmlOutput).

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

Parametry

NazwaTypOpis
contentStringTreść do wyświetlenia.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.

Rzuty

Error – jeśli kod HTML jest nieprawidłowy.


setFaviconUrl(iconUrl)

Dodaje do strony tag linku dla favikony. Tagi linku do favikony dołączane bezpośrednio do aplikacji Plik HTML skryptu są ignorowane.

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

Parametry

NazwaTypOpis
iconUrlStringAdres URL favikony, przy czym rozszerzenie graficzne wskazuje obraz typu.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.


setHeight(height)

Ustawia początkową wysokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze. Jeśli HtmlOutput została opublikowana jako aplikacja internetowa, ten tag nie ma żadnego efektu. Aby zmienić rozmiar okna, które jest już otwarte, wywołaj google.script.host.setHeight(height) w kodzie po stronie klienta.

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

Parametry

NazwaTypOpis
heightIntegerNowa wysokość w pikselach; null zwraca wartość domyślną.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.


setSandboxMode(mode)

Ta metoda nie działa – poprzednio ustawiała właściwość sandbox mode używaną w przypadku skryptów po stronie klienta. aby chronić użytkowników przed złośliwym kodem HTML lub JavaScript, kod po stronie klienta udostępniany z usługi HTML jest wykonywany w bezpiecznej piaskownicy, nakłada ograniczenia na kod. Początkowo ta metoda umożliwiała autorom skryptów wybór między różnymi wersjami piaskownicy, ale teraz wszystkie skrypty korzystają teraz z trybu IFRAME bez względu na ustawiony tryb piaskownicy. Więcej informacji znajdziesz w przewodniku po ograniczeniach w usłudze HTML.

Tryb IFRAME nakłada o wiele mniej ograniczeń niż pozostałe tryby piaskownicy. działa najszybciej, ale nie działa w niektórych starszych przeglądarkach, w tym Internet Explorerze. 9. Tryb piaskownicy można odczytać w skrypcie po stronie klienta, sprawdzając google.script.sandbox.mode. Zwróć uwagę, że ta właściwość zwraca rzeczywisty tryb klienta, który może się różnić od trybu żądanego przez serwer, jeśli żądany tryb nie jest obsługiwany. w przeglądarce użytkownika.

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

Parametry

NazwaTypOpis
modeSandboxModeTryb piaskownicy, który ma być używany.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.


setTitle(title)

Ustawia tytuł strony wyjściowej. W przypadku aplikacji internetowych jest to tytuł całej strony, a jest to tytuł okna dialogowego dla dokumentu HtmlOutput.

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

Parametry

NazwaTypOpis
titleStringNowy tytuł.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.


setWidth(width)

Określa początkową szerokość okna niestandardowego w Google Dokumenty, Arkusze lub Formularze. Jeśli HtmlOutput została opublikowana jako aplikacja internetowa, ten tag nie ma żadnego efektu. Aby zmienić rozmiar okna, które jest już otwarte, wywołaj google.script.host.setWidth(width) w kodzie po stronie klienta.

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

Parametry

NazwaTypOpis
widthIntegerNowa szerokość w pikselach; null zwraca wartość domyślną.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.


setXFrameOptionsMode(mode)

Ustawia stan nagłówka X-Frame-Options strony, który kontroluje przechwytywanie kliknięć profilaktyki.

Jeśli zasada XFrameOptionsMode.ALLOWALL pozwala umieścić stronę w elemencie iframe, tag powinien wdrożyć własną ochronę przed przechwytywaniem kliknięć.

Jeśli skrypt nie ustawia trybu X-Frame-Options, Apps Script domyślnie używa trybu 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);

Parametry

NazwaTypOpis
modeXFrameOptionsModeTryb opcji XFrame do ustawienia.

Powrót

HtmlOutput – dane wyjściowe do łańcuchów.