- 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: |
oauthScopes[] |
Daftar cakupan Google OAuth yang akan meminta izin dari pengguna akhir sebelum menjalankan endpoint add-on. |
addOns |
Konfigurasi Add-on Google Workspace. |
etag |
Nilai ini dihitung oleh server berdasarkan versi deployment dalam penyimpanan, dan dapat dikirim pada saat permintaan update 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. |
httpOptions |
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. |
logoUrl |
Wajib. URL untuk gambar logo yang ditampilkan di toolbar add-on. |
layoutProperties |
Properti tata letak umum untuk kartu add-on. |
addOnWidgetSet |
Widget yang digunakan di add-on. Jika kolom ini tidak ditentukan, kumpulan default akan digunakan. |
useLocaleFromApp |
Apakah akan meneruskan informasi lokalitas dari aplikasi host. |
homepageTrigger |
Menentukan endpoint yang akan dieksekusi dalam konteks apa pun, di host mana pun. Kartu yang dihasilkan oleh fungsi ini akan selalu tersedia bagi pengguna, namun mungkin terhalang oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih ditargetkan. |
universalActions[] |
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 titik akhir untuk dieksekusi sebagai pengiriman formulir. |
openLinkUrlPrefixes |
Tindakan OpenLink hanya dapat menggunakan URL dengan skema |
LayoutProperties
Properti tata letak kartu yang dibagikan ke semua aplikasi host add-on.
Representasi JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Kolom | |
---|---|
primaryColor |
Warna primer add-on. Menetapkan warna toolbar. Jika tidak ada warna utama yang ditetapkan, nilai default yang disediakan oleh framework akan digunakan. |
secondaryColor |
Warna sekunder add-on. Menetapkan warna tombol. Jika warna primer telah ditetapkan, tetapi warna sekunder tidak ditetapkan, warna sekunder sama dengan warna primer. Jika warna primer atau warna sekunder tidak ditetapkan, nilai default yang disediakan oleh framework akan digunakan. |
useNewMaterialDesign |
Mengaktifkan desain material untuk kartu. |
AddOnWidgetSet
Subset widget yang digunakan oleh add-on.
Representasi JSON |
---|
{
"usedWidgets": [
enum ( |
Kolom | |
---|---|
usedWidgets[] |
Daftar widget yang digunakan pada add-on. |
WidgetType
Jenis widget. WIDGET_TYPE_UNSPECIFIED
adalah kumpulan widget dasar.
Enum | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
Widget default ditetapkan. |
DATE_PICKER |
Pemilih tanggal. |
STYLED_BUTTONS |
Tombol bergaya berisi tombol yang terisi dan tombol yang dinonaktifkan. |
PERSISTENT_FORMS |
Bentuk persisten memungkinkan nilai formulir dipertahankan selama tindakan. |
FIXED_FOOTER |
Perbaikan footer di kartu. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Perbarui subjek dan penerima draf. |
GRID_WIDGET |
Widget petak. |
ADDON_COMPOSE_UI_ACTION |
Tindakan add-on Gmail yang berlaku untuk UI Compose add-on. |
HomepageExtensionPoint
Format umum untuk mendeklarasikan tampilan halaman beranda add-on.
Representasi JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Kolom | |
---|---|
runFunction |
Wajib. Endpoint yang akan dijalankan saat titik ekstensi ini diaktifkan. |
enabled |
Opsional. Jika disetel ke Jika tidak ditetapkan, setelan default-nya adalah 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. Link ini dapat berupa link ke halaman untuk dibuka atau endpoint untuk dijalankan. action_type hanya ada berupa salah satu diantara berikut: |
|
openLink |
URL yang akan dibuka oleh UniversalAction. |
runFunction |
Endpoint yang akan dijalankan oleh UniversalAction. |
GmailAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Gmail.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepageTrigger |
Menentukan endpoint yang akan dijalankan dalam konteks yang tidak sesuai dengan pemicu kontekstual yang dideklarasikan. Kartu yang dihasilkan oleh fungsi ini akan selalu tersedia bagi pengguna, namun dapat digantikan oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih bertarget. Jika ada, ini akan mengganti konfigurasi dari |
contextualTriggers[] |
Menentukan kumpulan kondisi yang memicu add-on. |
universalActions[] |
Menentukan serangkaian tindakan universal untuk add-on. Pengguna memicu tindakan universal dari menu toolbar add-on. |
composeTrigger |
Menentukan pemicu waktu Compose untuk add-on waktu Compose. Ini adalah pemicu yang menyebabkan add-on mengambil tindakan saat pengguna menulis email. Semua add-on waktu penulisan harus memiliki cakupan |
authorizationCheckFunction |
Nama endpoint yang memverifikasi bahwa add-on memiliki semua otorisasi pihak ketiga yang diperlukan dengan memeriksa API pihak ketiga. Jika pemeriksaan gagal, fungsi tersebut akan menampilkan pengecualian untuk memulai alur otorisasi. Fungsi ini dipanggil sebelum setiap panggilan add-on untuk memastikan pengalaman pengguna yang lancar. |
ContextualTrigger
Menentukan pemicu yang diaktifkan saat email yang terbuka memenuhi kriteria tertentu. Saat diaktifkan, pemicu akan mengeksekusi endpoint tertentu, biasanya untuk membuat kartu baru dan mengupdate UI.
Representasi JSON |
---|
{ "onTriggerFunction": string, // Union field |
Kolom | |
---|---|
onTriggerFunction |
Wajib. Nama endpoint yang akan dipanggil jika pesan cocok dengan pemicu. |
Kolom union trigger . Jenis pemicu menentukan kondisi yang digunakan Gmail untuk menampilkan add-on. trigger hanya ada berupa salah satu diantara berikut: |
|
unconditional |
Pemicu tanpa syarat dijalankan saat pesan email apa pun dibuka. |
UnconditionalTrigger
Jenis ini tidak memiliki kolom.
Pemicu yang diaktifkan saat pesan email apa pun dibuka.
UniversalAction
Tindakan yang selalu tersedia di menu toolbar add-on, apa pun konteks pesannya.
Representasi JSON |
---|
{ "text": string, // Union field |
Kolom | |
---|---|
text |
Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan, misalnya, "Tambahkan kontak baru". |
Kolom union action_type . Jenis tindakan menentukan perilaku Gmail saat pengguna memanggil tindakan. action_type hanya ada berupa salah satu diantara berikut: |
|
openLink |
Link yang dibuka oleh Gmail saat pengguna memicu tindakan. |
runFunction |
Endpoint yang dipanggil saat pengguna memicu tindakan. Lihat panduan tindakan universal untuk mengetahui detailnya. |
ComposeTrigger
Pemicu yang aktif 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 di add-on waktu penulisan. |
draftAccess |
Menentukan tingkat akses data saat add-on waktu tulis dipicu. |
MenuItemExtensionPoint
Format umum untuk mendeklarasikan item menu atau tombol yang muncul dalam aplikasi host.
Representasi JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Kolom | |
---|---|
runFunction |
Wajib. Endpoint yang akan dijalankan saat titik ekstensi ini diaktifkan. |
label |
Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan yang diambil dengan mengaktifkan titik ekstensi ini. Misalnya, "Sisipkan invoice". |
logoUrl |
URL untuk gambar logo yang ditampilkan di toolbar add-on. Jika tidak disetel, URL logo utama add-on akan ditetapkan secara default. |
DraftAccess
Enum yang menentukan tingkat akses data yang diperlukan oleh pemicu compose.
Enum | |
---|---|
UNSPECIFIED |
Nilai default jika tidak ada yang ditetapkan untuk akses draf. |
NONE |
Pemicu Compose tidak dapat mengakses data draf apa pun saat add-on Compose dipicu. |
METADATA |
Memberi pemicu penulisan izin untuk mengakses metadata draf saat add-on tulis 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 | |
---|---|
homepageTrigger |
Jika ada, ini akan mengganti konfigurasi dari |
onItemsSelectedTrigger |
Sesuai dengan perilaku yang dijalankan saat item dipilih dalam tampilan Drive yang relevan, seperti Daftar Dokumen Drive Saya. |
DriveExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on Drive.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
runFunction |
Wajib. Endpoint yang akan dijalankan saat titik ekstensi diaktifkan. |
CalendarAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Kalender.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepageTrigger |
Menentukan endpoint yang dijalankan dalam konteks yang tidak cocok dengan pemicu kontekstual yang dideklarasikan. Kartu yang dihasilkan oleh fungsi ini akan selalu tersedia bagi pengguna, namun mungkin terhalang oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih ditargetkan. Jika ada, ini akan mengganti konfigurasi dari |
conferenceSolution[] |
Mendefinisikan solusi konferensi yang disediakan oleh add-on ini. |
createSettingsUrlFunction |
Endpoint untuk dijalankan yang membuat URL ke halaman setelan add-on. |
eventOpenTrigger |
Endpoint yang terpicu saat peristiwa dibuka untuk dilihat atau diedit. |
eventUpdateTrigger |
Endpoint yang terpicu saat peristiwa terbuka diperbarui. |
currentEventAccess |
Menentukan tingkat akses data saat add-on peristiwa dipicu. |
ConferenceSolution
Mendefinisikan nilai terkait konferensi.
Representasi JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Kolom | |
---|---|
onCreateFunction |
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 tidak boleh diubah. |
name |
Wajib. Nama tampilan solusi konferensi. |
logoUrl |
Wajib. URL untuk gambar logo solusi konferensi. |
CalendarExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on kalender.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
runFunction |
Wajib. Endpoint yang akan dijalankan saat titik ekstensi ini diaktifkan. |
EventAccess
Enum yang menentukan tingkat yang diperlukan oleh pemicu peristiwa akses data.
Enum | |
---|---|
UNSPECIFIED |
Nilai default jika tidak ada yang ditetapkan untuk eventAccess. |
METADATA |
Memberi pemicu izin untuk mengakses metadata acara, seperti ID acara dan ID kalender. |
READ |
Memberi pemicu acara akses ke semua kolom acara yang disediakan termasuk metadata, tamu, dan data konferensi. |
WRITE |
Memberi pemicu acara akses ke metadata acara dan kemampuan untuk melakukan semua tindakan, termasuk menambahkan tamu dan menyetel data konferensi. |
READ_WRITE |
Memberi pemicu acara akses ke semua kolom acara 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 | |
---|---|
homepageTrigger |
Jika ada, ini akan mengganti konfigurasi dari |
onFileScopeGrantedTrigger |
Endpoint untuk dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini. |
linkPreviewTriggers[] |
Daftar titik ekstensi untuk melihat pratinjau link dalam dokumen Google Dokumen. Untuk mengetahui detailnya, lihat Melihat pratinjau link dengan smart chip. |
createActionTriggers[] |
Daftar poin ekstensi untuk membuat resource pihak ketiga dari dalam aplikasi Google Workspace. Untuk informasi selengkapnya, lihat Membuat resource pihak ketiga dari menu @. |
DocsExtensionPoint
Format umum untuk mendeklarasikan pemicu add-on Dokumen.
Representasi JSON |
---|
{ "runFunction": string } |
Kolom | |
---|---|
runFunction |
Wajib. Endpoint yang akan dijalankan 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 | |
---|---|
labelText |
Wajib. Teks untuk contoh smart chip yang meminta pengguna melihat pratinjau link, seperti |
localizedLabelText |
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. |
runFunction |
Wajib. Endpoint yang akan dijalankan saat pratinjau link dipicu. |
logoUrl |
Opsional. Ikon yang ditampilkan di smart chip dan kartu pratinjau. Jika dihilangkan, add-on akan menggunakan ikon toolbar, |
UriPattern
Konfigurasi untuk setiap pola URL yang memicu pratinjau link.
Representasi JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Kolom | |
---|---|
hostPattern |
Diperlukan untuk setiap pola URL agar dapat dipratinjau. Domain pola URL. Add-on mempratinjau link yang berisi domain ini di URL. Guna melihat pratinjau link untuk subdomain tertentu, seperti Misalnya, |
pathPrefix |
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 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 |
labelText |
Wajib. Teks yang ditampilkan di samping ikon untuk titik entri pembuatan resource, seperti |
localizedLabelText |
Opsional. Peta Jika lokalitas pengguna ada di kunci peta, pengguna akan melihat versi Objek yang berisi daftar pasangan |
runFunction |
Wajib. Endpoint yang akan dijalankan saat alur kerja pembuatan resource dipicu untuk membuat link. |
logoUrl |
Opsional. Ikon yang ditampilkan untuk titik entri pembuatan resource. Jika dihilangkan, menu akan menggunakan ikon toolbar add-on, |
SheetsAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Google Spreadsheet.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepageTrigger |
Jika ada, ini akan mengganti konfigurasi dari |
onFileScopeGrantedTrigger |
Endpoint untuk dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini. |
linkPreviewTriggers[] |
Daftar titik ekstensi untuk melihat pratinjau link di 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 | |
---|---|
runFunction |
Wajib. Endpoint yang akan dijalankan saat titik ekstensi ini diaktifkan. |
SlidesAddOnManifest
Properti yang menyesuaikan tampilan dan eksekusi add-on Google Slide.
Representasi JSON |
---|
{ "homepageTrigger": { object ( |
Kolom | |
---|---|
homepageTrigger |
Jika ada, ini akan mengganti konfigurasi dari |
onFileScopeGrantedTrigger |
Endpoint untuk dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini. |
linkPreviewTriggers[] |
Daftar titik ekstensi untuk melihat pratinjau link di 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 | |
---|---|
runFunction |
Wajib. Endpoint yang akan dijalankan saat titik ekstensi ini diaktifkan. |
HttpOptions
Opsi untuk mengirim permintaan ke endpoint HTTP
add-on.
Representasi JSON |
---|
{
"authorizationHeader": enum ( |
Kolom | |
---|---|
authorizationHeader |
Konfigurasi untuk token yang dikirim di header Otorisasi |
HttpAuthorizationHeader
Header otorisasi dikirim dalam permintaan HTTP
add-on.
Enum | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Nilai default, setara dengan SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Kirim 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 Authentication. |
Metode |
|
---|---|
|
Membuat deployment dengan nama dan konfigurasi yang ditentukan. |
|
Menghapus deployment dengan nama yang diberikan. |
|
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. |