Package google.apps.script.type

Indeks

AddOnWidgetSet

Subset widget yang digunakan oleh add-on.

Kolom
usedWidgets[]

WidgetType

Daftar widget yang digunakan dalam add-on.

WidgetType

Jenis widget. WIDGET_TYPE_UNSPECIFIED adalah set widget dasar.

Enum
WIDGET_TYPE_UNSPECIFIED Set widget default.
DATE_PICKER Pemilih tanggal.
STYLED_BUTTONS Tombol yang diberi gaya mencakup tombol terisi dan tombol yang dinonaktifkan.
PERSISTENT_FORMS Formulir persisten memungkinkan nilai formulir tetap ada selama tindakan.
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 tulis add-on.

CommonAddOnManifest

Konfigurasi add-on yang dibagikan 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 dalam add-on. Jika kolom ini tidak ditentukan, set 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 apa pun yang dihasilkan oleh fungsi ini akan selalu tersedia bagi pengguna, tetapi mungkin tertutup oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih bertarget.

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 endpoint yang akan 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 tidak menyertakan skema, HTTPS diasumsikan. Link HTTP akan otomatis ditulis ulang menjadi link HTTPS.

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

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 bersama 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 dalam ISO 639 dan negara/wilayah dalam ISO 3166, yang 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 dieksekusi saat alur kerja pembuatan resource dipicu untuk membuat link.

logoUrl

string

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

GranularOauthPermissionSupport

Apakah add-on telah mengaktifkan Izin OAuth Terperinci.

Enum
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Nilai default, tidak boleh digunakan.
OPT_IN Add-on diizinkan untuk menggunakan Izin OAuth Terperinci.
OPT_OUT Add-on tidak menggunakan Izin OAuth Terperinci.

HomepageExtensionPoint

Format umum untuk mendeklarasikan tampilan halaman beranda add-on.

Kolom
runFunction

string

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

enabled

BoolValue

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

Nilai defaultnya adalah true jika tidak ditetapkan.

Jika tampilan halaman beranda kustom add-on dinonaktifkan, kartu ringkasan umum akan diberikan kepada 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 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 mengirim header Autentikasi.

HttpOptions

Opsi untuk mengirim permintaan ke endpoint HTTP add-on.

Kolom
authorizationHeader

HttpAuthorizationHeader

Konfigurasi untuk token yang dikirim di header Otorisasi HTTP.

granularOauthPermissionSupport

GranularOauthPermissionSupport

Apakah add-on telah mengaktifkan Izin OAuth Terperinci.

LayoutProperties

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

Kolom
primaryColor

string

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

secondaryColor

string

Warna sekunder add-on. Menetapkan warna tombol. Jika warna primer ditetapkan, tetapi tidak ada warna sekunder yang ditetapkan, warna sekunder akan sama dengan warna primer. Jika warna primer maupun warna sekunder tidak disetel, nilai default yang disediakan oleh framework akan digunakan.

useNewMaterialDesign
(deprecated)

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 chip smart 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 dalam ISO 639 dan negara/wilayah dalam ISO 3166, yang 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 dieksekusi saat pratinjau link dipicu.

logoUrl

string

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

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

Kolom
runFunction

string

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

label

string

Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan yang dilakukan dengan mengaktifkan titik ekstensi ini. Misalnya, "Masukkan faktur".

logoUrl

string

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

Jika tidak disetel, defaultnya adalah URL logo utama add-on.

UniversalActionExtensionPoint

Format untuk mendeklarasikan titik ekstensi item menu tindakan universal.

Kolom
label

string

Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan yang dilakukan dengan mengaktifkan titik ekstensi ini, misalnya, "Tambahkan kontak baru".

Kolom union action_type. Wajib. Jenis tindakan yang didukung pada item menu tindakan universal. Tindakan ini dapat berupa link untuk dibuka atau endpoint untuk dieksekusi. action_type hanya dapat berupa salah satu dari berikut:
runFunction

string

Endpoint yang akan dijalankan oleh UniversalAction.

UriPattern

Konfigurasi untuk setiap pola URL yang memicu pratinjau link.

Kolom
hostPattern

string

Wajib diisi untuk setiap pola URL yang akan dipratinjau. Domain pola URL. Add-on ini akan melihat pratinjau link yang berisi domain ini di URL. Untuk melihat pratinjau link untuk subdomain tertentu, seperti subdomain.example.com, sertakan subdomain. Untuk 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, untuk mencocokkan URL untuk kasus yang dihosting di support.example.com/cases/, masukkan cases.

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