REST Resource: projects.deployments

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

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

string

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

object (AddOns)

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

string

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

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object (CommonAddOnManifest)

การกำหนดค่าที่ใช้ร่วมกันในส่วนเสริมทั้งหมดของ Google Workspace

object (GmailAddOnManifest)

การกำหนดค่าส่วนเสริม Gmail

object (DriveAddOnManifest)

การกำหนดค่าส่วนเสริมไดรฟ์

object (CalendarAddOnManifest)

การกำหนดค่าส่วนเสริมปฏิทิน

object (DocsAddOnManifest)

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

object (SheetsAddOnManifest)

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

object (SlidesAddOnManifest)

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

object (HttpOptions)

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

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

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

string

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

object (LayoutProperties)

คุณสมบัติเลย์เอาต์ทั่วไปสำหรับการ์ดส่วนเสริม

object (AddOnWidgetSet)

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

boolean

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

object (HomepageExtensionPoint)

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

object (UniversalActionExtensionPoint)

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

array (ListValue format)

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

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

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

string

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

boolean

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

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

รายการวิดเจ็ตที่ใช้ในส่วนเสริม

{
  "runFunction": string,
  "enabled": boolean
}

string

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

boolean

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

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

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

{
  "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.
}

string

ต้องระบุ ข้อความที่ผู้ใช้เห็นซึ่งอธิบายถึงการดำเนินการที่ทำโดยการเปิดใช้งานจุดส่วนขยายนี้ เช่น "เพิ่มรายชื่อติดต่อใหม่"

string

URL ที่จะเปิดโดย UniversalAction

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object (HomepageExtensionPoint)

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

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

object (ContextualTrigger)

กำหนดชุดเงื่อนไขที่ทริกเกอร์ส่วนเสริม

object (UniversalAction)

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

object (ComposeTrigger)

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

string

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

{
  "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.
}

string

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

object (UnconditionalTrigger)

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

{
  "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.
}

string

ต้องระบุ ข้อความที่ผู้ใช้มองเห็นได้ที่อธิบายการดำเนินการ ตัวอย่างเช่น "เพิ่มรายชื่อติดต่อใหม่"

string

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

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

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

string

ต้องระบุ ข้อความที่ผู้ใช้เห็นซึ่งอธิบายถึงการดำเนินการที่ทำโดยการเปิดใช้งานจุดส่วนขยายนี้ เช่น "แทรกใบแจ้งหนี้"

string

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

หากไม่ได้ตั้งค่า ระบบจะใช้ URL โลโก้หลักของส่วนเสริมเป็นค่าเริ่มต้น

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (DriveExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

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

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

enum (EventAccess)

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

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

ต้องระบุ อุปกรณ์ปลายทางสำหรับเรียกใช้เมื่อสร้างข้อมูลการประชุม

string

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

string

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

string

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

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

map (key: string, value: string)

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

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

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

object (UriPattern)

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

string

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

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

string

ต้องระบุสำหรับรูปแบบ URL แต่ละรายการเพื่อแสดงตัวอย่าง โดเมนของรูปแบบ URL ลิงก์แสดงตัวอย่างส่วนเสริมที่มีโดเมนนี้ใน URL หากต้องการดูตัวอย่างลิงก์สำหรับโดเมนย่อยที่เจาะจง เช่น subdomain.example.com ให้รวมโดเมนย่อยนั้นด้วย หากต้องการดูตัวอย่างลิงก์ของทั้งโดเมน ให้ระบุอักขระไวลด์การ์ดที่มีเครื่องหมายดอกจัน (*) เป็นโดเมนย่อย

ตัวอย่างเช่น *.example.com ตรงกับ subdomain.example.com และ another.subdomain.example.com

string

ไม่บังคับ เส้นทางที่ต่อท้ายโดเมนของ hostpattern

เช่น หากรูปแบบโฮสต์ URL คือ support.example.com ให้ป้อน cases เพื่อจับคู่ URL สำหรับเคสที่โฮสต์ที่ support.example.com/cases/

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

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

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

string

ต้องระบุ ข้อความที่แสดงควบคู่ไปกับไอคอนสำหรับจุดแรกเข้าของการสร้างทรัพยากร เช่น Create support case ข้อความนี้เป็นแบบคงที่และแสดงก่อนที่ผู้ใช้จะเรียกใช้ส่วนเสริม

map (key: string, value: string)

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

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

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

string

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

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

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