REST Resource: projects.deployments

Resource: Deployment

Deployment add-on Google Workspace

Representasi JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Kolom
name

string

Nama resource deployment. Contoh: projects/123/deployments/my_deployment.
oauthScopes[]

string

Daftar cakupan OAuth Google yang memerlukan izin dari pengguna akhir sebelum menjalankan endpoint add-on.
addOns

object (AddOns)

Konfigurasi add-on Google Workspace.
etag

string

Nilai ini dihitung oleh server berdasarkan versi deployment dalam penyimpanan, dan dapat dikirim pada permintaan update dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.

AddOns

Konfigurasi add-on Google Workspace.

Representasi JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Kolom
common

object (CommonAddOnManifest)

Konfigurasi yang umum di semua add-on Google Workspace.
gmail

object (GmailAddOnManifest)

Konfigurasi add-on Gmail.
drive

object (DriveAddOnManifest)

Konfigurasi add-on Drive.
calendar

object (CalendarAddOnManifest)

Konfigurasi add-on Kalender.
docs

object (DocsAddOnManifest)

Konfigurasi add-on Dokumen.
meet

object (MeetAddOnManifest)

Konfigurasi add-on Meet.
sheets

object (SheetsAddOnManifest)

Konfigurasi add-on Spreadsheet.
slides

object (SlidesAddOnManifest)

Konfigurasi add-on Slide.
httpOptions

object (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 (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
Kolom
name

string

Wajib. Nama tampilan add-on.
logoUrl

string

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

object (LayoutProperties)

Properti tata letak umum untuk kartu add-on.
addOnWidgetSet

object (AddOnWidgetSet)

Widget yang digunakan dalam add-on. Jika kolom ini tidak ditentukan, set default akan digunakan.
useLocaleFromApp

boolean

Apakah akan meneruskan informasi lokalitas dari aplikasi host.
homepageTrigger

object (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 akan tertutupi oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih bertarget.
universalActions[]

object (UniversalActionExtensionPoint)

Menentukan daftar titik ekstensi di menu tindakan universal yang berfungsi sebagai menu setelan untuk add-on. Titik ekstensi dapat berupa URL link yang akan dibuka atau endpoint yang akan dijalankan sebagai pengiriman formulir.
openLinkUrlPrefixes

array (ListValue format)

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 akan diasumsikan. Link HTTP otomatis ditulis ulang menjadi link HTTPS.

LayoutProperties

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

Representasi JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
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. Atribut ini menetapkan warna tombol. Jika warna utama ditetapkan, tetapi tidak ada warna sekunder yang ditetapkan, warna sekunder akan sama dengan warna utama. Jika warna primer atau warna sekunder tidak ditetapkan, nilai default yang disediakan oleh framework akan digunakan.
useNewMaterialDesign
(deprecated)

boolean

Mengaktifkan desain material untuk kartu.

AddOnWidgetSet

Subset widget yang digunakan oleh add-on.

Representasi JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Kolom
usedWidgets[]

enum (WidgetType)

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 dipertahankan 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 penulisan add-on.

HomepageExtensionPoint

Format umum untuk mendeklarasikan tampilan halaman beranda add-on.

Representasi JSON 
{
  "runFunction": string,
  "enabled": boolean
}
Kolom
runFunction

string

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

boolean

Opsional. Jika ditetapkan 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.

UniversalActionExtensionPoint

Format untuk mendeklarasikan titik ekstensi item menu tindakan universal.

Representasi JSON 
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
Kolom
label

string

Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan yang diambil dengan mengaktifkan titik ekstensi ini, misalnya, "Tambahkan kontak baru".
Wajib. Jenis tindakan yang didukung pada item menu tindakan universal. Tindakan ini dapat berupa link untuk dibuka atau endpoint untuk dieksekusi. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
runFunction

string

Endpoint yang akan dijalankan oleh UniversalAction.
Akhir kolom yang saling eksklusif.

GmailAddOnManifest

Properti yang menyesuaikan tampilan dan eksekusi add-on Gmail.

Representasi JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Kolom
homepageTrigger

object (HomepageExtensionPoint)

Menentukan endpoint yang akan dieksekusi dalam konteks yang tidak cocok dengan pemicu kontekstual yang dideklarasikan. Kartu apa pun yang dihasilkan oleh fungsi ini akan selalu tersedia bagi pengguna, tetapi mungkin akan tertutup oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih bertarget.

Jika ada, nilai ini akan menggantikan konfigurasi dari addons.common.homepageTrigger.
contextualTriggers[]

object (ContextualTrigger)

Menentukan kumpulan kondisi yang memicu add-on.
universalActions[]

object (UniversalAction)

Menentukan kumpulan tindakan universal untuk add-on. Pengguna memicu tindakan universal dari menu toolbar add-on.
composeTrigger

object (ComposeTrigger)

Menentukan pemicu waktu tulis untuk add-on waktu tulis. Ini adalah pemicu yang menyebabkan add-on mengambil tindakan saat pengguna menulis email. Semua add-on waktu tulis harus memiliki cakupan gmail.addons.current.action.compose meskipun mungkin tidak mengedit draf.
authorizationCheckFunction

string

Nama endpoint yang memverifikasi bahwa add-on memiliki semua otorisasi pihak ketiga yang diperlukan, dengan memeriksa 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 memperbarui UI.

Representasi JSON 
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Kolom
onTriggerFunction

string

Wajib. Nama endpoint yang akan dipanggil saat pesan cocok dengan pemicu.
Jenis pemicu menentukan kondisi yang digunakan Gmail untuk menampilkan add-on. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
unconditional

object (UnconditionalTrigger)

Pemicu tanpa syarat dijalankan saat pesan email dibuka.
Akhir kolom yang saling eksklusif.

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,

  "openLink": string,
  "runFunction": string
}
Kolom
text

string

Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan, misalnya, "Tambahkan kontak baru".
Jenis tindakan menentukan perilaku Gmail saat pengguna memanggil tindakan. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
runFunction

string

Endpoint yang dipanggil saat pengguna memicu tindakan. Lihat panduan tindakan universal untuk mengetahui detailnya.
Akhir kolom yang saling eksklusif.

ComposeTrigger

Pemicu yang aktif saat pengguna menulis email.

Representasi JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Kolom
actions[]

object (MenuItemExtensionPoint)

Menentukan kumpulan tindakan untuk add-on waktu tulis. Tindakan ini adalah tindakan yang dapat dipicu pengguna pada add-on waktu penulisan.
draftAccess

enum (DraftAccess)

Menentukan tingkat akses data saat add-on waktu tulis dipicu.

DraftAccess

Enum yang menentukan tingkat akses data yang diperlukan pemicu tulis.

Enum
UNSPECIFIED Nilai default jika tidak ada yang ditetapkan untuk draftaccess.
NONE Pemicu penulisan tidak dapat mengakses data draf apa pun saat add-on penulisan dipicu.
METADATA Memberi pemicu penulisan izin untuk mengakses metadata draf saat add-on penulisan dipicu. Hal ini mencakup daftar audiens, seperti daftar Kepada dan Cc pesan draf.

DriveAddOnManifest

Properti yang menyesuaikan tampilan dan eksekusi add-on Drive.

Representasi JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Kolom
homepageTrigger

object (HomepageExtensionPoint)

Jika ada, nilai ini akan menggantikan konfigurasi dari addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

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

string

Wajib. Endpoint yang akan dieksekusi saat titik ekstensi diaktifkan.

CalendarAddOnManifest

Properti yang menyesuaikan tampilan dan eksekusi add-on Kalender.

Representasi JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Kolom
homepageTrigger

object (HomepageExtensionPoint)

Opsional. Menentukan endpoint yang dijalankan dalam konteks yang tidak cocok dengan pemicu kontekstual yang dideklarasikan. Kartu apa pun yang dihasilkan oleh fungsi ini akan selalu tersedia bagi pengguna, tetapi mungkin akan tertutupi oleh konten kontekstual saat add-on ini mendeklarasikan pemicu yang lebih bertarget.

Jika ada, nilai ini akan menggantikan konfigurasi dari addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

Opsional. Menentukan solusi konferensi yang disediakan oleh add-on ini.
createSettingsUrlFunction

string

Endpoint yang akan dieksekusi yang membuat URL ke halaman setelan add-on.
eventOpenTrigger

object (CalendarExtensionPoint)

Endpoint yang dipicu saat acara dibuka untuk dilihat atau diedit.
eventUpdateTrigger

object (CalendarExtensionPoint)

Endpoint yang dipicu saat peristiwa terbuka diperbarui.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Opsional. Dipicu saat acara dibuat atau diperbarui untuk kalender yang diikuti pengguna. Hanya berlaku untuk pemicu yang dibuat oleh HTTP endpoints menggunakan CalendarSubscriptionActionMarkup.

Untuk mencegah loop notifikasi berulang, saat add-on mengubah acara Google Kalender menggunakan Calendar API dengan kredensial autentikasi dari project Google Cloud yang sama dengan yang menghosting deployment add-on, platform akan menyembunyikan notifikasi perubahan. Pemicuan mandiri panggilan API Kalender project Anda sendiri tidak didukung.

Tidak berlaku untuk Apps Script add-ons dan Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Konfigurasi untuk pemicu kontekstual yang diaktifkan saat pengguna mengklik penyedia lampiran add-on di menu dropdown Kalender.
currentEventAccess

enum (EventAccess)

Menentukan tingkat akses data saat add-on peristiwa dipicu.

ConferenceSolution

Menentukan nilai terkait konferensi.

Representasi JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Kolom
onCreateFunction

string

Wajib. Endpoint yang akan dipanggil saat data konferensi harus dibuat.
id

string

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

string

Wajib. Nama tampilan solusi konferensi.
logoUrl

string

Wajib. URL untuk gambar logo solusi konferensi.

CalendarExtensionPoint

Format umum untuk mendeklarasikan pemicu add-on kalender.

Representasi JSON 
{
  "runFunction": string
}
Kolom
runFunction

string

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

EventAccess

Enum yang menentukan tingkat akses data yang diperlukan pemicu peristiwa.

Enum
UNSPECIFIED Nilai default jika tidak ada yang ditetapkan untuk eventAccess.
METADATA Memberi pemicu acara 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 menetapkan 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 (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Kolom
homepageTrigger

object (HomepageExtensionPoint)

Jika ada, nilai ini akan menggantikan konfigurasi dari addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Endpoint yang akan dijalankan saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Daftar titik ekstensi untuk melihat pratinjau link dalam dokumen Google Dokumen. Untuk mengetahui detailnya, lihat Melihat pratinjau link dengan chip cerdas.
createActionTriggers[]

object (CreateActionExtensionPoint)

Daftar titik ekstensi untuk membuat resource 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
runFunction

string

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 (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
Kolom
labelText

string

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

map (key: string, value: string)

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

Jika lokalitas pengguna ada dalam kunci peta, pengguna akan melihat versi labeltext yang dilokalkan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
patterns[]

object (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 chip cerdas dan kartu pratinjau. Jika dihilangkan, add-on akan menggunakan ikon toolbar-nya, logourl.

UriPattern

Konfigurasi untuk setiap pola URL yang memicu pratinjau link.

Representasi JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Kolom
hostPattern

string

Diperlukan untuk setiap pola URL yang akan dipratinjau. Domain pola URL. Add-on akan melihat pratinjau link yang berisi domain ini di URL. Untuk melihat pratinjau link subdomain tertentu, seperti subdomain.example.com, sertakan subdomain tersebut. 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.

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

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 (key: string, value: string)

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

Jika lokalitas pengguna ada dalam kunci peta, pengguna akan melihat versi labeltext yang dilokalkan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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 Anda, logourl.

MeetAddOnManifest

Manifes add-on Meet.

Representasi JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Kolom
homepageTrigger

object (HomepageExtensionPoint)

Jika ada, nilai ini akan menggantikan konfigurasi dari addons.common.homepageTrigger.
web

object (Web)

Detail untuk add-on yang meningkatkan kualitas klien web Meet.
supportsCollaboration

boolean

Apakah add-on mendukung kolaborasi atau mengundang orang lain ke pengalaman add-on.
termsUri

string

Link ke persyaratan layanan untuk add-on, jika ada yang harus ditampilkan.

Web

Detail untuk add-on yang meningkatkan kualitas klien web Meet.

Representasi JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
Kolom
sidePanelUri
(deprecated)

string

URI untuk iframe panel samping.
sidePanelUrl

string

URL untuk iframe panel samping.
mainStageUri
(deprecated)

string

URI untuk iframe "panggung utama".
supportsScreenSharing

boolean

Apakah add-on mendukung berbagi layar di panggung utama.
supportsCollaboration
(deprecated)

boolean

Apakah add-on mendukung kolaborasi atau mengundang orang lain ke pengalaman add-on. Kolom ini tidak digunakan lagi, gunakan kolom tingkat teratas di MeetAddOnManifest.
supportsPopOut

boolean

Apakah add-on mendukung pop-out ke pengalaman PiP browser.
hostOrigins[]
(deprecated)

string

Nama lama yang tidak digunakan lagi. Origin yang harus ditambahkan ke properti frame-src iframe yang berisi situs pihak ketiga. Gunakan addonorigins sebagai gantinya.
addOnOrigins[]

string

Origin yang harus ditambahkan ke properti frame-src iframe yang berisi situs pihak ketiga.
openState

enum (State)

Status awal saat add-on dibuka.
supportsCollaborationHostControls

boolean

Apakah add-on kolaborasi mendukung kontrol penyelenggara.
logoUrl

string

URL logo yang akan ditampilkan untuk add-on. Jika tidak ditentukan, logo akan ditetapkan secara default ke logo di bagian umum manifes.
darkModeLogoUrl

string

Versi mode gelap dari logourl.
displayFlow
(deprecated)

enum (DisplayFlow)

Alur tampilan yang akan diikuti add-on saat diluncurkan.

Negara Bagian

Enum untuk menentukan status pembukaan awal add-on.

Enum
STATE_UNSPECIFIED Status awal belum ditentukan dengan add-on.
SIDE_PANEL_ONLY Add-on akan terbuka dengan hanya panel samping yang aktif.
MAIN_STAGE_ONLY Add-on akan terbuka dengan hanya layar utama yang aktif.
SIDE_PANEL_AND_MAIN_STAGE Add-on akan terbuka dengan panel samping dan layar utama aktif.

DisplayFlow

Enum untuk menentukan alur tampilan yang akan diikuti add-on saat diluncurkan

Enum
DISPLAY_FLOW_UNSPECIFIED Alur tampilan belum ditentukan.
FOCUS Add-on harus diluncurkan dalam alur tampilan "fokus".
AUGMENT Add-on harus diluncurkan dalam alur tampilan "augment".

SheetsAddOnManifest

Properti yang menyesuaikan tampilan dan eksekusi add-on Google Spreadsheet.

Representasi JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Kolom
homepageTrigger

object (HomepageExtensionPoint)

Jika ada, nilai ini akan menggantikan konfigurasi dari addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Endpoint yang akan dijalankan saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Daftar titik ekstensi untuk melihat pratinjau link di dokumen Google Spreadsheet. Untuk mengetahui detailnya, lihat Melihat pratinjau link dengan chip cerdas.

SheetsExtensionPoint

Format umum untuk mendeklarasikan pemicu add-on Spreadsheet.

Representasi JSON 
{
  "runFunction": string
}
Kolom
runFunction

string

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 (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Kolom
homepageTrigger

object (HomepageExtensionPoint)

Jika ada, nilai ini akan menggantikan konfigurasi dari addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Endpoint yang akan dijalankan saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Daftar titik ekstensi untuk melihat pratinjau link dalam dokumen Google Slide. Untuk mengetahui detailnya, lihat Melihat pratinjau link dengan chip cerdas.

SlidesExtensionPoint

Format umum untuk mendeklarasikan pemicu add-on Slide.

Representasi JSON 
{
  "runFunction": string
}
Kolom
runFunction

string

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

HttpOptions

Opsi untuk mengirim permintaan ke endpoint HTTP add-on.

Representasi JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Kolom
authorizationHeader

enum (HttpAuthorizationHeader)

Konfigurasi untuk token yang dikirim di header Authorization HTTP.
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

Apakah add-on telah mengaktifkan Izin OAuth Terperinci.

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 mengirim header Authentication.

GranularOauthPermissionSupport

Apakah add-on telah mengaktifkan Izin OAuth Terperinci.

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

Metode

create

 Membuat deployment dengan nama dan konfigurasi yang ditentukan.

delete

 Menghapus deployment dengan nama yang diberikan.

get

 Mendapatkan deployment dengan nama yang ditentukan.

getInstallStatus

 Mendapatkan status penginstalan deployment pengujian.

install

 Menginstal deployment ke akun Anda untuk pengujian.

list

 Mencantumkan semua deployment dalam project tertentu.

replaceDeployment

 Membuat atau mengganti deployment dengan nama yang ditentukan.

uninstall

 Meng-uninstal deployment pengujian dari akun pengguna.