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
(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,

  // 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 จะเรียกใช้

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

ต้องระบุ ชื่อของปลายทางที่จะเรียกใช้เมื่อข้อความตรงกับทริกเกอร์
ฟิลด์ Union 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

ต้องระบุ ข้อความที่ผู้ใช้มองเห็นซึ่งอธิบายการดำเนินการ เช่น "เพิ่มรายชื่อติดต่อใหม่"
ฟิลด์ Union 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)
  },
  "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)

ปลายทางที่จะทริกเกอร์เมื่อมีการอัปเดตเหตุการณ์เปิด
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
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 ส่วนเสริมควรเปิดตัวในขั้นตอนการแสดงผล "เพิ่ม"

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

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