Class HtmlOutput

HtmlOutput

Komut dosyasından sunulabilecek bir HtmlOutput nesnesi. Güvenlikle ilgili nedenlerden dolayı, komut dosyaları HTML'yi doğrudan bir tarayıcıya döndüremez. Bunun yerine, temizlenmesi için kötü amaçlı işlemler gerçekleştiremez. Temizlenmiş HTML'yi şu şekilde döndürebilirsiniz:

function doGet() {
  return HtmlService.createHtmlOutput('<b>Hello, world!</b>');
}
. HtmlOutput içindeki kod, yerleştirilmiş JavaScript ve CSS içerebilir. (Bu, standart DOM'yi değiştiren (Apps Komut Dosyası'nı değil), istemci taraflı JavaScript'i seçin. Bu içeriğin tamamı iframe ile korumalı alana alınmış korumalı alan kullanımı ile ilgili daha fazla bilgi edinin. Daha fazla bilgi için HTML hizmetindeki kısıtlamalar rehberine bakın.

Yöntemler

YöntemDönüş türüKısa açıklama
addMetaTag(name, content)HtmlOutputSayfaya bir meta etiket ekler.
append(addedContent)HtmlOutputBu HtmlOutput içeriğinin içeriğine yeni içerik ekler.
appendUntrusted(addedContent)HtmlOutputBağlamsal çıkış yöntemini kullanarak bu HtmlOutput içeriğinin içeriğine yeni içerik ekler.
asTemplate()HtmlTemplateBu HtmlOutput tarafından desteklenen bir HtmlTemplate döndürür.
clear()HtmlOutputMevcut içeriği temizler.
getAs(contentType)BlobBu nesnenin içindeki verileri, belirtilen içerik türüne dönüştürülmüş bir blob olarak döndürün.
getBlob()BlobBu nesnenin içindeki verileri blob olarak döndürün.
getContent()StringBu HtmlOutput içeriğini alır.
getFaviconUrl()StringsetFaviconUrl(iconUrl) yöntemini çağırarak sayfaya eklenen site simgesi bağlantı etiketinin URL'sini alır.
getHeight()IntegerGoogle'daki özel iletişim kutusunun ilk yüksekliğini alır Dokümanlar, E-Tablolar veya Formlar'ı tıklayın.
getMetaTags()HtmlOutputMetaTag[]addMetaTag(name, content) yöntemini çağırarak sayfaya eklenen meta etiketleri temsil eden bir nesne dizisi alır.
getTitle()StringÇıkış sayfasının başlığını alır.
getWidth()IntegerGoogle'daki özel iletişim kutusunun ilk genişliğini alır Dokümanlar, E-Tablolar veya Formlar'ı tıklayın.
setContent(content)HtmlOutputBu HtmlOutput öğesinin içeriğini ayarlar.
setFaviconUrl(iconUrl)HtmlOutputSayfaya bir site simgesi için bağlantı etiketi ekler.
setHeight(height)HtmlOutputGoogle'daki özel iletişim kutusunun ilk yüksekliğini ayarlar Dokümanlar, E-Tablolar veya Formlar'ı tıklayın.
setSandboxMode(mode)HtmlOutputBu yöntemin artık bir etkisi yok. Daha önce istemci taraflı komut dosyaları için kullanılan sandbox mode yöntemi ayarlanmıştı.
setTitle(title)HtmlOutputÇıkış sayfasının başlığını ayarlar.
setWidth(width)HtmlOutputGoogle'daki özel iletişim kutusunun ilk genişliğini ayarlar Dokümanlar, E-Tablolar veya Formlar'ı tıklayın.
setXFrameOptionsMode(mode)HtmlOutputSayfadaki tıklama korsanlığını kontrol eden X-Frame-Options başlığının durumunu ayarlar önlemede çok etkilidir.

Ayrıntılı belgeler

addMetaTag(name, content)

Sayfaya bir meta etiket ekler. Doğrudan Apps Komut Dosyası HTML dosyasında bulunan meta etiketler, yoksayıldı. Yalnızca aşağıdaki meta etiketlere izin verilir:

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

Parametreler

AdTürAçıklama
nameStringMeta etiketin ad özelliğinin değeri.
contentStringMeta etiketin content özelliğinin değeri.

Return

HtmlOutput: Zincirleme için bu çıkış.


append(addedContent)

Bu HtmlOutput içeriğinin içeriğine yeni içerik ekler. Bunu yalnızca şu içerik için kullanın: çıkış karaktersiz olduğundan emin olun.

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

Parametreler

AdTürAçıklama
addedContentStringEklenecek içerik.

Return

HtmlOutput: Zincirleme için bu çıkış.

Fırlatma

Error: HTML hatalı biçimlendirilmişse

Aşağıdaki kaynakları da incelemenizi öneririz:


appendUntrusted(addedContent)

Bağlamsal çıkış yöntemini kullanarak bu HtmlOutput içeriğinin içeriğine yeni içerik ekler.

Bu yöntem, HtmlOutput öğesinin mevcut durumuna göre içeriğin çıkışını doğru bir şekilde yapar Böylece sonuç, işaretleme veya yan etki içermeyen güvenli bir dize olur. gibi güvenilir olmayan bir kaynaktan içerik eklediğinizde [ör. bir kullanıcıdan gelen içeriği] ekleyin. eklediğiniz içeriğin veya işaretlemenin yanlışlıkla eklendiği bir siteler arası komut dosyası (XSS) hatasına izin verme beklenmedik kod yürütülmesine neden olur.

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

Parametreler

AdTürAçıklama
addedContentStringEklenecek içerik.

Return

HtmlOutput: Zincirleme için bu çıkış.

Fırlatma

Error — HTML çok bozuksa

Aşağıdaki kaynakları da incelemenizi öneririz:


asTemplate()

Bu HtmlOutput tarafından desteklenen bir HtmlTemplate döndürür. Bu yöntem, aşamalı olarak bir şablon oluşturun. HtmlOutput üzerinde gelecekte yapılacak değişiklikler aşağıdakilerin içeriğini etkileyecek HtmlTemplate de var.

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

Return

HtmlTemplate — Yeni HtmlTemplate.


clear()

Mevcut içeriği temizler.

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

Return

HtmlOutput: Zincirleme için bu çıkış.


getAs(contentType)

Bu nesnenin içindeki verileri, belirtilen içerik türüne dönüştürülmüş bir blob olarak döndürün. Bu yöntemi, dosya adına uygun uzantıyı ekler. Örneğin, "dosyam.pdf". Ancak, dosya adında son noktadan sonra gelen bölümün (varsa) mevcut bir alan olduğunu varsayar değiştirilmesi gereken uzantıdır. Sonuç olarak, "AlışverişListesi.12.25.2014" şu olur: "ShoppingList.12.25.pdf".

Günlük dönüşüm kotalarını görüntülemek için bkz. Google için Kotalar Hizmetler. Yeni oluşturulan Google Workspace alanları geçici olarak daha sıkılığa tabi olabilir kotalar.

Parametreler

AdTürAçıklama
contentTypeStringDönüşümün gerçekleştirileceği MIME türü. Çoğu blob için 'application/pdf', tek geçerli seçenektir. BMP, GIF, JPEG veya PNG biçimindeki resimler için 'image/bmp', 'image/gif', 'image/jpeg' veya 'image/png''ten herhangi biri de geçerlidir. Bir Google Dokümanlar dokümanı için 'text/markdown' ayrıca geçerlidir.

Return

Blob — Veriler bir blob olarak.


getBlob()

Bu nesnenin içindeki verileri blob olarak döndürün.

Return

Blob — Veriler bir blob olarak.


getContent()

Bu HtmlOutput içeriğini alır.

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

Return

String — Sunulan içerik.


getFaviconUrl()

setFaviconUrl(iconUrl) yöntemini çağırarak sayfaya eklenen site simgesi bağlantı etiketinin URL'sini alır. Doğrudan Apps Komut Dosyası HTML dosyasında bulunan site simgesi bağlantı etiketleri yoksayıldı.

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

Return

String — Site simgesi resminin URL'si.


getHeight()

Google'daki özel iletişim kutusunun ilk yüksekliğini alır Dokümanlar, E-Tablolar veya Formlar'ı tıklayın. HtmlOutput bunun yerine web uygulaması olarak yayınlanırsa yöntemi null değerini döndürür. Açık olan bir iletişim kutusunu yeniden boyutlandırmak için şu çağrıyı yapın: google.script.host.setHeight(height) olarak ayarlayın.

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

Return

Integer: Piksel cinsinden yükseklik.


getMetaTags()

addMetaTag(name, content) yöntemini çağırarak sayfaya eklenen meta etiketleri temsil eden bir nesne dizisi alır. Doğrudan bir Apps Komut Dosyası HTML dosyasında bulunan meta etiketler, yoksayıldı.

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) çağrısı yapılarak sayfaya eklenen meta etiketleri temsil eden bir nesne dizisi.


getTitle()

Çıkış sayfasının başlığını alır. <title> HTML öğesi yok sayılır.

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

Return

String: Sayfanın başlığı.


getWidth()

Google'daki özel iletişim kutusunun ilk genişliğini alır Dokümanlar, E-Tablolar veya Formlar'ı tıklayın. HtmlOutput bunun yerine web uygulaması olarak yayınlanırsa yöntemi null değerini döndürür. Açık olan bir iletişim kutusunu yeniden boyutlandırmak için şu çağrıyı yapın: google.script.host.setWidth(width) olarak ayarlayın.

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

Return

Integer: Piksel cinsinden genişlik.


setContent(content)

Bu HtmlOutput öğesinin içeriğini ayarlar.

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

Parametreler

AdTürAçıklama
contentStringYayınlanacak içerik.

Return

HtmlOutput: Zincirleme için bu çıkış.

Fırlatma

Error: HTML hatalı biçimlendirilmişse


setFaviconUrl(iconUrl)

Sayfaya bir site simgesi için bağlantı etiketi ekler. Doğrudan Uygulamalara dahil edilen site simgesi bağlantı etiketleri Komut dosyası HTML dosyası yoksayılır.

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

Parametreler

AdTürAçıklama
iconUrlStringSite simgesi resminin URL'si (resim uzantısı, resmi gösteren) türü.

Return

HtmlOutput: Zincirleme için bu çıkış.


setHeight(height)

Google'daki özel iletişim kutusunun ilk yüksekliğini ayarlar Dokümanlar, E-Tablolar veya Formlar'ı tıklayın. HtmlOutput bunun yerine web uygulaması olarak yayınlanırsa yönteminin hiçbir etkisi yoktur. Açık olan bir iletişim kutusunu yeniden boyutlandırmak için işlevini çağırın google.script.host.setHeight(height) olarak ayarlayın.

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

Parametreler

AdTürAçıklama
heightIntegerPiksel cinsinden yeni yükseklik; null işlevinin sonucu, varsayılan bir değerdir.

Return

HtmlOutput: Zincirleme için bu çıkış.


setSandboxMode(mode)

Bu yöntemin artık bir etkisi yok. Daha önce istemci taraflı komut dosyaları için kullanılan sandbox mode yöntemi ayarlanmıştı. Kullanıcılara kötü amaçlı HTML veya JavaScript, HTML hizmetinden sunulan istemci tarafı kodu, üçüncü taraf sunucularınızı koda kısıtlamalar getirir. İlk başta bu yöntem, komut dosyası yazarlarının seçmesine olanak tanıyordu korumalı alan, farklı sürümler arasında, ancak artık tüm komut dosyaları artık IFRAME modunu kullanıyor korumalı alan modunun ayarından bağımsız olarak kontrol edin. Daha fazla bilgi için HTML hizmetindeki kısıtlamalar rehberine bakın.

IFRAME modu, diğer korumalı alan modlarına kıyasla çok daha az kısıtlama uygular ve en hızlı çalışır, ancak Internet Explorer gibi bazı eski tarayıcılarda hiç çalışmaz 9. Korumalı alan modu, google.script.sandbox.mode öğesi denetlenerek istemci taraflı bir komut dosyasında okunabilir. Bu özelliğin istemcide gerçek modu döndürdüğünü unutmayın. Bu, istenen mod desteklenmiyorsa sunucuda istenen moddan farklı olabilir. adresini ziyaret ederek kontrol edebilirsiniz.

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

Parametreler

AdTürAçıklama
modeSandboxModeKullanılacak korumalı alan modu.

Return

HtmlOutput: Zincirleme için bu çıkış.


setTitle(title)

Çıkış sayfasının başlığını ayarlar. Web uygulamaları için bu, tüm sayfanın başlığıdır. Google E-Tablolar'da gösterilen HtmlOutput için iletişim kutusu başlığı.

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

Parametreler

AdTürAçıklama
titleStringYeni başlık.

Return

HtmlOutput: Zincirleme için bu çıkış.


setWidth(width)

Google'daki özel iletişim kutusunun ilk genişliğini ayarlar Dokümanlar, E-Tablolar veya Formlar'ı tıklayın. HtmlOutput bunun yerine web uygulaması olarak yayınlanırsa yönteminin hiçbir etkisi yoktur. Açık olan bir iletişim kutusunu yeniden boyutlandırmak için şu çağrıyı yapın: google.script.host.setWidth(width) olarak ayarlayın.

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

Parametreler

AdTürAçıklama
widthIntegerPiksel cinsinden yeni genişlik; null işlevinin sonucu, varsayılan bir değerdir.

Return

HtmlOutput: Zincirleme için bu çıkış.


setXFrameOptionsMode(mode)

Sayfadaki tıklama korsanlığını kontrol eden X-Frame-Options başlığının durumunu ayarlar önlemede çok etkilidir.

XFrameOptionsMode.ALLOWALL politikasının ayarlanması, herhangi bir sitenin sayfaya iframe yapmasına izin verir. Bu nedenle geliştiricileri tıklama korsanlığına karşı kendi korumalarını uygulamalıdır.

Bir komut dosyası X-Frame-Options modunu ayarlamazsa Apps Komut Dosyası, varsayılan olarak XFrameOptionsMode.DEFAULT modunu kullanır.

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

Parametreler

AdTürAçıklama
modeXFrameOptionsModeAyarlanacak XFrame seçenekler modu.

Return

HtmlOutput: Zincirleme için bu çıkış.