Bu sayfada Google Dokümanlar, E-Tablolar ve Slaytlar kullanıcılarının üçüncü taraf bir hizmetten bağlantıları önizlemesine olanak tanıyan bir Google Workspace Eklentisini nasıl oluşturacağınız açıklanmaktadır.
Google Workspace Eklentisi, hizmetinizin bağlantılarını algılayıp kullanıcılardan bunları önizlemelerini isteyebilir. Destek vakalarına, satış potansiyellerine ve çalışan profillerine bağlantılar gibi birden fazla URL kalıbını önizlemek için bir eklenti yapılandırabilirsiniz.
Kullanıcılar bağlantıları nasıl önizler?
Kullanıcılar, bağlantıları önizlemek için akıllı çipler ve kartlarla etkileşimde bulunur.
Kullanıcılar bir dokümana URL yazdığında veya yapıştırdığında Google Dokümanlar, bağlantıyı akıllı çiple değiştirmelerini ister. Akıllı çipte, bağlantı içeriğinin kısa bir başlığı veya açıklaması gösterilir. Kullanıcı fareyle çipin üzerine geldiğinde dosya veya bağlantı hakkında daha fazla bilginin önizlemesini gösteren bir kart arayüzü görür.
Aşağıdaki videoda kullanıcının bağlantıyı akıllı çipe nasıl dönüştürdüğü ve kartı nasıl önizlediği gösterilmektedir:
Kullanıcılar E-Tablolar ve Slaytlar'da bağlantıları nasıl önizler?
E-Tablolar ve Slaytlar'da bağlantı önizlemeleri için üçüncü taraf akıllı çipleri desteklenmez. Kullanıcılar bir e-tabloya veya sunuya bir URL yazdığında ya da yapıştırdığında E-Tablolar veya Slaytlar, kullanıcılardan bağlantıyı çip yerine bağlantı metni olarak başlıkla değiştirmelerini ister. Kullanıcı, imleci bağlantı başlığının üzerine getirdiğinde bağlantıyla ilgili bilgilerin önizlemesini gösteren bir kart arayüzü görür.
Aşağıdaki resimde, bir bağlantı önizlemesinin E-Tablolar ve Slaytlar'da nasıl oluşturulduğu gösterilmektedir:
Ön koşullar
Apps Komut Dosyası
- Bir Google Workspace hesabı.
- Google Workspace eklentisi. Eklenti oluşturmak için bu quickstart takip edin.
Node.js
- Bir Google Workspace hesabı.
- Google Workspace eklentisi. Eklenti oluşturmak için bu quickstart takip edin.
Python
- Bir Google Workspace hesabı.
- Google Workspace eklentisi. Eklenti oluşturmak için bu quickstart takip edin.
Java
- Bir Google Workspace hesabı.
- Google Workspace eklentisi. Eklenti oluşturmak için bu quickstart takip edin.
İsteğe bağlı: Üçüncü taraf hizmeti için kimlik doğrulamayı ayarlama
Eklentiniz yetkilendirme gerektiren bir hizmete bağlanırsa kullanıcıların bağlantıları önizlemek için hizmetle kimlik doğrulaması yapması gerekir. Diğer bir deyişle, kullanıcılar hizmetinizden bir bağlantıyı ilk kez bir Dokümanlar, E-Tablolar veya Slaytlar dosyasına yapıştırdığında, eklentinizin yetkilendirme akışını çağırması gerekir.
OAuth hizmeti veya özel yetkilendirme istemi ayarlamak için aşağıdaki kılavuzlardan birine bakın:
Eklentinizi Apps Komut Dosyası'nı kullanarak oluşturduysanız Google Workspace Eklentisinden Google Dışı Hizmetlere Bağlanma başlıklı makaleye göz atın.
Eklentinizi farklı bir çalışma zamanı kullanarak oluşturduysanız Eklentinizi üçüncü taraf bir hizmete bağlama bölümüne bakın.
Eklentiniz için bağlantı önizlemeleri ayarlama
Bu bölümde, eklentiniz için bağlantı önizlemelerini nasıl ayarlayacağınız açıklanmaktadır. Bu süreç, aşağıdaki adımları içerir:
- Eklentinizin dağıtım kaynağında veya manifest dosyasında bağlantı önizlemelerini yapılandırın.
- Bağlantılarınız için akıllı çip ve kart arayüzü oluşturun.
Bağlantı önizlemelerini yapılandırma
Bağlantı önizlemelerini yapılandırmak için eklentinizin dağıtım kaynağında veya manifest dosyasında aşağıdaki bölümleri ve alanları belirtin:
addOns
bölümünde, Dokümanlar'ı genişletmek içindocs
alanını, E-Tablolar'ı genişletmek içinsheets
alanını ve Slaytlar'ı genişletmek içinslides
alanını ekleyin.Her alanda,
runFunction
içerenlinkPreviewTriggers
tetikleyicisini uygulayın (Bu işlevi Akıllı çip ve kart oluşturma bölümünde tanımlarsınız).linkPreviewTriggers
tetikleyicisinde hangi alanları belirtebileceğiniz hakkında bilgi edinmek için Apps Komut Dosyası manifest dosyaları veya diğer çalışma zamanları için dağıtım kaynaklarına yönelik referans belgelerine bakın.Kullanıcıların, bağlantıları kendi adlarına önizlemeleri için eklentiyi yetkilendirebilmesi için
oauthScopes
alanınahttps://www.googleapis.com/auth/workspace.linkpreview
kapsamını ekleyin.
Örnek olarak, bir destek kaydı hizmeti için bağlantı önizlemelerini yapılandıran aşağıdaki dağıtım kaynağının oauthScopes
ve addons
bölümüne bakın.
{
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://www.example.com/images/company-logo.png",
"layoutProperties": {
"primaryColor": "#dd4b39"
}
},
"docs": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"logoUrl": "https://www.example.com/images/support-icon.png",
"localizedLabelText": {
"es": "Caso de soporte"
}
}
]
},
"sheets": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"logoUrl": "https://www.example.com/images/support-icon.png",
"localizedLabelText": {
"es": "Caso de soporte"
}
}
]
},
"slides": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"logoUrl": "https://www.example.com/images/support-icon.png",
"localizedLabelText": {
"es": "Caso de soporte"
}
}
]
}
}
}
Örnekte, Google Workspace Eklentisi, bir şirketin destek kaydı hizmetinin bağlantılarını önizler. Eklenti, önizleme bağlantıları için
üç URL kalıbı belirtir. Bir bağlantı, URL kalıplarından biriyle eşleştiğinde, caseLinkPreview
geri çağırma işlevi bir kart ve akıllı çip oluşturup görüntüler veya E-Tablolar ve Slaytlar'da, URL'yi bağlantı başlığıyla değiştirir.
Akıllı çip ve kart oluşturun
Bir bağlantı için akıllı çip ve kart döndürmek istiyorsanız linkPreviewTriggers
nesnesinde belirttiğiniz tüm işlevleri uygulamanız gerekir.
Bir kullanıcı, belirtilen URL kalıbıyla eşleşen bir bağlantıyla etkileşimde bulunduğunda linkPreviewTriggers
tetikleyicisi etkinleşir ve geri çağırma işlevi EDITOR_NAME.matchedUrl.url
etkinlik nesnesini bağımsız değişken olarak iletir. Bağlantı önizlemeniz için akıllı çip ve kart oluşturmak amacıyla bu etkinlik nesnesinin yükünü kullanırsınız.
Örneğin, bir kullanıcı Dokümanlar'da https://www.example.com/cases/123456
bağlantısını önizlerse aşağıdaki etkinlik yükü döndürülür:
JSON
{ "docs": { "matchedUrl": { "url": "https://www.example.com/support/cases/123456" } } }
Kart arayüzünü oluşturmak için bağlantıyla ilgili bilgileri görüntülemek üzere widget'ları kullanırsınız. Ayrıca, kullanıcıların bağlantıyı açmasına veya içeriğini değiştirmesine olanak tanıyan işlemler de oluşturabilirsiniz. Kullanılabilir widget'ların ve işlemlerin listesi için Önizleme kartları için desteklenen bileşenler bölümüne bakın.
Bağlantı önizlemesi için akıllı çip ve kart oluşturmak isterseniz:
- Eklentinizin dağıtım kaynağı veya manifest dosyasındaki
linkPreviewTriggers
bölümünde belirttiğiniz işlevi uygulayın:- İşlev, bağımsız değişken olarak
EDITOR_NAME.matchedUrl.url
içeren bir etkinlik nesnesini kabul etmeli ve tek birCard
nesnesi döndürmelidir. - Hizmetiniz yetkilendirme gerektiriyorsa işlevin yetkilendirme akışını da çağırması gerekir.
- İşlev, bağımsız değişken olarak
- Her bir önizleme kartında, arayüzde widget etkileşimi sağlayan geri çağırma işlevlerini uygulayın. Örneğin, "Bağlantıyı görüntüle" yazan bir düğme eklerseniz bağlantıyı yeni bir pencerede açmak için geri çağırma işlevi belirten bir işlem oluşturabilirsiniz. Widget etkileşimleri hakkında daha fazla bilgi edinmek için Eklenti işlemleri konusuna bakın.
Aşağıdaki kod, Dokümanlar için caseLinkPreview
geri çağırma işlevini oluşturur:
Apps Komut Dosyası
Node.js
Python
Java
Önizleme kartları için desteklenen bileşenler
Google Workspace Eklentileri, bağlantı önizleme kartları için aşağıdaki widget'ları ve işlemleri destekler:
Apps Komut Dosyası
Kart Hizmeti alanı | Tür |
---|---|
TextParagraph |
Widget |
DecoratedText |
Widget |
Image |
Widget |
IconImage |
Widget |
ButtonSet |
Widget |
TextButton |
Widget |
ImageButton |
Widget |
Grid |
Widget |
Divider |
Widget |
OpenLink |
İşlem |
Navigation |
İşlem Yalnızca updateCard yöntemi desteklenir. |
JSON
Kart (google.apps.card.v1 ) alanı |
Tür |
---|---|
TextParagraph |
Widget |
DecoratedText |
Widget |
Image |
Widget |
Icon |
Widget |
ButtonList |
Widget |
Button |
Widget |
Grid |
Widget |
Divider |
Widget |
OpenLink |
İşlem |
Navigation |
İşlem Yalnızca updateCard yöntemi desteklenir. |
Tam örnek: Destek kaydı eklentisi
Aşağıdaki örnekte, bir şirketin Google Dokümanlar'daki destek yazışmalarının bağlantılarını önizleyen bir Google Workspace Eklentisi yer almaktadır.
Örnekte aşağıdakiler gerçekleşir:
https://www.example.com/support/cases/1234
gibi destek kaydı bağlantılarını önizler. Akıllı çipte bir destek simgesi gösterilir. Önizleme kartında ise destek kaydı kimliği ve açıklama bulunur.- Kullanıcının yerel ayarı İspanyolca olarak ayarlanırsa akıllı çip,
labelText
bilgisini İspanyolcaya yerelleştirir.
Dağıtım kaynağı
Apps Komut Dosyası
JSON
{
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png",
"layoutProperties": {
"primaryColor": "#dd4b39"
}
},
"docs": {
"linkPreviewTriggers": [
{
"runFunction": "URL",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"localizedLabelText": {
"es": "Caso de soporte"
},
"logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png"
}
]
}
}
}
Kod
Apps Komut Dosyası
Node.js
Python
Java
İlgili kaynaklar
- Google Kitaplar'daki bağlantıları akıllı çiplerle önizleme
- Eklentinizi test etme
- Google Dokümanlar dağıtım kaynağı
- Bağlantı önizlemeleri için kart arayüzleri