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

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

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
(deprecated)

boolean

เปิดใช้ Material Design สำหรับการ์ด

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,

  "openLink": string,
  "runFunction": string
}
ช่อง
label

string

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

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
ช่อง
onTriggerFunction

string

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

object (UnconditionalTrigger)

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

UnconditionalTrigger

ประเภทนี้ไม่มีฟิลด์

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

UniversalAction

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

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

  "openLink": string,
  "runFunction": string
}
ช่อง
text

string

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

string

ปลายทางที่เรียกใช้เมื่อผู้ใช้เรียกให้ดำเนินการ ดูรายละเอียดได้ในคู่มือการดำเนินการสากล
สิ้นสุดฟิลด์ที่แยกกัน

ComposeTrigger

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

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

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

DraftAccess

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

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)

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

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

ไม่บังคับ ทริกเกอร์เมื่อมีการสร้างหรืออัปเดตกิจกรรมสำหรับปฏิทินที่ผู้ใช้สมัครรับข้อมูล ใช้ได้กับทริกเกอร์ที่สร้างโดย HTTP endpoints โดยใช้ CalendarSubscriptionActionMarkup เท่านั้น

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

ไม่เกี่ยวข้องกับ Apps Script add-ons และ Apps Script installable triggers
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

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

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

URL ของโลโก้เวอร์ชันโหมดมืด
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 ส่วนเสริมควรเปิดขึ้นในขั้นตอนการแสดงผล "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

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