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 เปิดใช้การออกแบบเชิงวัสดุสำหรับการ์ด

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 ว่างไว้