Package google.apps.script.type

ดัชนี

• AddOnWidgetSet (ข้อความ)
• AddOnWidgetSet.WidgetType (enum)
• CommonAddOnManifest (ข้อความ)
• CreateActionExtensionPoint (ข้อความ)
• GranularOauthPermissionSupport (enum)
• 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

GranularOauthPermissionSupport

ส่วนเสริมได้เปิดใช้ความยินยอม OAuth แบบละเอียดหรือไม่

Enum
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED	ค่าเริ่มต้น ไม่ควรใช้
OPT_IN	ส่วนเสริมเลือกใช้ความยินยอม OAuth แบบละเอียด
OPT_OUT	ส่วนเสริมเลือกไม่ใช้ความยินยอม OAuth แบบละเอียด

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
granularOauthPermissionSupport	GranularOauthPermissionSupport ส่วนเสริมได้เปิดใช้ความยินยอม OAuth แบบละเอียดหรือไม่

LayoutProperties

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

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

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 ต้องระบุ ข้อความที่ผู้ใช้มองเห็นซึ่งอธิบายการดำเนินการที่ทำโดยการเปิดใช้งานจุดขยายนี้ เช่น "เพิ่มรายชื่อติดต่อใหม่"
ฟิลด์ Union 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 ว่างไว้