REST Resource: projects.deployments

Tài nguyên: Triển khai

Triển khai tiện ích bổ sung của 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 sự đồng ý của người dùng cuối 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 được máy chủ tính toán dựa trên phiên 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 rằng ứ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ả tiện ích bổ sung của Google Workspace.
gmail

object (GmailAddOnManifest)

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

object (DriveAddOnManifest)

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

object (CalendarAddOnManifest)

Cấu hình tiện ích bổ sung dành 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 chung 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, hệ thống sẽ sử dụng bộ mặc định.
useLocaleFromApp

boolean

Có truyền thông tin về 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, trong mọi máy chủ lưu trữ. Người dùng sẽ luôn thấy mọi thẻ do hàm này tạo, nhưng thẻ 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 các điều kiện kích hoạt được nhắm đến cụ thể 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 mở rộng 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 biểu mẫu gửi.
openLinkUrlPrefixes

array (ListValue format)

Thao tác 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 đồ, HTTPS sẽ được giả định. Các đườ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 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 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Trường
primaryColor

string

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

string

Màu phụ của tiện ích bổ sung. API này đặt màu cho 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 và màu phụ, thì giá trị mặc định do khung cung cấp sẽ được dùng.
useNewMaterialDesign
(deprecated)

boolean

Cho phép thiết kế theo ngôn ngữ 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ó kiểu bao gồm nút được tô màu nền và nút bị vô hiệu hoá.
PERSISTENT_FORMS Biểu mẫu liên tục cho phép duy trì các giá trị biểu mẫu trong các 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 thao tác của tiện ích bổ sung 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 sẽ thực thi khi điểm mở rộng 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ẽ không hoạt động trong bối cảnh này.

Mặc định là true nếu bạn không đặ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 một điểm mở rộng mục trình đơn thao tác chung.

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

string

Bắt buộc. Văn bản hiển thị với người dùng mô tả hành động được thực hiện khi kích hoạt điểm mở rộng này, ví dụ: "Thêm người liên hệ mới".
Trường nhóm action_type. Bắt buộc. Loại thao tác đượ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. action_type chỉ có thể là một trong những trạng thái sau:
runFunction

string

Điểm cuối sẽ được UniversalAction chạy.

GmailAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và quá trình thực thi của một tiện ích bổ sung 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 một điều kiện kích hoạt theo bối cảnh đã khai báo. Mọi thẻ do hàm này tạo ra sẽ luôn có sẵn cho người dùng, 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 các điều kiện kích hoạt được nhắm đến cụ thể hơn.

Nếu có, tham số 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 thao tác 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 trình kích hoạt thời gian tạo cho tiện ích bổ sung thời gian tạo. Đâ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ả các tiện ích bổ sung thời gian soạn đều phải có phạm vi gmail.addons.current.action.compose, ngay cả khi tiện ích đó không chỉnh sửa bản 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 uỷ quyền bắt buộc của bên thứ ba, bằng cách kiểm tra các API của bên thứ ba. Nếu quá trình kiểm tra 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 người dùng có trải nghiệm mượt mà.

ContextualTrigger

Xác định một điều kiện kích hoạt sẽ kích hoạt khi email mở đáp ứng một tiêu chí cụ thể. Khi điều kiện kích hoạt hoạt động, điều kiện này 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,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
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.
Trường nhóm trigger. Loại điều kiện kích hoạt sẽ xác định những điều kiện mà Gmail sử dụng để hiển thị tiện ích bổ sung. trigger chỉ có thể là một trong những trạng thái sau:
unconditional

object (UnconditionalTrigger)

Các điều kiện kích hoạt vô điều kiện sẽ được thực thi khi có thư được mở.

UnconditionalTrigger

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

Một điều kiện kích hoạt sẽ hoạt động khi có email được mở.

UniversalAction

Một thao tác 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,

  // 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.
}
Trường
text

string

Bắt buộc. Văn bản hiển thị với người dùng mô tả hành động, ví dụ: "Thêm người liên hệ mới".
Trường nhóm action_type. Loại hành động sẽ xác định hành vi của Gmail khi người dùng gọi hành động. action_type chỉ có thể là một trong những trạng thái sau:
runFunction

string

Một điểm cuối được gọi khi người dùng kích hoạt hành động. Hãy xem hướng dẫn về thao tác chung để biết thông tin chi tiết.

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 tập hợp các thao tác cho một tiện ích bổ sung tại thời gian tạo. Đâ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 tại thời điểm soạn.
draftAccess

enum (DraftAccess)

Xác định cấp độ truy cập dữ liệu khi tiện ích bổ sung thời gian tạo đượ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 thành phần cần.

Enum
UNSPECIFIED Giá trị mặc định khi bạn không đặt giá trị nào 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 bản nháp khi một 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 người nhận, chẳng hạn như danh sách người nhận và người nhận bản sao của một thư nháp.

DriveAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và quá trình 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ó, tham số 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 trong phần Drive của tôi.

DriveExtensionPoint

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

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

string

Bắt buộc. Điểm cuối để thực thi khi điểm mở rộng được kích hoạt.

CalendarAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và quá trình 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)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Trường
homepageTrigger

object (HomepageExtensionPoint)

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 một điều kiện kích hoạt theo bối cảnh đã khai báo. Người dùng sẽ luôn thấy mọi thẻ do hàm này tạo, nhưng thẻ 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 các điều kiện kích hoạt được nhắm đến cụ thể hơn.

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

object (ConferenceSolution)

Xác định các giải pháp hội nghị do tiện ích bổ sung này cung cấp. Bạn chỉ có thể tạo các tiện ích bổ sung của bên thứ ba về hội nghị truyền hình trong Apps Script.
createSettingsUrlFunction

string

Một điểm cuối để thực thi việc tạo URL cho 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.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Cấu hình cho một điều kiện kích hoạt theo bối cảnh sẽ kích hoạt khi người dùng nhấp vào trình cung cấp tệp đính kèm của tiện ích bổ sung trong trình đơn thả xuống 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ị. Bạn chỉ có thể tạo các tiện ích bổ sung của bên thứ ba về hội nghị truyền hình trong Apps Script.

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 để gọi khi cần tạo dữ liệu hội nghị.
id

string

Bắt buộc. Bạn phải chỉ định mã nhận dạng riêng biệt cho các giải pháp hội nghị trong một tiện ích bổ sung. Nếu không, giải pháp hội nghị không chính xác có thể được 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ị.
logoUrl

string

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

CalendarExtensionPoint

Định dạng phổ biến để khai báo các đ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 để thực thi khi điểm mở rộng này được kích hoạt.

EventAccess

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

Enum
UNSPECIFIED Giá trị mặc định khi không có giá trị nào được đặt cho eventAccess.
METADATA Cho phép các điều kiện kích hoạt sự kiệ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 Cho phép sự kiện kích hoạt 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 Cho phép các trình kích hoạt sự kiện truy cập vào siêu dữ liệu của sự kiện và có thể thực hiện mọi hành động, bao gồm cả việc thêm người tham dự và thiết lập dữ liệu hội nghị.
READ_WRITE Cho phép các điều kiện kích hoạt sự kiệ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à quá trình thực thi của một tiện ích bổ sung 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ó, tham số 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 theo 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 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 trong các ứ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 bên thứ ba bằng trình đơn @.

DocsExtensionPoint

Định dạng phổ biến để khai báo các đ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 sẽ thực thi khi điểm mở rộng này được kích hoạt.

LinkPreviewExtensionPoint

Cấu hình cho một điều kiện kích hoạt sẽ hoạt động khi người dùng nhập hoặc dán một đường liên kết từ dịch vụ của bên thứ ba hoặc dịch vụ không phải của Google vào một 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. Một 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 ngang -. 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 để 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 chip 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 trên 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ạn cần có mẫu URL để xem trước. Miền của mẫu URL. Tiện ích bổ sung này xem trước những đườ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 các đường liên kết cho toàn bộ miền, hãy chỉ định ký tự đại diện bằng 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, để so khớp các URL cho những 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 sẽ 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 bên thứ ba bằng 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 mở rộng 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 hiển thị 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. Một 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 ngang -. 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 để thực thi khi quy trình tạo tài nguyên được kích hoạt để tạo một mối 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 bước này, 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ó, tham số 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 nâng cao phiên bản Meet trên web.
supportsCollaboration

boolean

Liệu 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

Bạn nên hiển thị đườ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 nâng cao phiên bản 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 sân khấu chính hay không.
supportsCollaboration
(deprecated)

boolean

Liệu 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 dùng nữa, vui lòng sử dụng trường cấp cao nhất trong MeetAddOnManifest.
supportsPopOut

boolean

Tiện ích bổ sung có hỗ trợ bật lên thành chế độ xem trong cửa sổ nhỏ của trình duyệt hay không.
hostOrigins[]
(deprecated)

string

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

string

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

enum (State)

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

boolean

Tiện ích bổ sung cộng tác có hỗ trợ bộ điều khiển của người tổ chức hay không.
logoUrl

string

URL của biểu trưng sẽ xuất hiện 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)

Luồng 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ở ban đầu của tiện ích bổ sung.

Enum
STATE_UNSPECIFIED Bạn chưa chỉ định trạng thái ban đầu bằng tiện ích bổ sung.
SIDE_PANEL_ONLY Tiện ích bổ sung sẽ mở ra chỉ với bảng điều khiển bên đang hoạt động.
MAIN_STAGE_ONLY Tiện ích bổ sung sẽ mở ra khi chỉ có màn hình chính hoạt động.
SIDE_PANEL_AND_MAIN_STAGE Tiện ích bổ sung sẽ 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

Liệt kê để 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 Bạn chưa chỉ định luồng hiển thị.
FOCUS Tiện ích bổ sung sẽ chạy trong quy trình hiển thị "lấy tiêu điểm".
AUGMENT Tiện ích bổ sung sẽ chạy trong quy trình hiển thị "tăng cường".

SheetsAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và quá trình thực thi của một tiện ích bổ sung 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ó, tham số 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 theo 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 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 các trình kích hoạt của tiện ích bổ sung 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 sẽ thực thi khi điểm mở rộng này được kích hoạt.

SlidesAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và quá trình thực thi của một tiện ích bổ sung 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ó, tham số 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 theo 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 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 các đ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 sẽ thực thi khi điểm mở rộng này được kích hoạt.

HttpOptions

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

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)

Cho biết liệu tiện ích bổ sung có bật tính năng Granular OAuth Consent (Sự đồng ý chi tiết theo OAuth) 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ã nhận dạng (ID) mã thông báo 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 đề Xác thực.

GranularOauthPermissionSupport

Cho biết liệu tiện ích bổ sung có bật tính năng Granular OAuth Consent (Sự đồng ý chi tiết theo OAuth) 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 ý theo giao thức OAuth chi tiết.
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 hoạt động triển khai có tên và cấu hình đã chỉ định.

delete

 Xoá hoạt động triển khai có tên đã cho.

get

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

getInstallStatus

 Nhận 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 quy trình triển khai vào tài khoản của bạn để kiểm thử.

list

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

replaceDeployment

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

uninstall

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