- Resource: Deployment
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- Metode
Resource: Deployment
Deployment Add-on Google Workspace
Representasi JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Kolom | |
---|---|
name |
Nama resource deployment. Contoh: |
oauth |
Daftar cakupan Google OAuth yang izinnya akan diminta dari pengguna akhir sebelum menjalankan endpoint add-on. |
add |
Konfigurasi Add-on Google Workspace. |
etag |
Nilai ini dihitung oleh server berdasarkan versi deployment dalam penyimpanan, dan dapat dikirim pada permintaan pembaruan dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan. |
AddOns
Konfigurasi Add-on Google Workspace.
Representasi JSON |
---|
{ "common": { object ( |
Kolom | |
---|---|
common |
Konfigurasi yang umum di semua Add-on Google Workspace. |
gmail |
Konfigurasi add-on Gmail. |
drive |
Konfigurasi add-on Drive. |
calendar |
Konfigurasi add-on Kalender. |
docs |
Konfigurasi add-on Dokumen. |
sheets |
Konfigurasi add-on Spreadsheet. |
slides |
Konfigurasi add-on Slide. |
http |
Opsi untuk mengirim permintaan ke endpoint HTTP add-on |
CommonAddOnManifest
Konfigurasi add-on yang digunakan bersama di semua aplikasi host add-on.
Representasi JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Kolom | |
---|---|
name |
Wajib. Nama tampilan add-on. |
logo |
Wajib. URL untuk gambar logo yang ditampilkan di toolbar add-on. |
layout |
Properti tata letak umum untuk kartu add-on. |
add |
Widget yang digunakan dalam add-on. Jika kolom ini tidak ditentukan, kumpulan default akan digunakan. |
use |
Apakah akan meneruskan informasi lokalitas dari aplikasi host. |
homepage |
Menentukan endpoint yang akan dieksekusi dalam konteks apa pun, di host mana pun. Setiap kartu yang dihasilkan oleh fungsi ini akan selalu tersedia untuk pengguna, tetapi mungkin terhalang oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih ditargetkan. |
universal |
Menentukan daftar titik ekstensi di menu tindakan universal yang berfungsi sebagai menu setelan untuk add-on. Titik ekstensi dapat berupa URL link untuk dibuka atau endpoint untuk dieksekusi sebagai pengiriman formulir. |
open |
Tindakan OpenLink hanya dapat menggunakan URL dengan skema |
LayoutProperties
Properti tata letak kartu yang dibagikan di semua aplikasi host add-on.
Representasi JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Kolom | |
---|---|
primary |
Warna utama add-on. Properti ini menetapkan warna toolbar. Jika tidak ada warna primer yang ditetapkan, nilai default yang disediakan oleh framework akan digunakan. |
secondary |
Warna sekunder add-on. Ini menetapkan warna tombol. Jika warna primer ditetapkan, tetapi tidak ada warna sekunder yang ditetapkan, warna sekunder akan sama dengan warna primer. Jika warna primer atau warna sekunder tidak ditetapkan, nilai default yang disediakan oleh framework akan digunakan. |
use |
Mengaktifkan desain material untuk kartu. |
AddOnWidgetSet
Subset widget yang digunakan oleh add-on.
Representasi JSON |
---|
{
"usedWidgets": [
enum ( |
Kolom | |
---|---|
used |
Daftar widget yang digunakan dalam add-on. |
WidgetType
Jenis widget. WIDGET_TYPE_UNSPECIFIED
adalah kumpulan widget dasar.
Enum | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
Set widget default. |
DATE_PICKER |
Pemilih tanggal. |
STYLED_BUTTONS |
Tombol bergaya mencakup tombol terisi dan tombol yang dinonaktifkan. |
PERSISTENT_FORMS |
Formulir persisten memungkinkan nilai formulir tetap ada selama tindakan. |
FIXED_FOOTER |
Footer pada kartu telah diperbaiki. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Memperbarui subjek dan penerima draf. |
GRID_WIDGET |
Widget petak. |
ADDON_COMPOSE_UI_ACTION |
Tindakan add-on Gmail yang berlaku untuk UI penulisan add-on. |
HomepageExtensionPoint
Format umum untuk mendeklarasikan tampilan halaman beranda add-on.
Representasi JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Kolom | |
---|---|
run |
Wajib. Endpoint yang akan dieksekusi saat titik ekstensi ini diaktifkan. |
enabled |
Opsional. Jika disetel ke Secara default ke Jika tampilan halaman beranda kustom add-on dinonaktifkan, kartu ringkasan umum akan diberikan untuk pengguna. |
UniversalActionExtensionPoint
Format untuk mendeklarasikan titik ekstensi item menu tindakan universal.
Representasi JSON |
---|
{ "label": string, // Union field |
Kolom | |
---|---|
label |
Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan yang diambil dengan mengaktifkan titik ekstensi ini, misalnya, "Tambahkan kontak baru". |
Kolom union action_type . Wajib. Jenis tindakan yang didukung pada item menu tindakan universal. Dapat berupa link untuk dibuka atau endpoint untuk dieksekusi. action_type hanya dapat berupa salah satu dari berikut: |
|
open |
URL yang akan dibuka oleh UniversalAction. |
run |
Endpoint yang akan dijalankan oleh UniversalAction. |
GmailAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Gmail.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepage |
Menentukan endpoint yang akan dijalankan dalam konteks yang tidak cocok dengan pemicu kontekstual yang dideklarasikan. Setiap kartu yang dihasilkan oleh fungsi ini akan selalu tersedia untuk pengguna, tetapi dapat terhalang oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih ditargetkan. Jika ada, konfigurasi ini akan mengganti konfigurasi dari |
contextual |
Menentukan kumpulan kondisi yang memicu add-on. |
universal |
Menentukan serangkaian tindakan universal untuk add-on. Pengguna memicu tindakan universal dari menu toolbar add-on. |
compose |
Menentukan pemicu waktu penulisan untuk add-on waktu penulisan. Ini adalah pemicu yang menyebabkan add-on mengambil tindakan saat pengguna menulis email. Semua add-on waktu compose harus memiliki cakupan |
authorization |
Nama endpoint yang memverifikasi bahwa add-on memiliki semua otorisasi pihak ketiga yang diperlukan, dengan menyelidiki API pihak ketiga. Jika pemeriksaan gagal, fungsi harus menampilkan pengecualian untuk memulai alur otorisasi. Fungsi ini dipanggil sebelum setiap pemanggilan add-on untuk memastikan pengalaman pengguna yang lancar. |
ContextualTrigger
Menentukan pemicu yang diaktifkan saat email yang dibuka memenuhi kriteria tertentu. Saat diaktifkan, pemicu akan menjalankan endpoint tertentu, biasanya untuk membuat kartu baru dan mengupdate UI.
Representasi JSON |
---|
{ "onTriggerFunction": string, // Union field |
Kolom | |
---|---|
on |
Wajib. Nama endpoint yang akan dipanggil saat pesan cocok dengan pemicu. |
Kolom union trigger . Jenis pemicu menentukan kondisi yang digunakan Gmail untuk menampilkan add-on. trigger hanya dapat berupa salah satu dari berikut: |
|
unconditional |
Pemicu tanpa syarat dieksekusi saat pesan email dibuka. |
UnconditionalTrigger
Jenis ini tidak memiliki kolom.
Pemicu yang diaktifkan saat pesan email dibuka.
UniversalAction
Tindakan yang selalu tersedia di menu toolbar add-on, terlepas dari konteks pesan.
Representasi JSON |
---|
{ "text": string, // Union field |
Kolom | |
---|---|
text |
Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan, misalnya, "Menambahkan kontak baru". |
Kolom union action_type . Jenis tindakan menentukan perilaku Gmail saat pengguna memanggil tindakan. action_type hanya dapat berupa salah satu dari berikut: |
|
open |
Link yang dibuka oleh Gmail saat pengguna memicu tindakan. |
run |
Endpoint yang dipanggil saat pengguna memicu tindakan. Lihat panduan tindakan universal untuk mengetahui detailnya. |
ComposeTrigger
Pemicu yang diaktifkan saat pengguna menulis email.
Representasi JSON |
---|
{ "actions": [ { object ( |
Kolom | |
---|---|
actions[] |
Menentukan kumpulan tindakan untuk add-on waktu penulisan. Ini adalah tindakan yang dapat dipicu pengguna pada add-on waktu compose. |
draft |
Menentukan tingkat akses data saat add-on waktu penulisan dipicu. |
MenuItemExtensionPoint
Format umum untuk mendeklarasikan item menu atau tombol yang muncul dalam aplikasi host.
Representasi JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Kolom | |
---|---|
run |
Wajib. Endpoint yang akan dieksekusi saat titik ekstensi ini diaktifkan. |
label |
Wajib. Teks yang terlihat pengguna yang menjelaskan tindakan yang dilakukan dengan mengaktifkan titik ekstensi ini. Misalnya, "Masukkan invoice". |
logo |
URL untuk gambar logo yang ditampilkan di toolbar add-on. Jika tidak ditetapkan, setelan defaultnya adalah URL logo utama add-on. |
DraftAccess
Enum yang menentukan tingkat akses data yang diperlukan pemicu compose.
Enum | |
---|---|
UNSPECIFIED |
Nilai default saat tidak ada yang ditetapkan untuk draftaccess. |
NONE |
Pemicu compose tidak dapat mengakses data draf apa pun saat add-on compose dipicu. |
METADATA |
Memberi pemicu compose izin untuk mengakses metadata draf saat add-on compose dipicu. Hal ini mencakup daftar audiens, seperti daftar Kepada dan Cc dari pesan draf. |
DriveAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Drive.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepage |
Jika ada, konfigurasi ini akan mengganti konfigurasi dari |
on |
Sesuai dengan perilaku yang dijalankan saat item dipilih di tampilan Drive yang relevan, seperti Daftar Dokumen Drive Saya. |
DriveExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on Drive.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
run |
Wajib. Endpoint yang akan dieksekusi saat titik ekstensi diaktifkan. |
CalendarAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Kalender.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepage |
Menentukan endpoint yang dijalankan dalam konteks yang tidak cocok dengan pemicu kontekstual yang dideklarasikan. Kartu apa pun yang dibuat oleh fungsi ini akan selalu tersedia bagi pengguna, tetapi mungkin akan digantikan oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih bertarget. Jika ada, konfigurasi ini akan menggantikan konfigurasi dari |
conference |
Menentukan solusi konferensi yang disediakan oleh add-on ini. Add-on konferensi pihak ketiga hanya dapat dibuat di Apps Script. |
create |
Endpoint yang akan dieksekusi yang membuat URL ke halaman setelan add-on. |
event |
Endpoint yang terpicu saat suatu peristiwa dibuka untuk dilihat atau diedit. |
event |
Endpoint yang dipicu saat peristiwa terbuka diperbarui. |
event |
Konfigurasi untuk pemicu kontekstual yang diaktifkan saat pengguna mengklik penyedia lampiran add-on di menu dropdown Kalender. |
current |
Menentukan tingkat akses data saat add-on peristiwa dipicu. |
ConferenceSolution
Menentukan nilai terkait konferensi. Add-on konferensi pihak ketiga hanya dapat dibuat di Apps Script.
Representasi JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Kolom | |
---|---|
on |
Wajib. Endpoint yang akan dipanggil saat data konferensi harus dibuat. |
id |
Wajib. ID harus ditetapkan secara unik di seluruh solusi konferensi dalam satu add-on. Jika tidak, solusi konferensi yang salah mungkin digunakan saat add-on dipicu. Meskipun Anda dapat mengubah nama tampilan add-on, ID-nya tidak boleh diubah. |
name |
Wajib. Nama tampilan solusi konferensi. |
logo |
Wajib. URL untuk gambar logo solusi konferensi. |
CalendarExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on kalender.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
run |
Wajib. Endpoint yang akan dieksekusi saat titik ekstensi ini diaktifkan. |
EventAccess
Enum yang menentukan tingkat pemicu peristiwa akses data yang diperlukan.
Enum | |
---|---|
UNSPECIFIED |
Nilai default jika tidak ada yang ditetapkan untuk eventAccess. |
METADATA |
Memberi pemicu peristiwa izin untuk mengakses metadata peristiwa, seperti ID peristiwa dan ID kalender. |
READ |
Memberi pemicu peristiwa akses ke semua kolom acara yang disediakan, termasuk metadata, peserta, dan data konferensi. |
WRITE |
Memberikan pemicu peristiwa akses ke metadata peristiwa dan kemampuan untuk melakukan semua tindakan, termasuk menambahkan tamu dan menetapkan data konferensi. |
READ_WRITE |
Memberikan akses pemicu peristiwa ke semua kolom peristiwa yang disediakan, termasuk metadata, tamu, dan data konferensi, serta kemampuan untuk melakukan semua tindakan. |
DocsAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Google Dokumen.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepage |
Jika ada, konfigurasi ini akan menggantikan konfigurasi dari |
on |
Endpoint yang akan dijalankan saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini. |
link |
Daftar titik ekstensi untuk melihat pratinjau link dalam dokumen Google Dokumen. Untuk mengetahui detailnya, lihat Mempratinjau link dengan smart chip. |
create |
Daftar titik ekstensi untuk membuat referensi pihak ketiga dari dalam aplikasi Google Workspace. Untuk mengetahui informasi selengkapnya, lihat Membuat resource pihak ketiga dari menu @. |
DocsExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on Dokumen.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
run |
Wajib. Endpoint yang akan dieksekusi saat titik ekstensi ini diaktifkan. |
LinkPreviewExtensionPoint
Konfigurasi untuk pemicu yang diaktifkan saat pengguna mengetik atau menempelkan link dari layanan pihak ketiga atau non-Google ke file Google Dokumen, Spreadsheet, atau Slide.
Representasi JSON |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Kolom | |
---|---|
label |
Wajib. Teks untuk contoh smart chip yang meminta pengguna untuk melihat pratinjau link, seperti |
localized |
Opsional. Peta Jika lokalitas pengguna ada di kunci peta, pengguna akan melihat versi Objek yang berisi daftar pasangan |
patterns[] |
Wajib. Array pola URL yang memicu add-on untuk melihat pratinjau link. |
run |
Wajib. Endpoint yang akan dieksekusi saat pratinjau link dipicu. |
logo |
Opsional. Ikon yang ditampilkan di smart chip dan kartu pratinjau. Jika dihapus, add-on akan menggunakan ikon toolbar, |
UriPattern
Konfigurasi untuk setiap pola URL yang memicu pratinjau link.
Representasi JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Kolom | |
---|---|
host |
Diperlukan untuk setiap pola URL agar dapat dipratinjau. Domain pola URL. Add-on ini melihat pratinjau link yang berisi domain ini di URL. Untuk melihat pratinjau link untuk subdomain tertentu, seperti Misalnya, |
path |
Opsional. Jalur yang menambahkan domain Misalnya, jika pola host URL adalah Untuk mencocokkan semua URL di domain pola host, biarkan |
CreateActionExtensionPoint
Konfigurasi untuk pemicu yang diaktifkan saat pengguna memanggil alur kerja pembuatan resource di aplikasi Google Workspace. Untuk mengetahui informasi selengkapnya, lihat Membuat resource pihak ketiga dari menu @.
Representasi JSON |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
Kolom | |
---|---|
id |
Wajib. ID unik untuk membedakan titik ekstensi ini. ID dapat berisi hingga 64 karakter dan harus dalam format |
label |
Wajib. Teks yang ditampilkan di samping ikon untuk titik entri pembuatan resource, seperti |
localized |
Opsional. Peta Jika lokalitas pengguna ada di kunci peta, pengguna akan melihat versi Objek yang berisi daftar pasangan |
run |
Wajib. Endpoint yang akan dijalankan saat alur kerja pembuatan resource dipicu untuk membuat penautan. |
logo |
Opsional. Ikon yang menampilkan titik entri pembuatan resource. Jika dihapus, menu akan menggunakan ikon toolbar add-on Anda, |
SheetsAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Google Spreadsheet.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepage |
Jika ada, konfigurasi ini akan menggantikan konfigurasi dari |
on |
Endpoint yang akan dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini. |
link |
Daftar titik ekstensi untuk melihat pratinjau link dalam dokumen Google Spreadsheet. Untuk mengetahui detailnya, lihat Melihat pratinjau link dengan smart chip. |
SheetsExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on Spreadsheet.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
run |
Wajib. Endpoint yang akan dieksekusi saat titik ekstensi ini diaktifkan. |
SlidesAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Google Slide.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepage |
Jika ada, konfigurasi ini akan menggantikan konfigurasi dari |
on |
Endpoint yang akan dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini. |
link |
Daftar titik ekstensi untuk melihat pratinjau link dalam dokumen Google Slide. Untuk mengetahui detailnya, lihat Melihat pratinjau link dengan smart chip. |
SlidesExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on Slide.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
run |
Wajib. Endpoint yang akan dieksekusi saat titik ekstensi ini diaktifkan. |
HttpOptions
Opsi untuk mengirim permintaan ke endpoint HTTP
add-on.
Representasi JSON |
---|
{
"authorizationHeader": enum ( |
Kolom | |
---|---|
authorization |
Konfigurasi untuk token yang dikirim di header Otorisasi |
HttpAuthorizationHeader
Header otorisasi yang dikirim dalam permintaan HTTP
add-on.
Enum | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Nilai default, setara dengan SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Mengirim token ID untuk akun layanan sistem Add-on Google Workspace khusus project (default). |
USER_ID_TOKEN |
Kirim token ID untuk pengguna akhir. |
NONE |
Jangan kirim header Autentikasi. |
Metode |
|
---|---|
|
Membuat deployment dengan nama dan konfigurasi yang ditentukan. |
|
Menghapus deployment yang diberi nama. |
|
Mendapatkan deployment dengan nama yang ditentukan. |
|
Mendapatkan status penginstalan deployment pengujian. |
|
Menginstal deployment ke akun Anda untuk pengujian. |
|
Mencantumkan semua deployment dalam project tertentu. |
|
Membuat atau mengganti deployment dengan nama yang ditentukan. |
|
Meng-uninstal deployment pengujian dari akun pengguna. |