REST Resource: projects.deployments

ทรัพยากร: การทําให้ใช้งานได้

การทําให้ส่วนเสริมของ Google Workspace ใช้งานได้

การแสดง JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
ช่อง
name

string

ชื่อทรัพยากรการทําให้ใช้งานได้ ตัวอย่าง: projects/123/deployments/my_deployment
oauthScopes[]

string

รายการขอบเขตของ Google OAuth ที่จะขอคํายินยอมจากผู้ใช้ปลายทางก่อนดําเนินการจุดสิ้นสุดของส่วนเสริม
addOns

object (AddOns)

การกําหนดค่าส่วนเสริมของ Google Workspace
etag

string

ค่านี้จะคํานวณโดยเซิร์ฟเวอร์ตามเวอร์ชันการทําให้ใช้งานได้ในพื้นที่เก็บข้อมูล และอาจมีการส่งคําขอและลบคําขอเพื่อให้มั่นใจว่าไคลเอ็นต์มีค่าล่าสุดก่อนดําเนินการต่อ

ส่วนเสริม

การกําหนดค่าส่วนเสริมของ Google Workspace

การแสดง JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
ช่อง
common

object (CommonAddOnManifest)

การกําหนดค่าที่เหมือนกันในทุกส่วนเสริมของ Google Workspace
gmail

object (GmailAddOnManifest)

การกําหนดค่าส่วนเสริมของ Gmail
drive

object (DriveAddOnManifest)

การกําหนดค่าส่วนเสริมของไดรฟ์
calendar

object (CalendarAddOnManifest)

การกําหนดค่าส่วนเสริมของปฏิทิน
docs

object (DocsAddOnManifest)

การกําหนดค่าส่วนเสริมของเอกสาร
sheets

object (SheetsAddOnManifest)

การกําหนดค่าส่วนเสริมของชีต
slides

object (SlidesAddOnManifest)

การกําหนดค่าส่วนเสริมสไลด์
httpOptions

object (HttpOptions)

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

CommonAddOnManifest

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

การแสดง JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
ช่อง
name

string

ต้องระบุ ชื่อที่แสดงของส่วนเสริม
logoUrl

string

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

object (LayoutProperties)

พร็อพเพอร์ตี้เลย์เอาต์ทั่วไปสําหรับการ์ดส่วนเสริม
addOnWidgetSet

object (AddOnWidgetSet)

วิดเจ็ตที่ใช้ในส่วนเสริม หากไม่ได้ระบุช่องนี้ ระบบจะใช้ชุดเริ่มต้น
useLocaleFromApp

boolean

เลือกว่าจะส่งข้อมูลภาษาจากแอปโฮสต์หรือไม่
homepageTrigger

object (HomepageExtensionPoint)

กําหนดปลายทางที่จะดําเนินการตามบริบทในทุกโฮสต์ ผู้ใช้จะใช้งานการ์ดใดๆ ที่สร้างโดยฟังก์ชันนี้ได้เสมอแต่อาจถูกเนื้อหาบริบทบดบังเมื่อส่วนเสริมนี้ประกาศทริกเกอร์ที่กําหนดเป้าหมายมากขึ้น
universalActions[]

object (UniversalActionExtensionPoint)

กําหนดรายการจุดเข้าถึงส่วนขยายในเมนูการทํางานทั่วไปซึ่งจะเป็นเมนูการตั้งค่าสําหรับส่วนเสริมนั้นๆ จุดเชื่อมโยงอาจเป็น URL ลิงก์ที่เปิดหรือปลายทางที่จะเรียกใช้เป็นการส่งแบบฟอร์ม
openLinkUrlPrefixes

array (ListValue format)

การดําเนินการ OpenLink จะใช้ได้เฉพาะ URL ที่มีรูปแบบ HTTPS, MAILTO หรือ TEL เท่านั้น สําหรับลิงก์ HTTPS นั้น URL ต้องตรงกันกับคํานําหน้าที่ระบุไว้ในรายการที่อนุญาตด้วย หากคํานําหน้าไม่นําหน้ารูปแบบนี้ ระบบจะถือว่า HTTPS ลิงก์ HTTP ถูกเขียนใหม่เป็น HTTPS ลิงก์โดยอัตโนมัติ

คุณสมบัติการจัดวาง

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

การแสดง JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
ช่อง
primaryColor

string

สีหลักของส่วนเสริม โดยจะตั้งค่าสีของแถบเครื่องมือ หากไม่ได้กําหนดสีหลักไว้ ระบบจะใช้ค่าเริ่มต้นจากเฟรมเวิร์ก
secondaryColor

string

สีรองของส่วนเสริม ตั้งค่าสีของปุ่ม หากกําหนดสีหลักไว้แต่ไม่ได้กําหนดสีรองไว้ สีรองจะเหมือนกับสีหลัก หากไม่ได้กําหนดทั้งสีหลักและสีรอง ระบบจะใช้ค่าเริ่มต้นที่ระบุไว้ในเฟรมเวิร์ก
useNewMaterialDesign

boolean

เปิดใช้งานดีไซน์ Material สําหรับการ์ด

เพิ่มชุดวิดเจ็ต

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

การแสดง JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
ช่อง
usedWidgets[]

enum (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 การเขียนส่วนเสริม

HomePoint ส่วนขยาย

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

การแสดง JSON 
{
  "runFunction": string,
  "enabled": boolean
}
ช่อง
runFunction

string

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

boolean

ไม่บังคับ หากตั้งค่าเป็น false จะปิดใช้มุมมองหน้าแรกในบริบทนี้

ค่าเริ่มต้นจะเป็น true หากไม่ได้ตั้งค่าไว้

หากปิดใช้มุมมองหน้าแรกที่กําหนดเองของส่วนเสริม ระบบจะจัดเตรียมการ์ดภาพรวมทั่วไปให้ผู้ใช้แทน

UniversalActionExtensionPoint

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

การแสดง JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
ช่อง
label

string

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

string

ปลายทางจะเรียกใช้โดย UniversalAction

ไฟล์ Manifest ของ Gmail

คุณสมบัติการปรับแต่งลักษณะและการทํางานของส่วนเสริม Gmail

การแสดง JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
ช่อง
homepageTrigger

object (HomepageExtensionPoint)

กําหนดปลายทางที่จะดําเนินการในบริบทที่ไม่ตรงกับทริกเกอร์ตามบริบทที่ประกาศ ผู้ใช้จะใช้งานการ์ดใดๆ ที่สร้างโดยฟังก์ชันนี้ได้ตลอดเวลาแต่อาจถูกเนื้อหาบริบทบดบังเมื่อส่วนเสริมนี้ประกาศทริกเกอร์ที่กําหนดเป้าหมายมากขึ้น

หากมี ค่านี้จะลบล้างการกําหนดค่าจาก addons.common.homepageTrigger
contextualTriggers[]

object (ContextualTrigger)

กําหนดชุดเงื่อนไขที่ทริกเกอร์ส่วนเสริม
universalActions[]

object (UniversalAction)

กําหนดชุดการดําเนินการแบบสากล สําหรับส่วนเสริม ผู้ใช้เรียกใช้การทํางานแบบสากลจากเมนูแถบเครื่องมือส่วนเสริม
composeTrigger

object (ComposeTrigger)

กําหนดทริกเกอร์เวลาเขียนสําหรับส่วนเสริมเวลาเขียน นี่เป็นทริกเกอร์ที่ทําให้ส่วนเสริมทํางานเมื่อผู้ใช้เขียนอีเมล ส่วนเสริมของเวลาเขียนทั้งหมดต้องมีขอบเขต gmail.addons.current.action.compose แม้ว่าอาจแก้ไขฉบับร่างไม่ได้
authorizationCheckFunction

string

ชื่อของปลายทางที่ยืนยันว่าส่วนเสริมมีการให้สิทธิ์ของบุคคลที่สามที่จําเป็นทั้งหมด โดยการตรวจสอบ API ของบุคคลที่สาม ถ้าการตรวจสอบล้มเหลว ฟังก์ชันควรจะแสดงข้อยกเว้นเพื่อเริ่มต้นขั้นตอนการให้สิทธิ์ ระบบจะเรียกใช้ฟังก์ชันนี้ก่อนการเรียกใช้ส่วนเสริมแต่ละครั้ง เพื่อให้ผู้ใช้ได้รับประสบการณ์ที่ราบรื่น

ทริกเกอร์ตามบริบท

กําหนดทริกเกอร์ที่จะเริ่มทํางานเมื่ออีเมลที่เปิดอยู่ผ่านเกณฑ์ที่ระบุ เมื่อทริกเกอร์เริ่มทํางาน ทริกเกอร์จะเรียกใช้ปลายทางที่เฉพาะเจาะจง ซึ่งโดยปกติเพื่อสร้างการ์ดใหม่และอัปเดต UI

การแสดง JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
ช่อง
onTriggerFunction

string

ต้องระบุ ชื่อของปลายทางที่จะเรียกใช้เมื่อข้อความตรงกับทริกเกอร์
ช่อง Union trigger ประเภทของทริกเกอร์จะเป็นตัวกําหนดเงื่อนไขที่ Gmail ใช้เพื่อแสดงส่วนเสริม trigger ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
unconditional

object (UnconditionalTrigger)

ทริกเกอร์ที่ไม่มีเงื่อนไขจะทํางานเมื่อมีการเปิดข้อความอีเมล

ทริกเกอร์ที่ไม่มีเงื่อนไข

ประเภทนี้ไม่มีช่อง

ทริกเกอร์ที่เริ่มทํางานเมื่อมีการเปิดข้อความอีเมลใดๆ

การดําเนินการแบบสากล

การทํางานที่พร้อมใช้งานในเมนูแถบเครื่องมือส่วนเสริมเสมอโดยไม่คํานึงถึงบริบทของข้อความ

การแสดง JSON 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
ช่อง
text

string

ต้องระบุ ข้อความที่ผู้ใช้มองเห็นซึ่งอธิบายการดําเนินการ เช่น "เพิ่มรายชื่อติดต่อใหม่"
ช่อง Union action_type ประเภทของการดําเนินการจะเป็นตัวกําหนดพฤติกรรมของ Gmail เมื่อผู้ใช้เรียกใช้การทํางาน action_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
runFunction

string

ปลายทางที่เรียกใช้เมื่อผู้ใช้ทริกเกอร์การดําเนินการ โปรดดูรายละเอียดในคู่มือการดําเนินการแบบสากล

ทริกเกอร์การเขียน

ทริกเกอร์ที่เปิดใช้งานเมื่อผู้ใช้เขียนอีเมล

การแสดง JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
ช่อง
actions[]

object (MenuItemExtensionPoint)

กําหนดชุดการดําเนินการสําหรับส่วนเสริมของเวลาเขียน ซึ่งเป็นการดําเนินการที่ผู้ใช้เรียกให้แสดงได้ในส่วนเสริมเวลาเขียน
draftAccess

enum (DraftAccess)

กําหนดระดับการเข้าถึงข้อมูลเมื่อมีการเรียกส่วนเสริมเวลาเขียน

การเข้าถึงฉบับร่าง

Enum ที่กําหนดระดับการเข้าถึงของทริกเกอร์การเขียน

Enum
UNSPECIFIED ค่าเริ่มต้นเมื่อไม่มีการตั้งค่าสําหรับการร่างการเข้าถึง
NONE ทริกเกอร์การเขียนจะเข้าถึงข้อมูลใดๆ ของแบบร่างไม่ได้เมื่อมีการเรียกใช้ส่วนเสริมการเขียน
METADATA ให้สิทธิ์เขียนช่วยในการเข้าถึงข้อมูลเมตาของร่างจดหมายเมื่อมีการเรียกใช้ส่วนเสริมการเขียน ซึ่งรวมถึงรายการกลุ่มเป้าหมาย เช่น รายการในช่อง "ถึง" และ "สําเนา" ของข้อความร่าง

ส่วนเสริมไดรฟ์

พร็อพเพอร์ตี้ที่ปรับแต่งรูปลักษณ์และการดําเนินการของส่วนเสริมไดรฟ์

การแสดง JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
ช่อง
homepageTrigger

object (HomepageExtensionPoint)

หากมี ค่านี้จะลบล้างการกําหนดค่าจาก addons.common.homepageTrigger
onItemsSelectedTrigger

object (DriveExtensionPoint)

เป็นไปตามลักษณะการทํางานที่เมื่อเลือกรายการในมุมมองไดรฟ์ที่เกี่ยวข้อง เช่น ไดรฟ์ของฉัน

จุดขยายส่วนขยาย

รูปแบบทั่วไปสําหรับการประกาศทริกเกอร์ของส่วนเสริมไดรฟ์

การแสดง JSON 
{
  "runFunction": string
}
ช่อง
runFunction

string

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

ส่วนเสริมของปฏิทิน

พร็อพเพอร์ตี้ที่ปรับแต่งรูปลักษณ์และการดําเนินการของส่วนเสริมปฏิทิน

การแสดง JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
ช่อง
homepageTrigger

object (HomepageExtensionPoint)

กําหนดปลายทางที่ดําเนินการกับบริบทที่ไม่ตรงกับทริกเกอร์ตามบริบทที่ประกาศ ผู้ใช้จะใช้งานการ์ดใดๆ ที่สร้างโดยฟังก์ชันนี้ได้เสมอแต่อาจถูกเนื้อหาบริบทบดบังเมื่อส่วนเสริมนี้ประกาศทริกเกอร์ที่กําหนดเป้าหมายมากขึ้น

หากมี ค่านี้จะลบล้างการกําหนดค่าจาก addons.common.homepageTrigger
conferenceSolution[]

object (ConferenceSolution)

กําหนดโซลูชันการประชุมจากส่วนเสริมนี้
createSettingsUrlFunction

string

ปลายทางที่จะดําเนินการจะสร้าง URL ไปยังหน้าของส่วนเสริม
eventOpenTrigger

object (CalendarExtensionPoint)

ปลายทางที่ทริกเกอร์เมื่อมีการเปิดกิจกรรมเพื่อดูหรือแก้ไข
eventUpdateTrigger

object (CalendarExtensionPoint)

ปลายทางที่ทริกเกอร์เมื่อมีการอัปเดตเหตุการณ์แบบเปิด
currentEventAccess

enum (EventAccess)

กําหนดระดับการเข้าถึงข้อมูลเมื่อมีการเรียกส่วนเสริมเหตุการณ์

โซลูชันการประชุม

ระบุค่าที่เกี่ยวข้องกับการประชุม

การแสดง JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
ช่อง
onCreateFunction

string

ต้องระบุ ปลายทางที่จะเรียกใช้เมื่อควรสร้างข้อมูลการประชุม
id

string

ต้องระบุ คุณควรกําหนดรหัสที่ไม่ซ้ํากันสําหรับโซลูชันการประชุมต่างๆ ภายในส่วนเสริม 1 รายการ ไม่เช่นนั้นระบบอาจใช้โซลูชันการประชุมที่ไม่ถูกต้องเมื่อมีการทริกเกอร์ส่วนเสริม แม้ว่าคุณจะเปลี่ยนชื่อที่แสดงของส่วนเสริมได้ แต่ไม่ควรเปลี่ยนรหัส
name

string

ต้องระบุ ชื่อที่แสดงของโซลูชันการประชุม
logoUrl

string

ต้องระบุ URL สําหรับรูปภาพโลโก้ของโซลูชันการประชุม

ส่วนขยายปฏิทิน

รูปแบบทั่วไปสําหรับการประกาศทริกเกอร์ของส่วนเสริมปฏิทิน

การแสดง JSON 
{
  "runFunction": string
}
ช่อง
runFunction

string

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

การเข้าถึงกิจกรรม

Enum ที่กําหนดระดับทริกเกอร์ของเหตุการณ์การเข้าถึงข้อมูลจะต้องการ

Enum
UNSPECIFIED ค่าเริ่มต้นเมื่อไม่มีการตั้งค่าใดๆ สําหรับ eventAccess
METADATA การให้สิทธิ์กิจกรรมจะทริกเกอร์การเข้าถึงข้อมูลเมตาของกิจกรรม เช่น รหัสกิจกรรมและรหัสปฏิทิน
READ ให้ทริกเกอร์เหตุการณ์เข้าถึงช่องข้อมูลกิจกรรมทั้งหมดที่มี รวมถึงข้อมูลเมตา ผู้เข้าร่วม และข้อมูลการประชุม
WRITE ให้ทริกเกอร์เหตุการณ์เข้าถึงข้อมูลเมตาของกิจกรรมและความสามารถในการดําเนินการทั้งหมด ซึ่งรวมถึงการเพิ่มผู้เข้าร่วมและข้อมูลการประชุม
READ_WRITE ให้สิทธิ์ทริกเกอร์เหตุการณ์เข้าถึงช่องข้อมูลกิจกรรมทั้งหมดที่มี รวมถึงข้อมูลเมตา ผู้เข้าร่วม และข้อมูลการประชุม ตลอดจนสามารถดําเนินการทั้งหมดได้

DocsAddOnManifest

คุณสมบัติที่ปรับแต่งลักษณะและการทํางานของส่วนเสริม Google เอกสาร

การแสดง JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
ช่อง
homepageTrigger

object (HomepageExtensionPoint)

หากมี ค่านี้จะลบล้างการกําหนดค่าจาก addons.common.homepageTrigger
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

ปลายทางจะดําเนินการเมื่อให้สิทธิ์ขอบเขตไฟล์สําหรับคู่เอกสาร/ผู้ใช้นี้
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

รายการจุดเชื่อมต่อสําหรับการแสดงตัวอย่างลิงก์ในเอกสารของ Google เอกสาร โปรดดูรายละเอียดที่หัวข้อแสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ

จุดเชื่อมเอกสาร

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

การแสดง JSON 
{
  "runFunction": string
}
ช่อง
runFunction

string

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

ลิงก์จุดดูตัวอย่างส่วนขยาย

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

การแสดง JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
ช่อง
labelText

string

ต้องระบุ ข้อความของตัวอย่างชิปอัจฉริยะที่แจ้งให้ผู้ใช้ดูตัวอย่างลิงก์ เช่น Example: Support case ข้อความนี้เป็นภาพนิ่งและแสดงก่อนที่ผู้ใช้จะเรียกใช้ส่วนเสริม
localizedLabelText

map (key: string, value: string)

ไม่บังคับ แผนที่ของ labeltext เพื่อแปลเป็นภาษาอื่นๆ ให้จัดรูปแบบภาษาใน ISO 639 และประเทศ/ภูมิภาคใน ISO 3166 แล้วคั่นด้วยเครื่องหมายขีดกลาง - เช่น en-US

หากมีภาษาของผู้ใช้อยู่ในคีย์ของแผนที่ ผู้ใช้จะเห็น labeltext เวอร์ชันท้องถิ่น

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่าง: { "name": "wrench", "mass": "1.3kg", "count": "3" }
patterns[]

object (UriPattern)

ต้องระบุ อาร์เรย์ของรูปแบบ URL ที่ทริกเกอร์ส่วนเสริมเพื่อดูตัวอย่างลิงก์
runFunction

string

ต้องระบุ ปลายทางที่จะเรียกใช้เมื่อมีการเรียกใช้การแสดงตัวอย่างลิงก์
logoUrl

string

ไม่บังคับ ไอคอนที่แสดงในชิปอัจฉริยะ หากไม่ระบุ ชิปจะใช้ไอคอนแถบเครื่องมือของส่วนเสริม logourl

รูปแบบ URI

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

การแสดง JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
ช่อง
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 ว่างไว้

ชีตส่วนเสริมไฟล์ Manifest

คุณสมบัติในการกําหนดค่ารูปลักษณ์และการทํางานของส่วนเสริม Google ชีต

การแสดง JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  }
}
ช่อง
homepageTrigger

object (HomepageExtensionPoint)

หากมี ค่านี้จะลบล้างการกําหนดค่าจาก addons.common.homepageTrigger
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

ปลายทางจะดําเนินการเมื่อให้สิทธิ์ขอบเขตไฟล์สําหรับคู่เอกสาร/ผู้ใช้นี้

ชีตส่วนขยาย Point

รูปแบบทั่วไปสําหรับการประกาศทริกเกอร์ของส่วนเสริมชีต

การแสดง JSON 
{
  "runFunction": string
}
ช่อง
runFunction

string

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

สไลด์ส่วนเสริมรายการ

พร็อพเพอร์ตี้ที่ปรับแต่งรูปลักษณ์และการดําเนินการของส่วนเสริม Google สไลด์

การแสดง JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  }
}
ช่อง
homepageTrigger

object (HomepageExtensionPoint)

หากมี ค่านี้จะลบล้างการกําหนดค่าจาก addons.common.homepageTrigger
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

ปลายทางจะดําเนินการเมื่อให้สิทธิ์ขอบเขตไฟล์สําหรับคู่เอกสาร/ผู้ใช้นี้

จุดแสดงส่วนขยาย

รูปแบบทั่วไปสําหรับการประกาศทริกเกอร์ของส่วนเสริมสไลด์

การแสดง JSON 
{
  "runFunction": string
}
ช่อง
runFunction

string

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

HttpOptions

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

การแสดง JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
ช่อง
authorizationHeader

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

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

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

วิธีการ

create

 สร้างการทําให้ใช้งานได้ด้วยชื่อและการกําหนดค่าที่ระบุ

delete

 ลบการทําให้ใช้งานได้โดยใช้ชื่อที่ระบุ

get

 รับการทําให้ใช้งานได้โดยใช้ชื่อที่ระบุ

getInstallStatus

 รับสถานะการติดตั้งของการทําให้ใช้งานได้ทดสอบ

install

 ติดตั้งการทําให้ใช้งานได้ให้กับบัญชีเพื่อทดสอบ

list

 แสดงรายการการทําให้ใช้งานได้ทั้งหมดในโปรเจ็กต์หนึ่งๆ

replaceDeployment

 สร้างหรือแทนที่การทําให้ใช้งานได้ด้วยชื่อที่ระบุ

uninstall

 ถอนการติดตั้งการทดสอบการทําให้ใช้งานได้จากบัญชีของผู้ใช้