หน้านี้ได้รับการแปลโดย Cloud Translation API

Package google.apps.script.type

ดัชนี

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

AddOnWidgetSet

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

ช่อง

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

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` หากไม่ได้ตั้งค่าไว้ หากปิดใช้มุมมองหน้าแรกที่กำหนดเองของส่วนเสริม ระบบจะแสดงการ์ดภาพรวมทั่วไปแก่ผู้ใช้แทน

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`

authorizationHeader

HttpAuthorizationHeader

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

LayoutProperties

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

ช่อง

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

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 ของโลโก้หลักของส่วนเสริมเป็นค่าเริ่มต้น

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` หากต้องการจับคู่ URL สำหรับเคสที่โฮสต์ที่ `support.example.com/cases/` ให้ป้อน `cases` หากต้องการจับคู่ URL ทั้งหมดในโดเมนรูปแบบโฮสต์ ให้ปล่อย `pathPrefix` ว่างไว้

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