REST Resource: projects.deployments

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

string

Nama resource deployment. Contoh: projects/123/deployments/my_deployment.

string

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

object (AddOns)

Konfigurasi Add-on Google Workspace.

string

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.

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

object (CommonAddOnManifest)

Konfigurasi yang umum di semua Add-on Google Workspace.

object (GmailAddOnManifest)

Konfigurasi add-on Gmail.

object (DriveAddOnManifest)

Konfigurasi add-on Drive.

object (CalendarAddOnManifest)

Konfigurasi add-on Kalender.

object (DocsAddOnManifest)

Konfigurasi add-on Dokumen.

object (SheetsAddOnManifest)

Konfigurasi add-on Spreadsheet.

object (SlidesAddOnManifest)

Konfigurasi add-on Slide.

object (HttpOptions)

Opsi untuk mengirim permintaan ke endpoint HTTP add-on

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

Wajib. Nama tampilan add-on.

string

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

object (LayoutProperties)

Properti tata letak umum untuk kartu add-on.

object (AddOnWidgetSet)

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

boolean

Apakah akan meneruskan informasi lokalitas dari aplikasi host.

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

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

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

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

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

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.

boolean

Mengaktifkan desain material untuk kartu.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

Daftar widget yang digunakan pada add-on.

{
  "runFunction": string,
  "enabled": boolean
}

string

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

boolean

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.

{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

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

string

URL yang akan dibuka oleh UniversalAction.

string

Endpoint yang akan dijalankan oleh UniversalAction.

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

object (HomepageExtensionPoint)

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 addons.common.homepageTrigger.

object (ContextualTrigger)

Menentukan kumpulan kondisi yang memicu add-on.

object (UniversalAction)

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

object (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 gmail.addons.current.action.compose meskipun mungkin tidak mengedit draf.

string

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.

{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}

string

Wajib. Nama endpoint yang akan dipanggil jika pesan cocok dengan pemicu.

object (UnconditionalTrigger)

Pemicu tanpa syarat dijalankan saat pesan email apa pun dibuka.

{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Wajib. Teks yang terlihat oleh pengguna yang menjelaskan tindakan, misalnya, "Tambahkan kontak baru".

string

Link yang dibuka oleh Gmail saat pengguna memicu tindakan.

string

Endpoint yang dipanggil saat pengguna memicu tindakan. Lihat panduan tindakan universal untuk mengetahui detailnya.

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

object (MenuItemExtensionPoint)

Menentukan kumpulan tindakan untuk add-on waktu penulisan. Ini adalah tindakan yang dapat dipicu pengguna di add-on waktu penulisan.

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

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

string

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

string

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

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

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

object (HomepageExtensionPoint)

Jika ada, ini akan mengganti konfigurasi dari addons.common.homepageTrigger.

object (DriveExtensionPoint)

Sesuai dengan perilaku yang dijalankan saat item dipilih dalam tampilan Drive yang relevan, seperti Daftar Dokumen Drive Saya.

{
  "runFunction": string
}

string

Wajib. Endpoint yang akan dijalankan saat titik ekstensi diaktifkan.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

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 addons.common.homepageTrigger.

object (ConferenceSolution)

Mendefinisikan solusi konferensi yang disediakan oleh add-on ini.

string

Endpoint untuk dijalankan yang membuat URL ke halaman setelan add-on.

object (CalendarExtensionPoint)

Endpoint yang terpicu saat peristiwa dibuka untuk dilihat atau diedit.

object (CalendarExtensionPoint)

Endpoint yang terpicu saat peristiwa terbuka diperbarui.

enum (EventAccess)

Menentukan tingkat akses data saat add-on peristiwa dipicu.

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

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

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 tidak boleh diubah.

string

Wajib. Nama tampilan solusi konferensi.

string

Wajib. URL untuk gambar logo solusi konferensi.

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

Jika ada, ini akan mengganti konfigurasi dari addons.common.homepageTrigger.

object (DocsExtensionPoint)

Endpoint untuk dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini.

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

Daftar poin ekstensi untuk membuat resource pihak ketiga dari dalam aplikasi Google Workspace. Untuk informasi selengkapnya, lihat Membuat resource pihak ketiga dari menu @.

{
  "runFunction": string
}

string

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

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

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.

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

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

object (UriPattern)

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

string

Wajib. Endpoint yang akan dijalankan saat pratinjau link dipicu.

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

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.

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.

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

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

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.

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

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

string

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

string

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

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

object (HomepageExtensionPoint)

Jika ada, ini akan mengganti konfigurasi dari addons.common.homepageTrigger.

object (SheetsExtensionPoint)

Endpoint untuk dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini.

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

Jika ada, ini akan mengganti konfigurasi dari addons.common.homepageTrigger.

object (SlidesExtensionPoint)

Endpoint untuk dieksekusi saat otorisasi cakupan file diberikan untuk pasangan dokumen/pengguna ini.

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

Konfigurasi untuk token yang dikirim di header Otorisasi HTTP.