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)
  },
  "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 ลิงก์โดยอัตโนมัติ

LayoutProperties

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

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

string

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

string

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

boolean

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

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 ที่กำหนดระดับการเข้าถึงข้อมูลที่ทริกเกอร์การเขียนต้องการ

Enum
UNSPECIFIED ค่าเริ่มต้นเมื่อไม่มีการตั้งค่าการเข้าถึงฉบับร่างไว้
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)

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

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

อุปกรณ์ปลายทางที่ทริกเกอร์เมื่ออัปเดตเหตุการณ์แบบเปิด
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

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)
}
ช่อง
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

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