REST Resource: projects.deployments

Tài nguyên: Triển khai

Một lượt 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 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 của tiện ích bổ sung Google Workspace.
etag

string

Giá trị này do 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 ứ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)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Trường
common

object (CommonAddOnManifest)

Đây là cấu hình phổ biến trên tất 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 dành cho Drive.
calendar

object (CalendarAddOnManifest)

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

object (DocsAddOnManifest)

Cấu hình tiện ích bổ sung của Tài liệu.
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 bổ sung

CommonAddOnManifest

Cấu hình tiện ích bổ sung được chia sẻ trên tất 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 hiển thị trong thanh công cụ của tiện ích bổ sung.
layoutProperties

object (LayoutProperties)

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

object (AddOnWidgetSet)

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

boolean

Liệu có truyề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 bất kỳ ngữ cảnh nào, trên bất kỳ máy chủ nào. Người dùng luôn có thể sử dụng mọi thẻ do hàm này tạo, nhưng nội dung theo bối cảnh có thể bị che khuất khi tiện ích bổ sung này khai báo thêm điều kiện kích hoạt được nhắm mục tiêu.
universalActions[]

object (UniversalActionExtensionPoint)

Xác định danh sách các điểm tiện ích 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à URL đường liên kết để mở hoặc điểm cuối để thực thi dưới dạng một lượt gửi biểu mẫu.
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 giao thức, thì HTTPS sẽ được giả định. Đường liên kết HTTP được tự động viết lại thành đường liên kết đến HTTPS.

LayoutProperties

Thuộc tính bố cục thẻ dùng chung trên 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. Công cụ này đặt màu của thanh công cụ. Nếu bạn không đặt màu chính, 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 và màu phụ, thì giá trị mặc định do khung cung cấp sẽ được sử dụng.
useNewMaterialDesign

boolean

Bật Material Design cho thẻ.

AddOnWidgetSet

Tập hợp con tiện ích mà 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 tiện ích được dùng trong 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 Đã đặt 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 nền 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 thao tác.
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 Thao tác 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 để 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, thì chế độ xem trang chủ sẽ bị tắt trong trường hợp này.

Giá trị 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ị 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 của mục trong 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ị cho người dùng 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".
Trường hợp hợp nhất action_type. Bắt buộc. Loại thao tác được hỗ trợ trên 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 đây:
runFunction

string

Điểm cuối sẽ do UniversalAction chạy.

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 ngữ cảnh không khớp với trình kích hoạt theo ngữ 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 nội dung theo bối cảnh có thể bị che khuất khi tiện ích bổ sung này khai báo thêm điều kiện kích hoạt được nhắm mục tiêu.

Nếu có, cấu hình 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 điều kiện kích hoạt thời gian soạn cho tiện ích bổ sung thời gian soạn. Đâ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 về thời gian soạn thư phải có phạm vi gmail.addons.current.action.compose, mặc dù tiện ích bổ sung đó có thể không chỉnh sửa được 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 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 đầu 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 kích hoạt, điều kiện 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,

  // 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 kết hợp trigger. 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. trigger chỉ có thể là một trong những giá trị sau:
unconditional

object (UnconditionalTrigger)

Trình kích hoạt không có điều kiện được thực thi khi bất kỳ thư nào được mở.

UnconditionalTrigger

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

Một trình kích hoạt sẽ kích hoạt khi người dùng mở bất kỳ email nào.

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 kết hợp action_type. Loại thao tác xác định hành vi của Gmail khi người dùng yêu cầu thao tác. action_type chỉ có thể là một trong những giá trị sau:
runFunction

string

Một điểm cuối được gọi khi người dùng kích hoạt hành động. Vui lòng xem hướng dẫn 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 thao tác cho tiện ích bổ sung thời gian soạn thư. Đây là những thao tác mà người dùng có thể kích hoạt trên tiện ích bổ sung thời gian soạn.
draftAccess

enum (DraftAccess)

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

DraftAccess

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

Enum
UNSPECIFIED Giá trị mặc định khi không đặt giá trị nào cho quyền nháp.
NONE Điều kiện kích hoạt Compose không thể truy cập vào bất kỳ dữ liệu nào của thư nháp khi một tiện ích bổ sung Compose được kích hoạt.
METADATA Cấp cho trình kích hoạt Compose quyền truy cập vào siêu dữ liệu của bản nháp khi một tiện ích bổ sung Compose được kích hoạt. Danh sách này bao gồm danh sách đối tượng, chẳng hạn như danh sách Đến 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 tiện ích bổ sung của Drive.

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

object (HomepageExtensionPoint)

Nếu có, cấu hình 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 trình 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 cần 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à cách thực thi 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 ngữ cảnh không khớp với điều kiện kích hoạt theo ngữ 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 làm lu mờ khi tiện ích bổ sung này khai báo các trình kích hoạt được nhắm mục tiêu hơn.

Nếu có, cấu hình 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 tiện ích bổ sung hội nghị của bên thứ ba trong Apps Script.
createSettingsUrlFunction

string

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

object (CalendarExtensionPoint)

Đ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 điều kiện kích hoạt theo ngữ 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 chứ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ị truyền hình. Bạn chỉ có thể tích hợp tiện ích bổ sung về hội nghị truyền hình của bên thứ ba 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 cần gọi khi cần tạo dữ liệu hội nghị truyền hình.
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ị 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ù có thể thay đổi tên hiển thị của 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 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 trình 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 độ yêu cầu của trình kích hoạt sự kiện truy cập dữ liệu.

Enum
UNSPECIFIED Giá trị mặc định khi không đặt giá trị nào cho eventAccess.
METADATA Cấp cho sự kiện sẽ kích hoạt 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 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 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ả hành động.

DocsAddOnManifest

Các thuộc tính tuỳ chỉnh giao diện và cách thực thi tiện ích bổ sung của 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ó, cấu hình này sẽ ghi đè cấu hình trong addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Điểm cuối để thực thi khi cấp quyền truy cập vào phạm vi tệ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 bên thứ ba 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 từ trình đơn @.

DocsExtensionPoint

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

LinkPreviewExtensionPoint

Cấu hình của điều kiện kích hoạt sẽ kích hoạt khi người dùng nhập hoặc dán đường liên kết từ một dịch vụ bên thứ ba hoặc 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à hiển thị 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 hiển thị 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 mỗi 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 của 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 của 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 miền của hostpattern.

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

Để khớp tất cả URL trong miền mẫu máy chủ lưu trữ, 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 phần Tạo tài nguyên bên thứ ba qua 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 ở đị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 ở dạng tĩnh và hiển thị 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 để 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 hiển thị cho điểm truy cập tạo tài nguyên. Nếu bạn bỏ qua, trình đơn này sẽ sử dụng biểu tượng thanh công cụ của tiện ích bổ sung, logourl.

SheetsAddOnManifest

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 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ó, cấu hình này sẽ ghi đè cấu hình trong addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

Danh sách các điểm tiện ích dùng để xem trước đường liên kết trong một 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 trình 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 mở rộng 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 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ó, cấu hình này sẽ ghi đè cấu hình trong addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

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

object (LinkPreviewExtensionPoint)

Danh sách các điểm tiện ích dùng để xem trước đường liên kết trong một tài liệu trên 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 trình kích hoạt của tiện ích bổ sung trong 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 mở rộng 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)
}
Trường
authorizationHeader

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

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

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 mã 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 (Xác thực).

Phương thức

create

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

delete

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

get

 Lấy thông tin triển khai có tên đã chỉ định.

getInstallStatus

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

install

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

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ế quá trình 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.