Package google.apps.script.type

Indeks

AddOnWidgetSet

Subset widget yang digunakan oleh add-on.

Kolom
usedWidgets[]

WidgetType

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.
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.

CommonAddOnManifest

Konfigurasi add-on yang digunakan bersama di semua aplikasi host add-on.

Kolom
name

string

Wajib. Nama tampilan add-on.

logoUrl

string

Wajib. URL untuk gambar logo yang ditampilkan di toolbar add-on.

layoutProperties

LayoutProperties

Properti tata letak umum untuk kartu add-on.

addOnWidgetSet

AddOnWidgetSet

Widget yang digunakan di add-on. Jika kolom ini tidak ditentukan, kumpulan default akan digunakan.

useLocaleFromApp

bool

Apakah akan meneruskan informasi lokalitas dari aplikasi host.

homepageTrigger

HomepageExtensionPoint

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[]

UniversalActionExtensionPoint

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

ListValue

Tindakan OpenLink hanya dapat menggunakan URL dengan skema HTTPS, MAILTO, atau TEL. Untuk link HTTPS, URL juga harus cocok dengan salah satu awalan yang ditentukan dalam daftar yang diizinkan. Jika awalan menghilangkan skema, HTTPS diasumsikan. Link HTTP secara otomatis ditulis ulang menjadi link HTTPS.

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 @.

Kolom
id

string

Wajib. ID unik untuk membedakan titik ekstensi ini. ID dapat berisi hingga 64 karakter dan harus dalam format [a-zA-Z0-9-]+.

labelText

string

Wajib. Teks yang ditampilkan di samping ikon untuk titik entri pembuatan resource, seperti Create support case. Teks ini bersifat statis dan ditampilkan sebelum pengguna menjalankan add-on.

localizedLabelText

map<string, string>

Opsional. Peta labelText untuk dilokalkan ke bahasa lain. Format bahasa di ISO 639 dan negara/wilayah dalam ISO 3166, dipisahkan dengan tanda hubung -. Misalnya, en-US.

Jika lokalitas pengguna ada di kunci peta, pengguna akan melihat versi labelText yang dilokalkan.

runFunction

string

Wajib. Endpoint yang akan dijalankan saat alur kerja pembuatan resource dipicu untuk membuat link.

logoUrl

string

Opsional. Ikon yang ditampilkan untuk titik entri pembuatan resource. Jika dihilangkan, menu akan menggunakan ikon toolbar add-on, logoUrl.

HomepageExtensionPoint

Format umum untuk mendeklarasikan tampilan halaman beranda add-on.

Kolom
runFunction

string

Wajib. Endpoint yang akan dijalankan saat titik ekstensi ini diaktifkan.

enabled

BoolValue

Opsional. Jika disetel ke false, tampilan halaman beranda akan dinonaktifkan dalam konteks ini.

Jika tidak ditetapkan, setelan default-nya adalah true.

Jika tampilan halaman beranda kustom add-on dinonaktifkan, kartu ringkasan umum akan diberikan untuk pengguna.

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.

HttpOptions

Opsi untuk mengirim permintaan ke endpoint HTTP add-on.

Kolom
authorizationHeader

HttpAuthorizationHeader

Konfigurasi untuk token yang dikirim di header Otorisasi HTTP.

LayoutProperties

Properti tata letak kartu yang dibagikan ke semua aplikasi host add-on.

Kolom
primaryColor

string

Warna primer add-on. Menetapkan warna toolbar. Jika tidak ada warna utama yang ditetapkan, nilai default yang disediakan oleh framework akan digunakan.

secondaryColor

string

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

bool

Mengaktifkan desain material untuk kartu.

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.

Kolom
labelText

string

Wajib. Teks untuk contoh smart chip yang meminta pengguna melihat pratinjau link, seperti Example: Support case. Teks ini bersifat statis dan ditampilkan sebelum pengguna menjalankan add-on.

localizedLabelText

map<string, string>

Opsional. Peta labelText untuk dilokalkan ke bahasa lain. Format bahasa di ISO 639 dan negara/wilayah dalam ISO 3166, dipisahkan dengan tanda hubung -. Misalnya, en-US.

Jika lokalitas pengguna ada di kunci peta, pengguna akan melihat versi labelText yang dilokalkan.

patterns[]

UriPattern

Wajib. Array pola URL yang memicu add-on untuk melihat pratinjau link.

runFunction

string

Wajib. Endpoint yang akan dijalankan saat pratinjau link dipicu.

logoUrl

string

Opsional. Ikon yang ditampilkan di smart chip dan kartu pratinjau. Jika dihilangkan, add-on akan menggunakan ikon toolbar, logoUrl.

Format umum untuk mendeklarasikan item menu atau tombol yang muncul dalam aplikasi host.

Kolom
runFunction

string

Wajib. Endpoint yang akan dijalankan saat titik ekstensi ini diaktifkan.

label

string

Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan yang diambil dengan mengaktifkan titik ekstensi ini. Misalnya, "Sisipkan invoice".

logoUrl

string

URL untuk gambar logo yang ditampilkan di toolbar add-on.

Jika tidak disetel, URL logo utama add-on akan ditetapkan secara default.

UniversalActionExtensionPoint

Format untuk mendeklarasikan titik ekstensi item menu tindakan universal.

Kolom
label

string

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:
runFunction

string

Endpoint yang akan dijalankan oleh UniversalAction.

UriPattern

Konfigurasi untuk setiap pola URL yang memicu pratinjau link.

Kolom
hostPattern

string

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 subdomain.example.com, sertakan subdomain tersebut. Guna melihat pratinjau link untuk seluruh domain, tentukan karakter pengganti dengan tanda bintang (*) sebagai subdomain.

Misalnya, *.example.com cocok dengan subdomain.example.com dan another.subdomain.example.com.

pathPrefix

string

Opsional. Jalur yang menambahkan domain hostPattern.

Misalnya, jika pola host URL adalah support.example.com, agar cocok dengan URL untuk kasus yang dihosting di support.example.com/cases/, masukkan cases.

Untuk mencocokkan semua URL di domain pola host, biarkan pathPrefix kosong.