מחלקה של google.script.host (ממשק API בצד הלקוח)
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
google.script.host
הוא ממשק API אסינכרוני של JavaScript בצד הלקוח שיכול לקיים אינטראקציה
עם תיבות דו-שיח או סרגלי צד ב-Google Docs, ב-Sheets או ב-Forms שמכילים
דפי שירות HTML. כדי להפעיל פונקציות בצד השרת מ:
קוד בצד הלקוח, משתמשים ב-google.script.run
. מידע נוסף זמין במאמר הבא:
ה
מדריך לתקשורת עם פונקציות שרת
בשירות HTML.
מאפיינים
נכס | תיאור |
origin | מספק את הדומיין המארח, כך שסקריפטים יכולים להגדיר את
המקור בצורה נכונה. |
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
close() |
void |
סגירת תיבת הדו-שיח או סרגל הצד הנוכחיים. |
editor.focus() |
void |
משנה את המיקוד של הדפדפן מתיבת הדו-שיח או סרגל הצד לעורך של Google Docs, Sheets או Forms. |
setHeight(height) |
void |
מגדיר את הגובה של תיבת הדו-שיח הנוכחית. |
setWidth(width) |
void |
מגדיר את הרוחב של תיבת הדו-שיח הנוכחית. |
מסמכי תיעוד מפורטים
close()
סגירת תיבת הדו-שיח או סרגל הצד הנוכחיים.
Code.gs
function onOpen(e) {
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();
}
function showSidebar() {
var html = HtmlService.createHtmlOutputFromFile('Index');
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.showSidebar(html);
}
Index.html
<input type="button" value="Close"
onclick="google.script.host.close()" />
editor.focus()
משנה את המיקוד של הדפדפן מתיבת הדו-שיח או סרגל הצד לעורך של Google Docs, Sheets או Forms.
Code.gs
function onOpen(e) {
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();
}
function showSidebar() {
var html = HtmlService.createHtmlOutputFromFile('Index');
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.showSidebar(html);
}
Index.html
<input type="button" value="Switch focus"
onclick="google.script.host.editor.focus()" />
setHeight(height)
מגדיר את הגובה של תיבת הדו-שיח הנוכחית.
Code.gs
function onOpen(e) {
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.createMenu('Dialog').addItem('Show', 'showDialog').addToUi();
}
function showDialog() {
var html = HtmlService.createHtmlOutputFromFile('Index')
.setWidth(300)
.setHeight(200);
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.showModalDialog(html, 'Dialog title');
}
Index.html
<script>
function resizeDialog(width, height) {
google.script.host.setWidth(width);
google.script.host.setHeight(height);
}
</script>
<input type="button" value="Resize dialog"
onclick="resizeDialog(450, 300)" />
פרמטרים
שם | סוג | תיאור |
height | Integer | הגובה החדש, בפיקסלים |
setWidth(width)
מגדיר את הרוחב של תיבת הדו-שיח הנוכחית.
Code.gs
function onOpen(e) {
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.createMenu('Dialog').addItem('Show', 'showDialog').addToUi();
}
function showDialog() {
var html = HtmlService.createHtmlOutputFromFile('Index')
.setWidth(300)
.setHeight(200);
SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
.showModalDialog(html, 'Dialog title');
}
Index.html
<script>
function resizeDialog(width, height) {
google.script.host.setWidth(width);
google.script.host.setHeight(height);
}
</script>
<input type="button" value="Resize dialog"
onclick="resizeDialog(450, 300)" />
פרמטרים
שם | סוג | תיאור |
width | Integer | הרוחב החדש, בפיקסלים |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\u003cp\u003e\u003ccode\u003egoogle.script.host\u003c/code\u003e is an asynchronous client-side JavaScript API used to interact with dialogs or sidebars in Google Docs, Sheets, or Forms containing HTML service pages.\u003c/p\u003e\n"],["\u003cp\u003eTo execute server-side functions from client-side code within these dialogs or sidebars, utilize \u003ccode\u003egoogle.script.run\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods like \u003ccode\u003eclose()\u003c/code\u003e, \u003ccode\u003eeditor.focus()\u003c/code\u003e, \u003ccode\u003esetHeight(height)\u003c/code\u003e, and \u003ccode\u003esetWidth(width)\u003c/code\u003e for controlling dialog and sidebar behavior.\u003c/p\u003e\n"],["\u003cp\u003eWhile \u003ccode\u003egoogle.script.host\u003c/code\u003e focuses on client-side interactions within HTML service pages, server-side communication is handled through \u003ccode\u003egoogle.script.run\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egoogle.script.host\u003c/code\u003e enables developers to create dynamic and interactive user interfaces within Google Workspace applications by seamlessly integrating client-side JavaScript with server-side Apps Script functionality.\u003c/p\u003e\n"]]],[],null,["# Class google.script.host (Client-side API)\n\n`google.script.host` is an asynchronous client-side JavaScript API that can interact\nwith dialogs or sidebars in Google Docs, Sheets, or Forms that contain\n[HTML-service pages](/apps-script/guides/html). To execute server-side functions from\nclient-side code, use [`google.script.run`](/apps-script/guides/html/reference/run). For more information, see\nthe\n[guide to communicating with server functions](/apps-script/guides/html/communication)\nin HTML service. \n\n### Properties\n\n| Property | Description |\n|----------|----------------------------------------------------------------------|\n| `origin` | Provides the host domain, so scripts can set their origin correctly. |\n\n### Methods\n\n| Method | Return type | Brief description |\n|------------------------------------------|-------------|------------------------------------------------------------------------------------------------|\n| [close()](#close()) | `void` | Closes the current dialog or sidebar. |\n| [editor.focus()](#editor.focus()) | `void` | Switches browser focus from the dialog or sidebar to the Google Docs, Sheets, or Forms editor. |\n| [setHeight(height)](#setHeight(Integer)) | `void` | Sets the height of the current dialog. |\n| [setWidth(width)](#setWidth(Integer)) | `void` | Sets the width of the current dialog. |\n\nDetailed documentation\n----------------------\n\n### `close()`\n\nCloses the current dialog or sidebar. \n\n### Code.gs\n\n```html\nfunction onOpen(e) {\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();\n}\n\nfunction showSidebar() {\n var html = HtmlService.createHtmlOutputFromFile('Index');\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .showSidebar(html);\n}\n```\n\n### Index.html\n\n```html\n\u003cinput type=\"button\" value=\"Close\"\n onclick=\"google.script.host.close()\" /\u003e\n```\n\n*** ** * ** ***\n\n### `editor.focus()`\n\nSwitches browser focus from the dialog or sidebar to the Google Docs, Sheets, or Forms editor. \n\n### Code.gs\n\n```html\nfunction onOpen(e) {\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();\n}\n\nfunction showSidebar() {\n var html = HtmlService.createHtmlOutputFromFile('Index');\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .showSidebar(html);\n}\n```\n\n### Index.html\n\n```html\n\u003cinput type=\"button\" value=\"Switch focus\"\n onclick=\"google.script.host.editor.focus()\" /\u003e\n```\n\n*** ** * ** ***\n\n### `setHeight(height)`\n\nSets the height of the current dialog. \n\n### Code.gs\n\n```html\nfunction onOpen(e) {\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .createMenu('Dialog').addItem('Show', 'showDialog').addToUi();\n}\n\nfunction showDialog() {\n var html = HtmlService.createHtmlOutputFromFile('Index')\n .setWidth(300)\n .setHeight(200);\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .showModalDialog(html, 'Dialog title');\n}\n```\n\n### Index.html\n\n```html\n\u003cscript\u003e\n function resizeDialog(width, height) {\n google.script.host.setWidth(width);\n google.script.host.setHeight(height);\n }\n\u003c/script\u003e\n\u003cinput type=\"button\" value=\"Resize dialog\"\n onclick=\"resizeDialog(450, 300)\" /\u003e\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|-----------|---------------------------|\n| `height` | `Integer` | the new height, in pixels |\n\n*** ** * ** ***\n\n### `setWidth(width)`\n\nSets the width of the current dialog. \n\n### Code.gs\n\n```html\nfunction onOpen(e) {\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .createMenu('Dialog').addItem('Show', 'showDialog').addToUi();\n}\n\nfunction showDialog() {\n var html = HtmlService.createHtmlOutputFromFile('Index')\n .setWidth(300)\n .setHeight(200);\n SpreadsheetApp.getUi() // Or DocumentApp or FormApp.\n .showModalDialog(html, 'Dialog title');\n}\n```\n\n### Index.html\n\n```html\n\u003cscript\u003e\n function resizeDialog(width, height) {\n google.script.host.setWidth(width);\n google.script.host.setHeight(height);\n }\n\u003c/script\u003e\n\u003cinput type=\"button\" value=\"Resize dialog\"\n onclick=\"resizeDialog(450, 300)\" /\u003e\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|-----------|--------------------------|\n| `width` | `Integer` | the new width, in pixels |"]]