- Kaynak: Dağıtım
- Eklentiler
- 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
- Yöntemler
Kaynak: Dağıtım
Google Workspace eklentisi dağıtımı
JSON gösterimi |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Alanlar | |
---|---|
name |
Dağıtım kaynağının adı. Örnek: |
oauth |
Eklenti uç noktası yürütmeden önce son kullanıcıdan izin istenecek Google OAuth kapsamlarının listesi. |
add |
Google Workspace eklentisi yapılandırması. |
etag |
Bu değer, sunucu tarafından depolama alanındaki dağıtımın sürümüne göre hesaplanır ve devam etmeden önce istemcinin güncel bir değere sahip olmasını sağlamak için güncelleme ve silme isteklerinde gönderilebilir. |
Eklentiler
Google Workspace eklentisi yapılandırması.
JSON gösterimi |
---|
{ "common": { object ( |
Alanlar | |
---|---|
common |
Tüm Google Workspace eklentilerinde ortak olan yapılandırma. |
gmail |
Gmail eklenti yapılandırması. |
drive |
Drive eklenti yapılandırması. |
calendar |
Takvim eklentisi yapılandırması. |
docs |
Dokümanlar eklentisi yapılandırması. |
sheets |
E-Tablolar eklentisi yapılandırması. |
slides |
Slaytlar eklentisi yapılandırması. |
http |
Eklenti HTTP uç noktalarına istek gönderme seçenekleri |
CommonAddOnManifest
Tüm eklenti ana makine uygulamaları arasında paylaşılan eklenti yapılandırması.
JSON gösterimi |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Alanlar | |
---|---|
name |
Zorunlu. Eklentinin görünen adı. |
logo |
Zorunlu. Eklenti araç çubuğunda gösterilen logo resminin URL'si. |
layout |
Eklenti kartları için ortak düzen özellikleri. |
add |
Eklentide kullanılan widget'lar. Bu alan belirtilmezse varsayılan ayar kullanılır. |
use |
Ana makine uygulamasından yerel ayar bilgilerinin aktarılıp aktarılmayacağı. |
homepage |
Herhangi bir bağlamda, herhangi bir ana makinede yürütülecek bir uç nokta tanımlar. Bu işlev tarafından oluşturulan tüm kartlar kullanıcı tarafından her zaman kullanılabilir ancak bu eklenti daha hedefli tetikleyiciler tanımladığında bağlama dayalı içerik tarafından gölgelenebilir. |
universal |
Eklenti için ayarlar menüsü görevi gören evrensel işlem menüsünde uzantı noktaları listesini tanımlar. Uzatma noktası, açılacak bir bağlantı URL'si veya form gönderimi olarak yürütülecek bir uç nokta olabilir. |
open |
OpenLink işlemi yalnızca |
LayoutProperties
Tüm eklenti ana makine uygulamalarında paylaşılan kart düzeni özellikleri.
JSON gösterimi |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Alanlar | |
---|---|
primary |
Eklentinin birincil rengi. Araç çubuğunun rengini ayarlar. Birincil renk ayarlanmazsa çerçeve tarafından sağlanan varsayılan değer kullanılır. |
secondary |
Eklentinin ikincil rengi. Düğmelerin rengini ayarlar. Birincil renk ayarlanmışsa ancak ikincil renk ayarlanmamışsa ikincil renk birincil renkle aynı olur. Birincil renk veya ikincil renk ayarlanmamışsa çerçeve tarafından sağlanan varsayılan değer kullanılır. |
use |
Kartlar için materyal tasarımını etkinleştirir. |
AddOnWidgetSet
Bir eklentinin kullandığı widget alt kümesi.
JSON gösterimi |
---|
{
"usedWidgets": [
enum ( |
Alanlar | |
---|---|
used |
Bir eklentide kullanılan widget'ların listesi. |
WidgetType
Widget türü. WIDGET_TYPE_UNSPECIFIED
, temel widget grubudur.
Sıralamalar | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
Varsayılan widget grubu. |
DATE_PICKER |
Tarih seçici. |
STYLED_BUTTONS |
Stilize düğmeler, doldurulmuş düğmeler ve devre dışı bırakılmış düğmeleri içerir. |
PERSISTENT_FORMS |
Kalıcı formlar, işlemler sırasında form değerlerinin korunmasını sağlar. |
FIXED_FOOTER |
Karttaki altbilgi düzeltildi. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Taslağın konusunu ve alıcılarını güncelleme. |
GRID_WIDGET |
Tablo widget'ı. |
ADDON_COMPOSE_UI_ACTION |
Eklenti oluşturma kullanıcı arayüzü için geçerli olan bir Gmail eklenti işlemi. |
HomepageExtensionPoint
Bir eklentinin ana sayfa görünümünü bildirmek için yaygın olarak kullanılan biçim.
JSON gösterimi |
---|
{ "runFunction": string, "enabled": boolean } |
Alanlar | |
---|---|
run |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde yürütülecek uç nokta. |
enabled |
İsteğe bağlı. Ayarlanmamışsa varsayılan değeri Bir eklentinin özel ana sayfa görünümü devre dışıysa bunun yerine kullanıcılara genel bakış kartı gösterilir. |
UniversalActionExtensionPoint
Evrensel işlem menüsü öğesi uzantı noktası beyanı biçimi.
JSON gösterimi |
---|
{ "label": string, // Union field |
Alanlar | |
---|---|
label |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde gerçekleştirilen işlemi açıklayan, kullanıcının görebildiği metin (ör. "Yeni kişi ekleyin). |
Birleştirme alanı action_type . Zorunlu. Evrensel işlem menüsü öğesinde desteklenen işlem türü. Açılacak bir bağlantı veya çalıştırılacak bir uç nokta olabilir. action_type şunlardan yalnızca biri olabilir: |
|
open |
UniversalAction tarafından açılacak URL. |
run |
UniversalAction tarafından çalıştırılacak uç nokta. |
GmailAddOnManifest
Bir Gmail eklentisinin görünümünü ve yürütülmesini özelleştiren özellikler.
JSON gösterimi |
---|
{ "homepageTrigger": { object ( |
Alanlar | |
---|---|
homepage |
Beyan edilen bir bağlamsal tetikleyiciyle eşleşmeyen bağlamlarda yürütülecek bir uç nokta tanımlar. Bu işlev tarafından oluşturulan tüm kartlar kullanıcı tarafından her zaman kullanılabilir ancak bu eklenti daha hedefli tetikleyiciler tanımladığında bağlama dayalı içerik tarafından gölgelenebilir. Mevcut olduğunda bu, |
contextual |
Eklentiyi tetikleyen koşul grubunu tanımlar. |
universal |
Eklenti için bir evrensel işlem grubu tanımlar. Kullanıcı, eklenti araç çubuğu menüsünden genel işlemleri tetikler. |
compose |
Oluşturma zamanı eklentisi için oluşturma zamanı tetikleyicisini tanımlar. Bu, kullanıcı e-posta oluştururken eklentinin işlem yapmasına neden olan tetikleyicidir. Taslağı düzenleyememeleri mümkün olsa da tüm yazma zamanı eklentileri |
authorization |
Üçüncü taraf API'lerini inceleyerek eklentinin gerekli tüm üçüncü taraf yetkilendirmelerine sahip olduğunu doğrulayan bir uç noktanın adı. Kontrol başarısız olursa işlev, yetkilendirme akışını başlatmak için bir istisna bildirmelidir. Bu işlev, sorunsuz bir kullanıcı deneyimi sağlamak için eklenti her çağrılmadan önce çağrılır. |
ContextualTrigger
Açık e-posta belirli bir ölçütü karşıladığında etkinleşen bir tetikleyici tanımlar. Tetikleyici etkinleştiğinde, genellikle yeni kartlar oluşturmak ve kullanıcı arayüzünü güncellemek için belirli bir uç noktayı yürütür.
JSON gösterimi |
---|
{ "onTriggerFunction": string, // Union field |
Alanlar | |
---|---|
on |
Zorunlu. Bir mesaj tetikleyiciyle eşleştiğinde çağrılacak uç noktanın adı. |
Birlik alanı trigger . Tetikleyici türü, Gmail'in eklentiyi göstermek için kullandığı koşulları belirler. trigger yalnızca aşağıdakilerden biri olabilir: |
|
unconditional |
Koşulsuz tetikleyiciler, herhangi bir posta mesajı açıldığında yürütülür. |
UnconditionalTrigger
Bu türde alan yok.
Herhangi bir e-posta iletisi açıldığında tetiklenen bir tetikleyici.
UniversalAction
İleti bağlamından bağımsız olarak eklenti araç çubuğu menüsünde her zaman kullanılabilen bir işlem.
JSON gösterimi |
---|
{ "text": string, // Union field |
Alanlar | |
---|---|
text |
Zorunlu. İşlemi açıklayan, kullanıcı tarafından görülebilen metin (ör. "Yeni kişi ekle"). |
Birlik alanı action_type . İşlemin türü, kullanıcı işlemi tetiklediğinde Gmail'in davranışını belirler. action_type yalnızca aşağıdakilerden biri olabilir: |
|
open |
Kullanıcı işlemi tetiklediğinde Gmail tarafından açılan bir bağlantı. |
run |
Kullanıcı işlemi tetiklediğinde çağrılan bir uç nokta. Ayrıntılar için evrensel işlemler kılavuzuna bakın. |
ComposeTrigger
Kullanıcı e-posta oluştururken etkinleştirilen bir tetikleyici.
JSON gösterimi |
---|
{ "actions": [ { object ( |
Alanlar | |
---|---|
actions[] |
Oluşturma zamanı eklentisi için işlem grubunu tanımlar. Bunlar, kullanıcıların yazma zamanı eklentisinde tetikleyebileceği işlemlerdir. |
draft |
Oluşturma zamanı eklentisi tetiklendiğinde gerçekleştirilen veri erişimi düzeyini tanımlar. |
MenuItemExtensionPoint
Bir ana makine uygulamasında görünen bir menü seçeneğini veya düğmeyi tanımlamak için kullanılan yaygın biçim.
JSON gösterimi |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Alanlar | |
---|---|
run |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde çalıştırılacak uç nokta. |
label |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde gerçekleştirilen işlemi açıklayan, kullanıcı tarafından görülebilen metin. Örneğin, "Fatura ekleyin." |
logo |
Eklenti araç çubuğunda gösterilen logo resminin URL'si. Ayarlanmazsa varsayılan olarak eklentinin birincil logo URL'si kullanılır. |
DraftAccess
Oluşturma tetikleyicisinin gerektirdiği veri erişimi düzeyini tanımlayan bir sıralama.
Sıralamalar | |
---|---|
UNSPECIFIED |
Taslak erişim için hiçbir şey ayarlanmadığında varsayılan değer. |
NONE |
Bir oluşturma eklentisi tetiklendiğinde, oluşturma tetikleyicisi taslaktaki hiçbir veriye erişemez. |
METADATA |
Oluşturma eklentisi tetiklendiğinde, oluşturma tetikleyicisine taslağın meta verilerine erişme izni verir. Buna, bir taslak iletideki Alıcı ve CC listesi gibi kitle listesi de dahildir. |
DriveAddOnManifest
Bir Drive eklentisinin görünümünü ve yürütmesini özelleştiren mülkler.
JSON gösterimi |
---|
{ "homepageTrigger": { object ( |
Alanlar | |
---|---|
homepage |
Mevcut olduğunda bu, |
on |
İlgili Drive görünümünde (ör. Drive'ımda Doküman Listesi) öğeler seçildiğinde yürütülen davranışa karşılık gelir. |
DriveExtensionPoint
Drive eklentisinin tetikleyicilerini belirtmek için kullanılan yaygın biçim.
JSON gösterimi |
---|
{ "runFunction": string } |
Alanlar | |
---|---|
run |
Zorunlu. Uzantı noktası etkinleştirildiğinde yürütülecek uç nokta. |
CalendarAddOnManifest
Takvim eklentisinin görünümünü ve çalışma şeklini özelleştiren özellikler.
JSON gösterimi |
---|
{ "homepageTrigger": { object ( |
Alanlar | |
---|---|
homepage |
Tanımlanmış bir bağlamsal tetikleyiciyle eşleşmeyen bağlamlarda çalıştırılan bir uç nokta tanımlar. Bu işlev tarafından oluşturulan tüm kartlar kullanıcı tarafından her zaman kullanılabilir ancak bu eklenti daha hedefli tetikleyiciler tanımladığında bağlama dayalı içerik tarafından gölgelenebilir. Mevcut olduğunda, |
conference |
Bu eklenti tarafından sağlanan konferans çözümlerini tanımlar. Üçüncü taraf konferans eklentileri yalnızca Apps Script'te oluşturulabilir. |
create |
Yürütülecek ve eklentinin ayarlar sayfasının URL'sini oluşturan bir uç nokta. |
event |
Bir etkinlik görüntülenmek veya düzenlenmek üzere açıldığında tetiklenen bir uç nokta. |
event |
Açık etkinlik güncellendiğinde tetiklenen bir uç nokta. |
event |
Kullanıcı Takvim açılır menüsünde eklenti eki sağlayıcısını tıkladığında tetiklenen bağlama dayalı tetikleyici yapılandırması. |
current |
Bir etkinlik eklentisi tetiklendiğinde ne kadar veri erişimi oluşturulacağını tanımlar. |
ConferenceSolution
Konferansla ilgili değerleri tanımlar. Üçüncü taraf konferans eklentileri yalnızca Apps Script'te oluşturulabilir.
JSON gösterimi |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Alanlar | |
---|---|
on |
Zorunlu. Konferans verilerinin oluşturulması gerektiğinde aranacak uç nokta. |
id |
Zorunlu. Kimlikler, bir eklenti içinde konferans çözümleri genelinde benzersiz bir şekilde atanmalıdır. Aksi takdirde, eklenti tetiklendiğinde yanlış konferans çözümü kullanılabilir. Eklentinin görünen adını değiştirebilirsiniz ancak kimliği değiştirilmemelidir. |
name |
Zorunlu. Konferans çözümünün görünen adı. |
logo |
Zorunlu. Konferans çözümünün logo resminin URL'si. |
CalendarExtensionPoint
Takvim eklentisinin tetikleyicilerini beyan etmek için kullanılan yaygın biçim.
JSON gösterimi |
---|
{ "runFunction": string } |
Alanlar | |
---|---|
run |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde çalıştırılacak uç nokta. |
EventAccess
Etkinlik tetikleyicilerinin gerektirdiği veri erişimi düzeyini tanımlayan bir sıralama.
Sıralamalar | |
---|---|
UNSPECIFIED |
eventAccess için hiçbir şey ayarlanmadığında varsayılan değerdir. |
METADATA |
Etkinlik tetikleyicilerine, etkinlik kimliği ve takvim kimliği gibi etkinliklerin meta verilerine erişim izni verir. |
READ |
Etkinlik tetikleyicilerine meta veriler, katılımcılar ve konferans verileri dahil olmak üzere sağlanan tüm etkinlik alanlarına erişim izni verir. |
WRITE |
Etkinlik tetikleyicilerine etkinliklerin meta verilerine erişim ve katılımcı ekleme ve konferans verilerini ayarlama dahil tüm işlemleri gerçekleştirme olanağı verir. |
READ_WRITE |
Etkinlik tetikleyicilerine meta veriler, katılımcılar ve konferans verileri dahil olmak üzere sağlanan tüm etkinlik alanlarına erişim ve tüm işlemleri gerçekleştirme olanağı verir. |
DocsAddOnManifest
Bir Google Dokümanlar eklentisinin görünümünü ve yürütmesini özelleştiren özellikler.
JSON gösterimi |
---|
{ "homepageTrigger": { object ( |
Alanlar | |
---|---|
homepage |
Mevcut olduğunda bu, |
on |
Bu doküman/kullanıcı çifti için dosya kapsamı yetkilendirmesi verildiğinde yürütülecek uç nokta. |
link |
Google Dokümanlar dokümanındaki bağlantıları önizlemeye yönelik uzantı noktalarının listesi. Ayrıntılı bilgi için Akıllı çiplerle bağlantıları önizleme başlıklı makaleyi inceleyin. |
create |
Google Workspace uygulamalarından üçüncü taraf kaynakları oluşturmak için kullanılabilecek uzantı noktalarının listesi. Daha fazla bilgi için @ menüsünden üçüncü taraf kaynakları oluşturma başlıklı makaleyi inceleyin. |
DocsExtensionPoint
Dokümanlar eklentisinin tetikleyicilerini belirtmek için kullanılan yaygın biçim.
JSON gösterimi |
---|
{ "runFunction": string } |
Alanlar | |
---|---|
run |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde yürütülecek uç nokta. |
LinkPreviewExtensionPoint
Kullanıcı üçüncü taraf veya Google dışı bir hizmetten Google Dokümanlar, E-Tablolar veya Slaytlar dosyasına bir bağlantı yazdığında ya da yapıştırdığında etkinleşen bir tetikleyicinin yapılandırması.
JSON gösterimi |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Alanlar | |
---|---|
label |
Zorunlu. Kullanıcılardan bağlantıyı önizlemesini isteyen örnek bir akıllı çip için metin (ör. |
localized |
İsteğe bağlı. Diğer dillere yerelleştirilecek Kullanıcının yerel ayarı haritanın anahtarlarında mevcutsa kullanıcı,
|
patterns[] |
Zorunlu. Önizleme bağlantılarında eklentiyi tetikleyen URL kalıpları dizisi. |
run |
Zorunlu. Bağlantı önizlemesi tetiklendiğinde yürütülecek uç nokta. |
logo |
İsteğe bağlı. Akıllı çip ve önizleme kartında görüntülenen simge. Atlanırsa eklenti kendi araç çubuğu simgesini ( |
UriPattern
Bir bağlantı önizlemesini tetikleyen her URL kalıbının yapılandırması.
JSON gösterimi |
---|
{ "hostPattern": string, "pathPrefix": string } |
Alanlar | |
---|---|
host |
Her URL kalıbının önizlenmesi için gereklidir. URL kalıbının alan adı. Eklenti, URL'de bu alan adını içeren bağlantıları önizler. Örneğin, |
path |
İsteğe bağlı. Örneğin, URL ana makine kalıbı Ana makine kalıbı alanındaki tüm URL'leri eşleştirmek için |
CreateActionExtensionPoint
Kullanıcı bir Google Workspace uygulamasında kaynak oluşturma iş akışını çağırdığında tetiklenen tetikleyiciye yönelik yapılandırma. Daha fazla bilgi için @ menüsünden üçüncü taraf kaynakları oluşturma başlıklı makaleyi inceleyin.
JSON gösterimi |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
Alanlar | |
---|---|
id |
Zorunlu. Bu uzantı noktasını ayırt etmek için kullanılan benzersiz kimlik. Kimlik en fazla 64 karakterden oluşabilir ve |
label |
Zorunlu. Kaynak oluşturma giriş noktası için bir simgenin yanında görüntülenen metin (ör. |
localized |
İsteğe bağlı. Diğer dillere yerelleştirilecek Kullanıcının yerel ayarı haritanın anahtarlarında mevcutsa kullanıcı,
|
run |
Zorunlu. Bağlantı oluşturmak üzere kaynak oluşturma iş akışı tetiklendiğinde yürütülecek uç nokta. |
logo |
İsteğe bağlı. Kaynak oluşturma giriş noktası için gösterilen simge. Bu değer atlanmazsa menüde eklentinizin araç çubuğu simgesi |
SheetsAddOnManifest
Google E-Tablolar eklentisinin görünümünü ve yürütülmesini özelleştiren özellikler.
JSON gösterimi |
---|
{ "homepageTrigger": { object ( |
Alanlar | |
---|---|
homepage |
Mevcut olduğunda bu, |
on |
Bu belge/kullanıcı çifti için dosya kapsamı yetkilendirmesi verildiğinde yürütülecek uç nokta. |
link |
Google E-Tablolar belgesindeki bağlantıları önizlemek için uzantı noktalarının listesi. Ayrıntılı bilgi için Akıllı çiplerle bağlantıları önizleme başlıklı makaleyi inceleyin. |
SheetsExtensionPoint
E-Tablolar eklentisinin tetikleyicilerini belirtmek için kullanılan yaygın biçim.
JSON gösterimi |
---|
{ "runFunction": string } |
Alanlar | |
---|---|
run |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde yürütülecek uç nokta. |
SlidesAddOnManifest
Google Slaytlar eklentisinin görünümünü ve çalışma şeklini özelleştiren özellikler.
JSON gösterimi |
---|
{ "homepageTrigger": { object ( |
Alanlar | |
---|---|
homepage |
Mevcut olduğunda bu, |
on |
Bu belge/kullanıcı çifti için dosya kapsamı yetkilendirmesi verildiğinde çalıştırılacak uç nokta. |
link |
Google Slaytlar dokümanındaki bağlantıları önizlemek için kullanılan uzantı noktalarının listesi. Ayrıntılı bilgi için Akıllı çiplerle bağlantıları önizleme başlıklı makaleyi inceleyin. |
SlidesExtensionPoint
Slaytlar eklentisinin tetikleyicilerini bildirmek için yaygın olarak kullanılan biçim.
JSON gösterimi |
---|
{ "runFunction": string } |
Alanlar | |
---|---|
run |
Zorunlu. Bu uzantı noktası etkinleştirildiğinde çalıştırılacak uç nokta. |
HttpOptions
HTTP
eklentisi uç noktalarına istek gönderme seçenekleri.
JSON gösterimi |
---|
{
"authorizationHeader": enum ( |
Alanlar | |
---|---|
authorization |
|
HttpAuthorizationHeader
HTTP
eklentisi isteklerinde yetkilendirme üstbilgisi gönderildi.
Sıralamalar | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
SYSTEM_ID_TOKEN öğesine eşdeğer varsayılan değer. |
SYSTEM_ID_TOKEN |
Projeye özel Google Workspace Eklentisinin sistem hizmet hesabı için bir kimlik jetonu gönderin (varsayılan). |
USER_ID_TOKEN |
Son kullanıcı için kimlik jetonu gönderin. |
NONE |
Kimlik doğrulama üstbilgisi göndermeyin. |
Yöntemler |
|
---|---|
|
Belirtilen ada ve yapılandırmayla bir dağıtım oluşturur. |
|
Belirtilen ada sahip dağıtımı siler. |
|
Belirtilen ada sahip dağıtımı alır. |
|
Bir test dağıtımının yükleme durumunu alır. |
|
Test için hesabınıza bir dağıtım yükler. |
|
Belirli bir projedeki tüm dağıtımları listeler. |
|
Belirtilen ada sahip bir dağıtım oluşturur veya mevcut dağıtımı değiştirir. |
|
Test dağıtımını kullanıcının hesabından kaldırır. |