Package google.apps.script.type

ดัชนี

• AddOnWidgetSet (ข้อความ)
• AddOnWidgetSet.WidgetType (enum)
• CommonAddOnManifest (ข้อความ)
• CreateActionExtensionPoint (ข้อความ)
• HomepageExtensionPoint (ข้อความ)
• HttpAuthorizationHeader (enum)
• HttpOptions (ข้อความ)
• LayoutProperties (ข้อความ)
• LinkPreviewExtensionPoint (ข้อความ)
• MenuItemExtensionPoint (ข้อความ)
• UniversalActionExtensionPoint (ข้อความ)
• UriPattern (ข้อความ)

AddOnWidgetSet

ชุดย่อยของวิดเจ็ตที่ส่วนเสริมใช้

ช่อง
usedWidgets[]	WidgetType รายการวิดเจ็ตที่ใช้ในส่วนเสริม

WidgetType

ประเภทวิดเจ็ต WIDGET_TYPE_UNSPECIFIED เป็นชุดวิดเจ็ตพื้นฐาน

Enum
WIDGET_TYPE_UNSPECIFIED	ชุดวิดเจ็ตเริ่มต้น
DATE_PICKER	เครื่องมือเลือกวันที่
STYLED_BUTTONS	ปุ่มที่มีการจัดรูปแบบจะมีปุ่มแบบเติมสีและปุ่มที่ปิดใช้งาน
PERSISTENT_FORMS	แบบฟอร์มถาวรช่วยให้คงค่าของแบบฟอร์มในระหว่างการดำเนินการ
FIXED_FOOTER	แก้ไขส่วนท้ายในการ์ดแล้ว
UPDATE_SUBJECT_AND_RECIPIENTS	อัปเดตเรื่องและผู้รับฉบับร่าง
GRID_WIDGET	วิดเจ็ตตารางกริด
ADDON_COMPOSE_UI_ACTION	การดำเนินการของส่วนเสริมของ Gmail ที่ใช้กับ UI การเขียนของส่วนเสริม

CommonAddOnManifest

การกำหนดค่าส่วนเสริมที่แชร์ในแอปพลิเคชันโฮสต์ของส่วนเสริมทั้งหมด

ช่อง
name	string ต้องระบุ ชื่อที่แสดงของส่วนเสริม
logoUrl	string ต้องระบุ URL ของรูปภาพโลโก้ที่แสดงในแถบเครื่องมือของส่วนเสริม
layoutProperties	LayoutProperties คุณสมบัติเลย์เอาต์ทั่วไปสำหรับการ์ดส่วนเสริม
addOnWidgetSet	AddOnWidgetSet วิดเจ็ตที่ใช้ในส่วนเสริม หากไม่ได้ระบุช่องนี้ ระบบจะใช้ชุดเริ่มต้น
useLocaleFromApp	bool เลือกว่าจะส่งข้อมูลภาษาจากแอปโฮสต์หรือไม่
homepageTrigger	HomepageExtensionPoint กำหนดปลายทางที่จะดำเนินการในบริบทต่างๆ ในทุกโฮสต์ การ์ดใดๆ ที่ฟังก์ชันนี้สร้างขึ้นจะพร้อมใช้งานสำหรับผู้ใช้เสมอ แต่เนื้อหาตามบริบทอาจบดบังไว้เมื่อส่วนเสริมนี้ประกาศทริกเกอร์ที่ตรงเป้าหมายมากขึ้น
universalActions[]	UniversalActionExtensionPoint กำหนดรายการจุดส่วนขยายในเมนูการทำงานทั่วไป ซึ่งทำหน้าที่เป็นเมนูการตั้งค่าสำหรับส่วนเสริม จุดขยายอาจจะเป็น URL ของลิงก์เพื่อเปิดหรือปลายทางสำหรับการดำเนินการเป็นการส่งแบบฟอร์ม
openLinkUrlPrefixes	ListValue การดำเนินการของ OpenLink สามารถใช้กับ URL ที่มีรูปแบบ HTTPS, MAILTO หรือ TEL เท่านั้น สำหรับลิงก์ HTTPS นั้น URL ต้องตรงกับคำนำหน้าหนึ่งในรายการที่ระบุไว้ในรายการที่อนุญาต หากคำนำหน้าไม่มีรูปแบบ ระบบจะถือว่าเป็น HTTPS ลิงก์ HTTP จะได้รับการเขียนใหม่ไปยัง HTTPS ลิงก์โดยอัตโนมัติ

CreateActionExtensionPoint

การกำหนดค่าสำหรับทริกเกอร์ที่เริ่มทำงานเมื่อผู้ใช้เรียกใช้เวิร์กโฟลว์การสร้างทรัพยากรในแอปพลิเคชัน Google Workspace ดูข้อมูลเพิ่มเติมได้ที่สร้างทรัพยากรของบุคคลที่สามจากเมนู @

ช่อง
id	string ต้องระบุ รหัสที่ไม่ซ้ำกันเพื่อแยกความแตกต่างของจุดต่อนี้ รหัสมีความยาวได้สูงสุด 64 อักขระและควรอยู่ในรูปแบบ [a-zA-Z0-9-]+
labelText	string ต้องระบุ ข้อความที่แสดงควบคู่ไปกับไอคอนสำหรับจุดแรกเข้าของการสร้างทรัพยากร เช่น Create support case ข้อความนี้เป็นแบบคงที่และแสดงก่อนที่ผู้ใช้จะเรียกใช้ส่วนเสริม
localizedLabelText	map<string, string> ไม่บังคับ แผนที่ของ labelText สำหรับแปลเป็นภาษาอื่นๆ จัดรูปแบบภาษาใน ISO 639 และประเทศ/ภูมิภาคใน ISO 3166 โดยคั่นด้วยขีดกลางสั้น - เช่น en-US หากมีภาษาของผู้ใช้อยู่ในคีย์ของแผนที่ ผู้ใช้จะเห็น labelText เวอร์ชันแปล
runFunction	string ต้องระบุ ปลายทางที่จะดำเนินการเมื่อมีการทริกเกอร์เวิร์กโฟลว์การสร้างทรัพยากรเพื่อสร้างลิงก์
logoUrl	string ไม่บังคับ ไอคอนที่แสดงสำหรับจุดแรกเข้าของการสร้างทรัพยากร หากละไว้ เมนูจะใช้ไอคอนแถบเครื่องมือของส่วนเสริม logoUrl

HomepageExtensionPoint

รูปแบบทั่วไปในการประกาศมุมมองหน้าแรกของส่วนเสริม

ช่อง
runFunction	string ต้องระบุ ปลายทางที่จะดำเนินการเมื่อมีการเปิดใช้งานจุดส่วนขยายนี้
enabled	BoolValue ไม่บังคับ หากตั้งค่าเป็น false จะปิดใช้งานมุมมองหน้าแรกในบริบทนี้ ค่าเริ่มต้นจะเป็น true หากไม่ได้ตั้งค่าไว้ หากมุมมองหน้าแรกที่กำหนดเองของส่วนเสริมปิดอยู่ คุณจะได้รับการ์ดภาพรวมทั่วไปสำหรับผู้ใช้แทน

HttpAuthorizationHeader

ส่งส่วนหัวการให้สิทธิ์ในคำขอ HTTP ส่วนเสริมแล้ว

Enum
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED	ค่าเริ่มต้น เทียบเท่ากับ SYSTEM_ID_TOKEN
SYSTEM_ID_TOKEN	ส่งโทเค็นรหัสสำหรับบัญชีบริการของระบบที่เป็นส่วนเสริมของ Google Workspace เฉพาะโปรเจ็กต์ (ค่าเริ่มต้น)
USER_ID_TOKEN	ส่งโทเค็นรหัสให้ผู้ใช้ปลายทาง
NONE	โปรดอย่าส่งส่วนหัวการตรวจสอบสิทธิ์

HttpOptions

ตัวเลือกในการส่งคําขอไปยังปลายทาง HTTP ส่วนเสริม

ช่อง
authorizationHeader	HttpAuthorizationHeader การกำหนดค่าสำหรับโทเค็นที่ส่งในส่วนหัวการให้สิทธิ์ HTTP

LayoutProperties

พร็อพเพอร์ตี้ของเลย์เอาต์การ์ดที่แชร์ในแอปพลิเคชันโฮสต์ส่วนเสริมทั้งหมด

ช่อง
primaryColor	string สีหลักของส่วนเสริม ซึ่งจะกำหนดสีของแถบเครื่องมือ หากไม่ได้ตั้งค่าสีหลักไว้ ระบบจะใช้ค่าเริ่มต้นที่เฟรมเวิร์กระบุไว้
secondaryColor	string สีรองของส่วนเสริม ซึ่งจะกำหนดสีของปุ่ม หากตั้งค่าสีหลักแล้วแต่ไม่ได้ตั้งค่าสีรอง สีรองจะเป็นสีเดียวกับสีหลัก หากไม่ได้ตั้งค่าสีหลักหรือสีรองไว้ ระบบจะใช้ค่าเริ่มต้นที่เฟรมเวิร์กระบุไว้
useNewMaterialDesign	bool เปิดใช้ดีไซน์ Material สำหรับการ์ด

LinkPreviewExtensionPoint

การกำหนดค่าสำหรับทริกเกอร์ที่เริ่มทำงานเมื่อผู้ใช้พิมพ์หรือวางลิงก์จากบริการของบุคคลที่สามหรือบริการที่ไม่ใช่ของ Google ลงในไฟล์ Google เอกสาร ชีต หรือสไลด์

ช่อง
labelText	string ต้องระบุ ข้อความสำหรับชิปอัจฉริยะตัวอย่างที่แจ้งให้ผู้ใช้ดูตัวอย่างลิงก์ เช่น Example: Support case ข้อความนี้เป็นแบบคงที่และแสดงก่อนที่ผู้ใช้จะเรียกใช้ส่วนเสริม
localizedLabelText	map<string, string> ไม่บังคับ แผนที่ของ labelText สำหรับแปลเป็นภาษาอื่นๆ จัดรูปแบบภาษาใน ISO 639 และประเทศ/ภูมิภาคใน ISO 3166 โดยคั่นด้วยขีดกลางสั้น - เช่น en-US หากมีภาษาของผู้ใช้อยู่ในคีย์ของแผนที่ ผู้ใช้จะเห็น labelText เวอร์ชันแปล
patterns[]	UriPattern ต้องระบุ อาร์เรย์ของรูปแบบ URL ที่ทริกเกอร์ส่วนเสริมให้แสดงตัวอย่างลิงก์
runFunction	string ต้องระบุ ปลายทางที่จะดำเนินการเมื่อมีการทริกเกอร์ตัวอย่างลิงก์
logoUrl	string ไม่บังคับ ไอคอนที่แสดงในชิปอัจฉริยะและการ์ดตัวอย่าง หากไม่ระบุ ส่วนเสริมจะใช้ไอคอนแถบเครื่องมือ logoUrl

MenuItemExtensionPoint

รูปแบบทั่วไปสำหรับการประกาศรายการในเมนูหรือปุ่มที่ปรากฏในแอปโฮสต์

ช่อง
runFunction	string ต้องระบุ ปลายทางที่จะดำเนินการเมื่อมีการเปิดใช้งานจุดส่วนขยายนี้
label	string ต้องระบุ ข้อความที่ผู้ใช้เห็นซึ่งอธิบายถึงการดำเนินการที่ทำโดยการเปิดใช้งานจุดส่วนขยายนี้ เช่น "แทรกใบแจ้งหนี้"
logoUrl	string URL ของรูปภาพโลโก้ที่แสดงในแถบเครื่องมือของส่วนเสริม หากไม่ได้ตั้งค่า ระบบจะใช้ URL โลโก้หลักของส่วนเสริมเป็นค่าเริ่มต้น

UniversalActionExtensionPoint

รูปแบบสำหรับการประกาศจุดส่วนขยายรายการในเมนูการทำงานส่วนกลาง

ช่อง
label	string ต้องระบุ ข้อความที่ผู้ใช้เห็นซึ่งอธิบายถึงการดำเนินการที่ทำโดยการเปิดใช้งานจุดส่วนขยายนี้ เช่น "เพิ่มรายชื่อติดต่อใหม่"
ฟิลด์สหภาพ action_type ต้องระบุ ประเภทการดำเนินการที่รองรับในรายการเมนูการทำงานทั่วไป ซึ่งอาจเป็นลิงก์เพื่อเปิดหรือปลายทางที่จะเรียกใช้ก็ได้ action_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
openLink	string URL ที่จะเปิดโดย UniversalAction
runFunction	string ปลายทางที่จะเรียกใช้โดย UniversalAction

UriPattern

การกำหนดค่าสำหรับรูปแบบ URL แต่ละรายการที่ทริกเกอร์การแสดงตัวอย่างลิงก์

ช่อง
hostPattern	string ต้องระบุสำหรับรูปแบบ URL แต่ละรายการเพื่อแสดงตัวอย่าง โดเมนของรูปแบบ URL ลิงก์แสดงตัวอย่างส่วนเสริมที่มีโดเมนนี้ใน URL หากต้องการดูตัวอย่างลิงก์สำหรับโดเมนย่อยที่เจาะจง เช่น subdomain.example.com ให้รวมโดเมนย่อยนั้นด้วย หากต้องการดูตัวอย่างลิงก์ของทั้งโดเมน ให้ระบุอักขระไวลด์การ์ดที่มีเครื่องหมายดอกจัน (*) เป็นโดเมนย่อย ตัวอย่างเช่น *.example.com ตรงกับ subdomain.example.com และ another.subdomain.example.com
pathPrefix	string ไม่บังคับ เส้นทางที่ต่อท้ายโดเมนของ hostPattern เช่น หากรูปแบบโฮสต์ URL คือ support.example.com ให้ป้อน cases เพื่อจับคู่ URL สำหรับเคสที่โฮสต์ที่ support.example.com/cases/ หากต้องการจับคู่ URL ทั้งหมดในโดเมนรูปแบบโฮสต์ ให้เว้น pathPrefix ว่างไว้