REST Resource: projects.deployments

Tài nguyên: Triển khai

Bản triển khai tiện ích bổ sung Google Workspace

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Trường
name

string

Tên tài nguyên triển khai. Ví dụ: projects/123/deployments/my_deployment
oauthScopes[]

string

Danh sách các phạm vi OAuth của Google mà bạn cần yêu cầu người dùng cuối đồng ý trước khi thực thi một điểm cuối của tiện ích bổ sung.
addOns

object (AddOns)

Cấu hình tiện ích bổ sung của Google Workspace.
etag

string

Giá trị này do máy chủ tính toán dựa trên phiên bản của bản triển khai trong bộ nhớ và có thể được gửi theo yêu cầu cập nhật và xoá để đảm bảo ứng dụng có giá trị mới nhất trước khi tiếp tục.

AddOns

Cấu hình tiện ích bổ sung của Google Workspace.

Biểu diễn dưới dạng 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)
  }
}
Trường
common

object (CommonAddOnManifest)

Cấu hình chung cho tất cả các tiện ích bổ sung của Google Workspace.
gmail

object (GmailAddOnManifest)

Cấu hình tiện ích bổ sung dành cho Gmail.
drive

object (DriveAddOnManifest)

Cấu hình tiện ích bổ sung cho Drive.
calendar

object (CalendarAddOnManifest)

Cấu hình tiện ích bổ sung cho Lịch.
docs

object (DocsAddOnManifest)

Cấu hình tiện ích bổ sung của Tài liệu.
meet

object (MeetAddOnManifest)

Cấu hình tiện ích bổ sung của Meet.
sheets

object (SheetsAddOnManifest)

Cấu hình tiện ích bổ sung của Trang tính.
slides

object (SlidesAddOnManifest)

Cấu hình tiện ích bổ sung của Trang trình bày.
httpOptions

object (HttpOptions)

Các lựa chọn để gửi yêu cầu đến điểm cuối HTTP của tiện ích bổ sung

CommonAddOnManifest

Cấu hình tiện ích bổ sung được chia sẻ trên tất cả các ứng dụng lưu trữ tiện ích bổ sung.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
Trường
name

string

Bắt buộc. Tên hiển thị của tiện ích bổ sung.
logoUrl

string

Bắt buộc. URL của hình ảnh biểu trưng xuất hiện trên thanh công cụ của tiện ích bổ sung.
layoutProperties

object (LayoutProperties)

Các thuộc tính bố cục phổ biến cho thẻ tiện ích bổ sung.
addOnWidgetSet

object (AddOnWidgetSet)

Các tiện ích được dùng trong tiện ích bổ sung. Nếu bạn không chỉ định trường này, thì hệ thống sẽ sử dụng nhóm mặc định.
useLocaleFromApp

boolean

Có chuyển thông tin ngôn ngữ từ ứng dụng lưu trữ hay không.
homepageTrigger

object (HomepageExtensionPoint)

Xác định một điểm cuối sẽ được thực thi trong mọi bối cảnh, trên mọi máy chủ. Người dùng luôn có thể sử dụng mọi thẻ do hàm này tạo, nhưng có thể bị nội dung theo bối cảnh che khuất khi tiện ích bổ sung này khai báo nhiều điều kiện kích hoạt được nhắm mục tiêu hơn.
universalActions[]

object (UniversalActionExtensionPoint)

Xác định danh sách các điểm mở rộng trong trình đơn thao tác chung, đóng vai trò là trình đơn cài đặt cho tiện ích bổ sung. Điểm tiện ích có thể là một URL liên kết để mở hoặc một điểm cuối để thực thi dưới dạng một biểu mẫu gửi.
openLinkUrlPrefixes

array (ListValue format)

Hành động OpenLink chỉ có thể sử dụng URL có lược đồ HTTPS, MAILTO hoặc TEL. Đối với đường liên kết HTTPS, URL cũng phải khớp với một trong các tiền tố được chỉ định trong danh sách cho phép. Nếu tiền tố bỏ qua lược đồ, thì HTTPS sẽ được giả định. Đường liên kết HTTP sẽ tự động được viết lại thành đường liên kết HTTPS.

LayoutProperties

Các thuộc tính bố cục thẻ được dùng chung cho tất cả ứng dụng lưu trữ tiện ích bổ sung.

Biểu diễn dưới dạng JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Trường
primaryColor

string

Màu chính của tiện ích bổ sung. Thuộc tính này đặt màu của thanh công cụ. Nếu không có màu chính nào được đặt, thì giá trị mặc định do khung cung cấp sẽ được sử dụng.
secondaryColor

string

Màu phụ của tiện ích bổ sung. Thuộc tính này đặt màu của các nút. Nếu bạn đặt màu chính nhưng không đặt màu phụ, thì màu phụ sẽ giống với màu chính. Nếu bạn không đặt màu chính hoặc màu phụ, thì giá trị mặc định do khung cung cấp sẽ được sử dụng.
useNewMaterialDesign
(deprecated)

boolean

Bật Material Design cho thẻ.

AddOnWidgetSet

Tập hợp con tiện ích mà một tiện ích bổ sung sử dụng.

Biểu diễn dưới dạng JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Trường
usedWidgets[]

enum (WidgetType)

Danh sách các tiện ích được dùng trong một tiện ích bổ sung.

WidgetType

Loại tiện ích. WIDGET_TYPE_UNSPECIFIED là bộ tiện ích cơ bản.

Enum
WIDGET_TYPE_UNSPECIFIED Bộ tiện ích mặc định.
DATE_PICKER Bộ chọn ngày.
STYLED_BUTTONS Các nút được tạo kiểu bao gồm nút được tô màu và nút bị vô hiệu hoá.
PERSISTENT_FORMS Biểu mẫu cố định cho phép duy trì các giá trị biểu mẫu trong quá trình thực hiện hành động.
UPDATE_SUBJECT_AND_RECIPIENTS Cập nhật tiêu đề và người nhận của thư nháp.
GRID_WIDGET Tiện ích lưới.
ADDON_COMPOSE_UI_ACTION Một hành động của tiện ích bổ sung dành cho Gmail áp dụng cho giao diện người dùng soạn thư của tiện ích bổ sung.

HomepageExtensionPoint

Định dạng phổ biến để khai báo chế độ xem trang chủ của tiện ích bổ sung.

Biểu diễn dưới dạng JSON 
{
  "runFunction": string,
  "enabled": boolean
}
Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm tiện ích này được kích hoạt.
enabled

boolean

Không bắt buộc. Nếu bạn đặt thành false, chế độ xem trang chủ sẽ bị vô hiệu hoá trong bối cảnh này.

Mặc định là true nếu không được đặt.

Nếu chế độ xem trang chủ tuỳ chỉnh của một tiện ích bổ sung bị tắt, thì người dùng sẽ thấy một thẻ tổng quan chung.

UniversalActionExtensionPoint

Định dạng để khai báo điểm mở rộng mục trong trình đơn thao tác chung.

Biểu diễn dưới dạng JSON 
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
Trường
label

string

Bắt buộc. Văn bản mà người dùng nhìn thấy, mô tả hành động được thực hiện bằng cách kích hoạt điểm mở rộng này, ví dụ: "Thêm người liên hệ mới".
Bắt buộc. Loại hành động được hỗ trợ trên một mục trong trình đơn thao tác chung. Đó có thể là một đường liên kết để mở hoặc một điểm cuối để thực thi. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
runFunction

string

Điểm cuối do UniversalAction chạy.
Kết thúc các trường loại trừ lẫn nhau.

GmailAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và cách thực thi của một tiện ích bổ sung dành cho Gmail.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

Xác định một điểm cuối sẽ được thực thi trong các bối cảnh không khớp với điều kiện kích hoạt theo bối cảnh đã khai báo. Người dùng luôn có thể xem mọi thẻ do hàm này tạo, nhưng nội dung theo bối cảnh có thể che khuất các thẻ này khi tiện ích bổ sung này khai báo nhiều điều kiện kích hoạt được nhắm mục tiêu hơn.

Nếu có, giá trị này sẽ ghi đè cấu hình từ addons.common.homepageTrigger.
contextualTriggers[]

object (ContextualTrigger)

Xác định tập hợp các điều kiện kích hoạt tiện ích bổ sung.
universalActions[]

object (UniversalAction)

Xác định một tập hợp hành động chung cho tiện ích bổ sung. Người dùng kích hoạt các thao tác chung từ trình đơn thanh công cụ của tiện ích bổ sung.
composeTrigger

object (ComposeTrigger)

Xác định điều kiện kích hoạt thời gian soạn thư cho một tiện ích bổ sung thời gian soạn thư. Đây là điều kiện kích hoạt khiến tiện ích bổ sung thực hiện hành động khi người dùng đang soạn email. Tất cả tiện ích bổ sung trong thời gian soạn thư đều phải có phạm vi gmail.addons.current.action.compose, ngay cả khi tiện ích đó không chỉnh sửa thư nháp.
authorizationCheckFunction

string

Tên của một điểm cuối xác minh rằng tiện ích bổ sung có tất cả các quyền uỷ quyền bắt buộc của bên thứ ba, bằng cách thăm dò API của bên thứ ba. Nếu quá trình thăm dò không thành công, hàm sẽ gửi một ngoại lệ để bắt đầu quy trình uỷ quyền. Hàm này được gọi trước mỗi lần gọi tiện ích bổ sung để đảm bảo trải nghiệm người dùng mượt mà.

ContextualTrigger

Xác định một điều kiện kích hoạt sẽ kích hoạt khi email đang mở đáp ứng một tiêu chí cụ thể. Khi trình kích hoạt kích hoạt, trình kích hoạt sẽ thực thi một điểm cuối cụ thể, thường là để tạo thẻ mới và cập nhật giao diện người dùng.

Biểu diễn dưới dạng JSON 
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Trường
onTriggerFunction

string

Bắt buộc. Tên của điểm cuối cần gọi khi một thông báo khớp với điều kiện kích hoạt.
Loại điều kiện kích hoạt xác định các điều kiện mà Gmail sử dụng để hiển thị tiện ích bổ sung. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
unconditional

object (UnconditionalTrigger)

Trình kích hoạt không điều kiện được thực thi khi bất kỳ thư nào được mở.
Kết thúc các trường loại trừ lẫn nhau.

UnconditionalTrigger

Loại này không có trường nào.

Một điều kiện kích hoạt được kích hoạt khi có bất kỳ nội dung email nào được mở.

UniversalAction

Một hành động luôn có trong trình đơn thanh công cụ của tiện ích bổ sung, bất kể ngữ cảnh của thư.

Biểu diễn dưới dạng JSON 
{
  "text": string,

  "openLink": string,
  "runFunction": string
}
Trường
text

string

Bắt buộc. Văn bản mà người dùng nhìn thấy mô tả hành động, ví dụ: "Thêm người liên hệ mới".
Loại hành động xác định hành vi của Gmail khi người dùng gọi hành động. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
runFunction

string

Một điểm cuối được gọi khi người dùng kích hoạt hành động. Xem hướng dẫn về hành động chung để biết thông tin chi tiết.
Kết thúc các trường loại trừ lẫn nhau.

ComposeTrigger

Một điều kiện kích hoạt sẽ kích hoạt khi người dùng đang soạn email.

Biểu diễn dưới dạng JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Trường
actions[]

object (MenuItemExtensionPoint)

Xác định nhóm hành động cho một tiện ích bổ sung trong lúc soạn thư. Đây là những hành động mà người dùng có thể kích hoạt trên một tiện ích bổ sung trong thời gian soạn thư.
draftAccess

enum (DraftAccess)

Xác định cấp truy cập dữ liệu khi một tiện ích bổ sung trong lúc soạn thư được kích hoạt.

DraftAccess

Một enum xác định cấp truy cập dữ liệu mà trình kích hoạt soạn thư yêu cầu.

Enum
UNSPECIFIED Giá trị mặc định khi không có giá trị nào được đặt cho draftaccess.
NONE Trình kích hoạt soạn thư không thể truy cập vào bất kỳ dữ liệu nào của thư nháp khi tiện ích bổ sung soạn thư được kích hoạt.
METADATA Cấp cho trình kích hoạt soạn thư quyền truy cập vào siêu dữ liệu của thư nháp khi một tiện ích bổ sung soạn thư được kích hoạt. Trong đó có danh sách đối tượng, chẳng hạn như danh sách người nhận trong trường Tới và Cc của thư nháp.

DriveAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và cách thực thi của một tiện ích bổ sung cho Drive.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

Nếu có, giá trị này sẽ ghi đè cấu hình từ addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

Tương ứng với hành vi thực thi khi các mục được chọn trong chế độ xem Drive có liên quan, chẳng hạn như Danh sách tài liệu trên Drive của tôi.

DriveExtensionPoint

Định dạng phổ biến để khai báo điều kiện kích hoạt của tiện ích bổ sung cho Drive.

Biểu diễn dưới dạng JSON 
{
  "runFunction": string
}
Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm tiện ích được kích hoạt.

CalendarAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và cách thực thi của tiện ích bổ sung Lịch.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

Không bắt buộc. Xác định một điểm cuối được thực thi trong các bối cảnh không khớp với điều kiện kích hoạt theo bối cảnh đã khai báo. Người dùng luôn có thể sử dụng mọi thẻ do hàm này tạo, nhưng có thể bị nội dung theo bối cảnh che khuất khi tiện ích bổ sung này khai báo nhiều điều kiện kích hoạt được nhắm mục tiêu hơn.

Nếu có, giá trị này sẽ ghi đè cấu hình từ addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

Không bắt buộc. Xác định các giải pháp hội nghị do tiện ích bổ sung này cung cấp.
createSettingsUrlFunction

string

Một điểm cuối cần thực thi để tạo URL đến trang cài đặt của tiện ích bổ sung.
eventOpenTrigger

object (CalendarExtensionPoint)

Một điểm cuối kích hoạt khi một sự kiện được mở để xem hoặc chỉnh sửa.
eventUpdateTrigger

object (CalendarExtensionPoint)

Một điểm cuối kích hoạt khi sự kiện mở được cập nhật.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Không bắt buộc. Kích hoạt khi một sự kiện được tạo hoặc cập nhật cho lịch mà người dùng đã đăng ký. Chỉ áp dụng cho các điều kiện kích hoạt do HTTP endpoints tạo bằng CalendarSubscriptionActionMarkup.

Để ngăn chặn các vòng lặp thông báo đệ quy, khi một tiện ích bổ sung sửa đổi sự kiện trên Lịch Google bằng API Lịch có thông tin xác thực từ cùng một dự án trên đám mây của Google lưu trữ bản triển khai tiện ích bổ sung, nền tảng sẽ chặn thông báo sửa đổi. Không hỗ trợ việc tự kích hoạt lệnh gọi API Lịch của dự án của riêng bạn.

Không áp dụng cho Apps Script add-ons và Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Cấu hình cho một điều kiện kích hoạt theo bối cảnh, kích hoạt khi người dùng nhấp vào nhà cung cấp tệp đính kèm của tiện ích bổ sung trong trình đơn thả xuống của Lịch.
currentEventAccess

enum (EventAccess)

Xác định cấp truy cập dữ liệu khi một tiện ích bổ sung sự kiện được kích hoạt.

ConferenceSolution

Xác định các giá trị liên quan đến hội nghị.

Biểu diễn dưới dạng JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Trường
onCreateFunction

string

Bắt buộc. Điểm cuối cần gọi khi cần tạo dữ liệu hội nghị.
id

string

Bắt buộc. Mã nhận dạng phải được chỉ định riêng biệt cho các giải pháp hội nghị truyền hình trong một tiện ích bổ sung, nếu không, giải pháp hội nghị truyền hình không chính xác có thể được sử dụng khi tiện ích bổ sung được kích hoạt. Mặc dù bạn có thể thay đổi tên hiển thị của một tiện ích bổ sung, nhưng bạn không nên thay đổi mã nhận dạng.
name

string

Bắt buộc. Tên hiển thị của giải pháp hội nghị truyền hình.
logoUrl

string

Bắt buộc. URL của hình ảnh biểu trưng cho giải pháp hội nghị truyền hình.

CalendarExtensionPoint

Định dạng phổ biến để khai báo điều kiện kích hoạt của tiện ích bổ sung lịch.

Biểu diễn dưới dạng JSON 
{
  "runFunction": string
}
Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm tiện ích này được kích hoạt.

EventAccess

Một enum xác định cấp độ truy cập dữ liệu mà điều kiện kích hoạt sự kiện yêu cầu.

Enum
UNSPECIFIED Giá trị mặc định khi không có giá trị nào được đặt cho eventAccess.
METADATA Cấp cho trình kích hoạt sự kiện quyền truy cập vào siêu dữ liệu của sự kiện, chẳng hạn như mã sự kiện và mã lịch.
READ Cung cấp cho trình kích hoạt sự kiện quyền truy cập vào tất cả các trường sự kiện được cung cấp, bao gồm cả siêu dữ liệu, người tham dự và dữ liệu hội nghị.
WRITE Cấp cho trình kích hoạt sự kiện quyền truy cập vào siêu dữ liệu của sự kiện và khả năng thực hiện mọi hành động, bao gồm cả việc thêm người tham dự và đặt dữ liệu hội nghị.
READ_WRITE Cung cấp cho trình kích hoạt sự kiện quyền truy cập vào tất cả các trường sự kiện được cung cấp, bao gồm cả siêu dữ liệu, người tham dự và dữ liệu hội nghị, cũng như khả năng thực hiện tất cả các hành động.

DocsAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và cách thực thi của một tiện ích bổ sung cho Google Tài liệu.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

Nếu có, giá trị này sẽ ghi đè cấu hình từ addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Điểm cuối cần thực thi khi quyền uỷ quyền phạm vi tệp được cấp cho cặp tài liệu/người dùng này.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Danh sách các điểm mở rộng để xem trước đường liên kết trong tài liệu trên Google Tài liệu. Để biết thông tin chi tiết, hãy xem bài viết Xem trước đường liên kết bằng khối thông minh.
createActionTriggers[]

object (CreateActionExtensionPoint)

Danh sách các điểm mở rộng để tạo tài nguyên của bên thứ ba từ trong các ứng dụng của Google Workspace. Để biết thêm thông tin, hãy xem bài viết Tạo tài nguyên của bên thứ ba trong trình đơn @.

DocsExtensionPoint

Định dạng phổ biến để khai báo điều kiện kích hoạt của tiện ích bổ sung cho Tài liệu.

Biểu diễn dưới dạng JSON 
{
  "runFunction": string
}
Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm tiện ích này được kích hoạt.

LinkPreviewExtensionPoint

Cấu hình cho một điều kiện kích hoạt được kích hoạt khi người dùng nhập hoặc dán một đường liên kết từ một dịch vụ bên thứ ba hoặc dịch vụ không phải của Google vào tệp Google Tài liệu, Trang tính hoặc Trang trình bày.

Biểu diễn dưới dạng JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
Trường
labelText

string

Bắt buộc. Văn bản cho một khối thông minh mẫu nhắc người dùng xem trước đường liên kết, chẳng hạn như Example: Support case. Văn bản này là văn bản tĩnh và xuất hiện trước khi người dùng thực thi tiện ích bổ sung.
localizedLabelText

map (key: string, value: string)

Không bắt buộc. Bản đồ labeltext để bản địa hoá sang các ngôn ngữ khác. Định dạng ngôn ngữ theo ISO 639 và quốc gia/khu vực theo ISO 3166, phân tách bằng dấu gạch nối -. Ví dụ: en-US

Nếu ngôn ngữ của người dùng có trong các khoá của bản đồ, thì người dùng sẽ thấy phiên bản đã bản địa hoá của labeltext.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
patterns[]

object (UriPattern)

Bắt buộc. Một mảng các mẫu URL kích hoạt tiện ích bổ sung để xem trước đường liên kết.
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi bản xem trước đường liên kết được kích hoạt.
logoUrl

string

Không bắt buộc. Biểu tượng xuất hiện trong khối thông minh và thẻ xem trước. Nếu bạn bỏ qua, tiện ích bổ sung sẽ sử dụng biểu tượng thanh công cụ, logourl.

UriPattern

Cấu hình cho từng mẫu URL kích hoạt bản xem trước đường liên kết.

Biểu diễn dưới dạng JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Trường
hostPattern

string

Bắt buộc đối với mỗi mẫu URL để xem trước. Miền của mẫu URL. Tiện ích bổ sung này xem trước các đường liên kết có chứa miền này trong URL. Để xem trước đường liên kết cho một miền con cụ thể, chẳng hạn như subdomain.example.com, hãy thêm miền con đó. Để xem trước đường liên kết cho toàn bộ miền, hãy chỉ định một ký tự đại diện có dấu hoa thị (*) làm miền con.

Ví dụ: *.example.com khớp với subdomain.example.com và another.subdomain.example.com.
pathPrefix

string

Không bắt buộc. Đường dẫn nối thêm miền của hostpattern.

Ví dụ: nếu mẫu máy chủ lưu trữ URL là support.example.com, để khớp với URL cho các trường hợp được lưu trữ tại support.example.com/cases/, hãy nhập cases.

Để so khớp tất cả URL trong miền mẫu máy chủ, hãy để trống pathprefix.

CreateActionExtensionPoint

Cấu hình cho một điều kiện kích hoạt được kích hoạt khi người dùng gọi quy trình tạo tài nguyên trong một ứng dụng Google Workspace. Để biết thêm thông tin, hãy xem bài viết Tạo tài nguyên của bên thứ ba trong trình đơn @.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
Trường
id

string

Bắt buộc. Mã nhận dạng duy nhất để phân biệt điểm tiện ích này. Mã nhận dạng có thể chứa tối đa 64 ký tự và phải có định dạng [a-zA-Z0-9-]+.
labelText

string

Bắt buộc. Văn bản xuất hiện cùng với biểu tượng cho điểm truy cập tạo tài nguyên, chẳng hạn như Create support case. Văn bản này là văn bản tĩnh và xuất hiện trước khi người dùng thực thi tiện ích bổ sung.
localizedLabelText

map (key: string, value: string)

Không bắt buộc. Bản đồ labeltext để bản địa hoá sang các ngôn ngữ khác. Định dạng ngôn ngữ theo ISO 639 và quốc gia/khu vực theo ISO 3166, phân tách bằng dấu gạch nối -. Ví dụ: en-US

Nếu ngôn ngữ của người dùng có trong các khoá của bản đồ, thì người dùng sẽ thấy phiên bản đã bản địa hoá của labeltext.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi quy trình tạo tài nguyên được kích hoạt để tạo đường liên kết.
logoUrl

string

Không bắt buộc. Biểu tượng xuất hiện cho điểm truy cập tạo tài nguyên. Nếu bạn bỏ qua, trình đơn sẽ sử dụng biểu tượng thanh công cụ của tiện ích bổ sung, logourl.

MeetAddOnManifest

Tệp kê khai tiện ích bổ sung của Meet.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

Nếu có, giá trị này sẽ ghi đè cấu hình từ addons.common.homepageTrigger.
web

object (Web)

Thông tin chi tiết về các tiện ích bổ sung giúp cải thiện ứng dụng Meet trên web.
supportsCollaboration

boolean

Tiện ích bổ sung có hỗ trợ cộng tác hoặc mời người khác tham gia trải nghiệm tiện ích bổ sung hay không.
termsUri

string

Đường liên kết đến điều khoản dịch vụ của tiện ích bổ sung (nếu có).

Web

Thông tin chi tiết về các tiện ích bổ sung giúp cải thiện ứng dụng Meet trên web.

Biểu diễn dưới dạng 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)
}
Trường
sidePanelUri
(deprecated)

string

URI cho iframe của bảng điều khiển bên.
sidePanelUrl

string

URL cho iframe của bảng điều khiển bên.
mainStageUri
(deprecated)

string

URI cho iframe "giai đoạn chính".
supportsScreenSharing

boolean

Liệu tiện ích bổ sung có hỗ trợ chia sẻ màn hình chính hay không.
supportsCollaboration
(deprecated)

boolean

Tiện ích bổ sung có hỗ trợ cộng tác hoặc mời người khác tham gia trải nghiệm tiện ích bổ sung hay không. Trường này hiện không còn được dùng nữa, vui lòng sử dụng trường cấp cao nhất trong MeetAddOnManifest.
supportsPopOut

boolean

Liệu tiện ích bổ sung có hỗ trợ bật ra trải nghiệm hình trong hình của trình duyệt hay không.
hostOrigins[]
(deprecated)

string

Tên cũ, không dùng nữa. Các nguồn gốc cần được thêm vào thuộc tính frame-src của iframe chứa trang web của bên thứ ba. Thay vào đó, hãy sử dụng addonorigins.
addOnOrigins[]

string

Các nguồn gốc cần được thêm vào thuộc tính frame-src của iframe chứa trang web của bên thứ ba.
openState

enum (State)

Trạng thái ban đầu khi tiện ích bổ sung được mở.
supportsCollaborationHostControls

boolean

Liệu tiện ích bổ sung cộng tác có hỗ trợ các chế độ kiểm soát của người tổ chức hay không.
logoUrl

string

URL của biểu trưng sẽ hiển thị cho tiện ích bổ sung. Nếu bạn không chỉ định, biểu trưng sẽ mặc định là biểu trưng trong phần chung của tệp kê khai.
darkModeLogoUrl

string

Phiên bản chế độ tối của logourl.
displayFlow
(deprecated)

enum (DisplayFlow)

Quy trình hiển thị mà tiện ích bổ sung sẽ tuân theo khi khởi chạy.

Tiểu bang

Enum để chỉ định trạng thái mở tiện ích bổ sung ban đầu.

Enum
STATE_UNSPECIFIED Trạng thái ban đầu chưa được chỉ định cho tiện ích bổ sung.
SIDE_PANEL_ONLY Tiện ích bổ sung sẽ mở ra và chỉ có bảng điều khiển bên hoạt động.
MAIN_STAGE_ONLY Tiện ích bổ sung sẽ mở ra và chỉ có màn hình chính hoạt động.
SIDE_PANEL_AND_MAIN_STAGE Tiện ích bổ sung mở ra khi cả bảng điều khiển bên và màn hình chính đều đang hoạt động.

DisplayFlow

Enum để chỉ định quy trình hiển thị mà tiện ích bổ sung sẽ tuân theo khi khởi chạy

Enum
DISPLAY_FLOW_UNSPECIFIED Chưa chỉ định quy trình hiển thị.
FOCUS Tiện ích bổ sung sẽ chạy trong quy trình hiển thị "tiêu điểm".
AUGMENT Tiện ích bổ sung phải chạy trong quy trình hiển thị "bổ sung".

SheetsAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và cách thực thi của một tiện ích bổ sung cho Google Trang tính.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

Nếu có, giá trị này sẽ ghi đè cấu hình từ addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Điểm cuối cần thực thi khi quyền uỷ quyền phạm vi tệp được cấp cho cặp tài liệu/người dùng này.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Danh sách các điểm của tiện ích để xem trước đường liên kết trong tài liệu Google Trang tính. Để biết thông tin chi tiết, hãy xem bài viết Xem trước đường liên kết bằng khối thông minh.

SheetsExtensionPoint

Định dạng phổ biến để khai báo điều kiện kích hoạt của tiện ích bổ sung cho Trang tính.

Biểu diễn dưới dạng JSON 
{
  "runFunction": string
}
Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm tiện ích này được kích hoạt.

SlidesAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và cách thực thi của một tiện ích bổ sung cho Google Trang trình bày.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

Nếu có, giá trị này sẽ ghi đè cấu hình từ addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Điểm cuối cần thực thi khi quyền uỷ quyền phạm vi tệp được cấp cho cặp tài liệu/người dùng này.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Danh sách các điểm của tiện ích để xem trước đường liên kết trong tài liệu Google Trang trình bày. Để biết thông tin chi tiết, hãy xem bài viết Xem trước đường liên kết bằng khối thông minh.

SlidesExtensionPoint

Định dạng phổ biến để khai báo điều kiện kích hoạt của tiện ích bổ sung cho Trang trình bày.

Biểu diễn dưới dạng JSON 
{
  "runFunction": string
}
Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm tiện ích này được kích hoạt.

HttpOptions

Các lựa chọn để gửi yêu cầu đến điểm cuối của tiện ích bổ sung HTTP.

Biểu diễn dưới dạng JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Trường
authorizationHeader

enum (HttpAuthorizationHeader)

Cấu hình cho mã thông báo được gửi trong tiêu đề Uỷ quyền HTTP.
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

Liệu tiện ích bổ sung có bật tính năng Đồng ý OAuth chi tiết hay không.

HttpAuthorizationHeader

Tiêu đề uỷ quyền được gửi trong các yêu cầu của tiện ích bổ sung HTTP.

Enum
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Giá trị mặc định, tương đương với SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Gửi mã thông báo giá trị nhận dạng cho tài khoản dịch vụ hệ thống của tiện ích bổ sung Google Workspace dành riêng cho dự án (mặc định).
USER_ID_TOKEN Gửi mã thông báo nhận dạng cho người dùng cuối.
NONE Đừng gửi tiêu đề Authentication.

GranularOauthPermissionSupport

Liệu tiện ích bổ sung có bật tính năng Đồng ý OAuth chi tiết hay không.

Enum
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Giá trị mặc định, không nên sử dụng.
OPT_IN Tiện ích bổ sung đã chọn sử dụng tính năng Đồng ý chi tiết theo OAuth.
OPT_OUT Tiện ích bổ sung này đã chọn không sử dụng tính năng Đồng ý chi tiết theo giao thức OAuth.

Phương thức

create

 Tạo một bản triển khai có tên và cấu hình được chỉ định.

delete

 Xoá bản triển khai có tên đã cho.

get

 Lấy bản triển khai có tên được chỉ định.

getInstallStatus

 Lấy trạng thái cài đặt của một bản triển khai thử nghiệm.

install

 Cài đặt một bản triển khai vào tài khoản của bạn để thử nghiệm.

list

 Liệt kê tất cả các bản triển khai trong một dự án cụ thể.

replaceDeployment

 Tạo hoặc thay thế một bản triển khai bằng tên đã chỉ định.

uninstall

 Gỡ cài đặt một bản triển khai thử nghiệm khỏi tài khoản của người dùng.