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

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

object (AddOns)

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

string

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

AddOns

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

การแสดง JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "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)

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

object (MeetAddOnManifest)

การกําหนดค่าส่วนเสริม Meet
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 โดยอัตโนมัติ

LayoutProperties

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

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

string

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

string

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

boolean

เปิดใช้การออกแบบเชิงวัสดุสำหรับการ์ด

AddOnWidgetSet

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

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

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

HomepageExtensionPoint

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

การแสดง 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

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

string

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

GmailAddOnManifest

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

ContextualTrigger

กําหนดทริกเกอร์ที่จะทํางานเมื่ออีเมลที่เปิดอยู่ตรงกับเกณฑ์ที่เฉพาะเจาะจง เมื่อทริกเกอร์เริ่มทํางาน ก็จะเรียกใช้ปลายทางที่เฉพาะเจาะจง ซึ่งมักจะสร้างการ์ดใหม่และอัปเดต 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

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

object (UnconditionalTrigger)

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

UnconditionalTrigger

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

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

UniversalAction

การดำเนินการที่ใช้ได้เสมอในเมนูแถบเครื่องมือของส่วนเสริม ไม่ว่าบริบทของข้อความจะเป็นอย่างไรก็ตาม

การแสดง 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

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

string

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

ComposeTrigger

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

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

object (MenuItemExtensionPoint)

กำหนดชุดการดำเนินการสำหรับส่วนเสริมเวลาเขียน การดำเนินการเหล่านี้คือสิ่งที่ผู้ใช้สามารถทริกเกอร์ได้ในส่วนเสริมเวลาเขียน
draftAccess

enum (DraftAccess)

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

DraftAccess

อาร์เรย์แบบจำกัดที่กำหนดระดับการเข้าถึงข้อมูลที่จำเป็นสำหรับทริกเกอร์การเขียน

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

DriveAddOnManifest

คุณสมบัติที่กำหนดค่าลักษณะที่ปรากฏและการดำเนินการของส่วนเสริมของไดรฟ์

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

object (HomepageExtensionPoint)

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

object (DriveExtensionPoint)

สอดคล้องกับลักษณะการทำงานที่ดำเนินการเมื่อเลือกรายการในมุมมองไดรฟ์ที่เกี่ยวข้อง เช่น รายการเอกสารในไดรฟ์ของฉัน

DriveExtensionPoint

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

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

string

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

CalendarAddOnManifest

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

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

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

กำหนดโซลูชันการประชุมที่ส่วนเสริมนี้ให้ ส่วนเสริมสำหรับการประชุมของบุคคลที่สามจะสร้างได้ใน Apps Script เท่านั้น
createSettingsUrlFunction

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

ปลายทางที่ทริกเกอร์เมื่อมีกิจกรรมใหม่สำหรับการสมัครใช้บริการปฏิทินที่กําหนดค่าไว้ก่อนหน้านี้
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

กําหนดค่าที่เกี่ยวข้องกับการประชุม ส่วนเสริมสำหรับการประชุมของบุคคลที่สามจะสร้างได้ใน Apps Script เท่านั้น

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

string

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

string

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

string

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

string

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

CalendarExtensionPoint

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

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

string

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

EventAccess

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

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

DocsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

รายการจุดขยายสำหรับการสร้างทรัพยากรของบุคคลที่สามจากภายในแอปพลิเคชัน Google Workspace ดูข้อมูลเพิ่มเติมได้ที่สร้างแหล่งข้อมูลของบุคคลที่สามจากเมนู @

DocsExtensionPoint

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

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

string

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

LinkPreviewExtensionPoint

การกําหนดค่าทริกเกอร์ที่จะทํางานเมื่อผู้ใช้พิมพ์หรือวางลิงก์จากบริการของบุคคลที่สามหรือบริการที่ไม่ใช่ของ 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

UriPattern

การกําหนดค่าสําหรับรูปแบบ 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 ให้ป้อน cases เพื่อจับคู่ URL ของเคสที่โฮสต์ที่ support.example.com/cases/

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

CreateActionExtensionPoint

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

การแสดง JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
ช่อง
id

string

ต้องระบุ รหัสที่ไม่ซ้ำกันเพื่อแยกจุดขยายนี้ รหัสมีอักขระได้ไม่เกิน 64 ตัวและควรอยู่ในรูปแบบ [a-zA-Z0-9-]+
labelText

string

ต้องระบุ ข้อความที่แสดงข้างไอคอนสำหรับจุดแรกเข้าของการสร้างทรัพยากร เช่น Create 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" }
runFunction

string

ต้องระบุ ปลายทางที่จะดำเนินการเมื่อมีการทริกเกอร์เวิร์กโฟลว์การสร้างทรัพยากรเพื่อสร้างลิงก์
logoUrl

string

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

MeetAddOnManifest

ไฟล์ Manifest ของส่วนเสริม Meet

การแสดง JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
ช่อง
homepageTrigger

object (HomepageExtensionPoint)

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

object (Web)

รายละเอียดของส่วนเสริมที่ช่วยเพิ่มประสิทธิภาพไคลเอ็นต์เว็บของ Meet
supportsCollaboration

boolean

ส่วนเสริมรองรับการทำงานร่วมกันหรือการเชิญผู้อื่นให้เข้าร่วมประสบการณ์การใช้งานส่วนเสริมหรือไม่
termsUri

string

ลิงก์ไปยังข้อกำหนดในการให้บริการของส่วนเสริม (หากมี)

เว็บ

รายละเอียดของส่วนเสริมที่ช่วยเพิ่มประสิทธิภาพไคลเอ็นต์เว็บของ Meet

การแสดง JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
ช่อง
sidePanelUri
(deprecated)

string

URI สำหรับ iframe ของแผงด้านข้าง
sidePanelUrl

string

URL สำหรับ iframe ของแผงด้านข้าง
mainStageUri
(deprecated)

string

URI สําหรับ iframe "เวทีหลัก"
supportsScreenSharing

boolean

ระบุว่าส่วนเสริมรองรับการแชร์หน้าจอในเวทีหลักหรือไม่
supportsCollaboration
(deprecated)

boolean

ส่วนเสริมรองรับการทำงานร่วมกันหรือการเชิญผู้อื่นให้เข้าร่วมประสบการณ์การใช้งานส่วนเสริมหรือไม่ เราเลิกใช้งานช่องนี้แล้ว โปรดใช้ช่องระดับบนสุดใน MeetAddOnManifest
supportsPopOut

boolean

ส่วนเสริมรองรับการแสดงแบบป๊อปอัปไปยังประสบการณ์ PiP ของเบราว์เซอร์หรือไม่
hostOrigins[]
(deprecated)

string

ชื่อเดิมที่เลิกใช้งานแล้ว ต้นทางที่ควรเพิ่มลงในพร็อพเพอร์ตี้ frame-src ของ iframe ที่มีเว็บไซต์ของบุคคลที่สาม ใช้ addonorigins แทน
addOnOrigins[]

string

ต้นทางที่ควรเพิ่มลงในพร็อพเพอร์ตี้ frame-src ของ iframe ที่มีเว็บไซต์ของบุคคลที่สาม
openState

enum (State)

สถานะเริ่มต้นเมื่อเปิดส่วนเสริม
supportsCollaborationHostControls

boolean

ระบุว่าส่วนเสริมการทำงานร่วมกันรองรับการควบคุมของผู้จัดหรือไม่
logoUrl

string

URL ของโลโก้ที่จะแสดงสำหรับส่วนเสริม หากไม่ได้ระบุไว้ ระบบจะใช้โลโก้ในส่วนทั่วไปของไฟล์ Manifest เป็นค่าเริ่มต้น
darkModeLogoUrl

string

เวอร์ชันโหมดมืดของ logourl
displayFlow
(deprecated)

enum (DisplayFlow)

ขั้นตอนการแสดงผลที่ส่วนเสริมจะทําเมื่อเปิดใช้งาน

รัฐ

Enum สำหรับระบุสถานะการเปิดส่วนเสริมเริ่มต้น

Enum
STATE_UNSPECIFIED ไม่ได้ระบุสถานะเริ่มต้นกับส่วนเสริม
SIDE_PANEL_ONLY ส่วนเสริมจะเปิดขึ้นโดยมีเพียงแผงด้านข้างที่ใช้งานอยู่
MAIN_STAGE_ONLY ส่วนเสริมจะเปิดขึ้นโดยมีเฉพาะเวทีหลักที่ใช้งานอยู่
SIDE_PANEL_AND_MAIN_STAGE ส่วนเสริมจะเปิดขึ้นโดยทั้งแผงด้านข้างและเวทีหลักทำงานอยู่

DisplayFlow

Enum สำหรับระบุขั้นตอนการแสดงผลที่ส่วนเสริมจะดำเนินการเมื่อเปิดใช้งาน

Enum
DISPLAY_FLOW_UNSPECIFIED ไม่ได้ระบุขั้นตอนการแสดง
FOCUS ส่วนเสริมควรเปิดขึ้นในขั้นตอนการแสดง "โฟกัส"
AUGMENT ส่วนเสริมควรเปิดขึ้นในขั้นตอนการแสดง "เพิ่ม"

SheetsAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

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

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

string

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

SlidesAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

SlidesExtensionPoint

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

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

string

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

HttpOptions

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

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

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

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

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

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

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

เมธอด

create

 สร้างการติดตั้งใช้งานที่มีชื่อและการกำหนดค่าที่ระบุ

delete

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

get

 รับการติดตั้งที่มีชื่อที่ระบุ

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

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