Package google.apps.script.type

ดัชนี

AddOnWidgetSet

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

ช่อง
usedWidgets[]

WidgetType

รายการวิดเจ็ตที่ใช้ในส่วนเสริม

WidgetType

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

Enum
WIDGET_TYPE_UNSPECIFIED ชุดวิดเจ็ตเริ่มต้น
DATE_PICKER เครื่องมือเลือกวันที่
STYLED_BUTTONS ปุ่มที่มีการจัดรูปแบบประกอบด้วยปุ่มแบบเติมสีและปุ่มที่ปิดใช้งาน
PERSISTENT_FORMS ฟอร์มแบบถาวรช่วยให้สามารถคงค่าของฟอร์มในระหว่างการดำเนินการ
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

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

ช่อง
runFunction

string

ต้องระบุ ปลายทางที่จะดำเนินการเมื่อเปิดใช้งานจุดขยายนี้

label

string

ต้องระบุ ข้อความที่ผู้ใช้เห็นซึ่งอธิบายถึงการดำเนินการโดยการเปิดใช้งานจุดส่วนขยายนี้ เช่น "แทรกใบแจ้งหนี้"

logoUrl

string

URL ของรูปภาพโลโก้ที่แสดงในแถบเครื่องมือของส่วนเสริม

หากไม่ได้ตั้งค่า ระบบจะใช้ URL โลโก้หลักของส่วนเสริมเป็นค่าเริ่มต้น

UniversalActionExtensionPoint

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

ช่อง
label

string

ต้องระบุ ข้อความที่ผู้ใช้เห็นซึ่งอธิบายถึงการดำเนินการด้วยการเปิดใช้งานจุดส่วนขยายนี้ เช่น "เพิ่มรายชื่อติดต่อใหม่"

ฟิลด์การรวม action_type ต้องระบุ ประเภทการดำเนินการที่รองรับในรายการเมนูการทำงานทั่วไป โดยอาจเป็นลิงก์เพื่อเปิดหรือปลายทางที่จะเรียกใช้ก็ได้ action_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
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 ในการจับคู่ URL สำหรับกรณีที่โฮสต์ที่ support.example.com/cases/ ให้ป้อน cases

หากต้องการจับคู่ URL ทั้งหมดในโดเมนรูปแบบโฮสต์ ให้เว้น pathPrefix ว่างไว้