इस पेज पर, Google Workspace ऐड-ऑन बनाने का तरीका बताया गया है. इससे Google Docs के उपयोगकर्ता, तीसरे पक्ष की सेवा के लिंक की झलक देख सकते हैं.
Google Workspace ऐड-ऑन आपकी सेवा के लिंक का पता लगा सकता है और Google Docs के उपयोगकर्ताओं को, उनकी झलक देखने का अनुरोध कर सकता है. एक से ज़्यादा यूआरएल पैटर्न की झलक देखने के लिए, ऐड-ऑन को कॉन्फ़िगर किया जा सकता है. जैसे, सपोर्ट केस के लिंक, सेल्स लीड, और कर्मचारियों की प्रोफ़ाइल.
उपयोगकर्ता, लिंक की झलक कैसे देखते हैं
Google Docs दस्तावेज़ में लिंक की झलक देखने के लिए, उपयोगकर्ता स्मार्ट चिप और कार्ड का इस्तेमाल करते हैं:
जब लोग किसी दस्तावेज़ में कोई यूआरएल टाइप या चिपकाते हैं, तो Google Docs उनसे लिंक को स्मार्ट चिप से बदलने के लिए कहता है. स्मार्ट चिप में एक आइकॉन और लिंक के कॉन्टेंट का छोटा टाइटल या ब्यौरा दिखता है. जब लोग चिप पर कर्सर घुमाते हैं, तो उन्हें एक कार्ड इंटरफ़ेस दिखता है, जिसमें फ़ाइल या लिंक के बारे में ज़्यादा जानकारी होती है.
नीचे दिए गए वीडियो में दिखाया गया है कि उपयोगकर्ता किसी लिंक को स्मार्ट चिप में कैसे बदलता है और कार्ड की झलक कैसे दिखाता है:
ज़रूरी शर्तें
Apps Script
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस क्विकस्टार्ट को फ़ॉलो करें.
Node.js
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस क्विकस्टार्ट को फ़ॉलो करें.
Python
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस क्विकस्टार्ट को फ़ॉलो करें.
Java
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस क्विकस्टार्ट को फ़ॉलो करें.
ज़रूरी नहीं: तीसरे पक्ष की सेवा के लिए पुष्टि करने की सुविधा सेट अप करना
अगर आपका ऐड-ऑन किसी ऐसी सेवा से कनेक्ट होता है जिसके लिए अनुमति की ज़रूरत है, तो लिंक की झलक देखने के लिए उपयोगकर्ताओं को सेवा की पुष्टि करनी होगी. इसका मतलब है कि जब उपयोगकर्ता पहली बार Google Docs दस्तावेज़ में आपकी सेवा का कोई लिंक चिपकाते हैं, तो आपके ऐड-ऑन को ऑथराइज़ेशन फ़्लो शुरू करना होगा.
OAuth सेवा या कस्टम ऑथराइज़ेशन प्रॉम्प्ट सेट अप करने के लिए, इनमें से कोई एक गाइड देखें:
अगर आपने Apps Script का इस्तेमाल करके ऐड-ऑन बनाया है, तो Google Workspace ऐड-ऑन की मदद से, Google से बाहर की सेवाओं से कनेक्ट करना लेख पढ़ें.
अगर आपने अपना ऐड-ऑन किसी अलग रनटाइम का इस्तेमाल करके बनाया है, तो अपने ऐड-ऑन को तीसरे पक्ष की सेवा से कनेक्ट करना देखें.
अपने ऐड-ऑन के लिए, लिंक की झलक सेट अप करना
इस सेक्शन में अपने ऐड-ऑन के लिए लिंक की झलक सेट अप करने का तरीका बताया गया है. इसमें, ये चरण शामिल हैं:
- अपने ऐड-ऑन के डिप्लॉयमेंट संसाधन या मेनिफ़ेस्ट फ़ाइल में लिंक की झलक कॉन्फ़िगर करने का तरीका अपनाएं.
- अपने लिंक के लिए, स्मार्ट चिप और कार्ड का इंटरफ़ेस बनाएं.
लिंक की झलक कॉन्फ़िगर करें
लिंक की झलक कॉन्फ़िगर करने के लिए, अपने ऐड-ऑन के डिप्लॉयमेंट संसाधन या मेनिफ़ेस्ट फ़ाइल में ये सेक्शन और फ़ील्ड तय करें:
addOns
सेक्शन में जाकर, Google Docs को बड़ा करने के लिएdocs
फ़ील्ड जोड़ें.docs
फ़ील्ड में,linkPreviewTriggers
ट्रिगर लागू करें जिसमेंrunFunction
शामिल हो. इस फ़ंक्शन के बारे में नीचे दिए गए सेक्शन स्मार्ट चिप और कार्ड बनाएं में बताया गया है.linkPreviewTriggers
ट्रिगर में कौनसे फ़ील्ड तय किए जा सकते हैं, इस बारे में जानने के लिए, Apps Script मेनिफ़ेस्ट फ़ाइलों या अन्य रनटाइम के लिए डिप्लॉयमेंट रिसॉर्स के रेफ़रंस दस्तावेज़ देखें.oauthScopes
फ़ील्ड में, स्कोपhttps://www.googleapis.com/auth/workspace.linkpreview
जोड़ें, ताकि उपयोगकर्ता अपनी ओर से लिंक की झलक देखने के लिए ऐड-ऑन को अनुमति दे सकें.
उदाहरण के तौर पर, किसी डिप्लॉयमेंट संसाधन का oauthScopes
और addons
सेक्शन देखें. यह सेक्शन, सपोर्ट केस सेवा के लिए लिंक की झलक को कॉन्फ़िगर करता है:
{
"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"
}
}
]
}
}
}
उदाहरण में, किसी कंपनी की सहायता केस सेवा के लिए, Google Workspace ऐड-ऑन की झलक दिखाने वाले लिंक. लिंक की झलक देखने के लिए, ऐड-ऑन तीन यूआरएल पैटर्न के बारे में बताता है. जब भी कोई लिंक, Google Docs दस्तावेज़ में मौजूद किसी भी यूआरएल पैटर्न से मेल खाता है, तो कॉलबैक फ़ंक्शन caseLinkPreview
, स्मार्ट चिप और कार्ड बनाता है और दिखाता है.
स्मार्ट चिप और कार्ड बनाना
किसी लिंक का स्मार्ट चिप और कार्ड दिखाने के लिए, आपको वे सभी फ़ंक्शन लागू करने होंगे
जिन्हें आपने linkPreviewTriggers
ऑब्जेक्ट में बताया है.
जब कोई उपयोगकर्ता, दिए गए यूआरएल पैटर्न से मैच करने वाले लिंक के साथ इंटरैक्ट करता है, तो
linkPreviewTriggers
ट्रिगर फ़ायर होता है और उसका कॉलबैक फ़ंक्शन, इवेंट ऑब्जेक्ट docs.matchedUrl.url
को आर्ग्युमेंट के तौर पर पास करता है. इस इवेंट ऑब्जेक्ट के पेलोड का इस्तेमाल,
लिंक की झलक के लिए स्मार्ट चिप और कार्ड बनाने में किया जाता है.
उदाहरण के लिए, example.com/cases
यूआरएल पैटर्न के बारे में बताने वाले ऐड-ऑन के लिए, अगर उपयोगकर्ता लिंक https://www.example.com/cases/123456
की झलक दिखाता है, तो नीचे दिया गया इवेंट पेलोड दिखाया जाता है:
JSON
{ "docs": { "matchedUrl": { "url": "https://www.example.com/support/cases/123456" } } }
कार्ड का इंटरफ़ेस बनाने के लिए, लिंक के बारे में जानकारी दिखाने के लिए विजेट का इस्तेमाल किया जाता है. ऐसी कार्रवाइयां भी बनाई जा सकती हैं जो उपयोगकर्ताओं को लिंक खोलने या उसके कॉन्टेंट में बदलाव करने की सुविधा दें. उपलब्ध विजेट और कार्रवाइयों की सूची के लिए, झलक कार्ड के लिए इस्तेमाल किए जा सकने वाले कॉम्पोनेंट देखें.
लिंक की झलक के लिए स्मार्ट चिप और कार्ड बनाने के लिए:
- वह फ़ंक्शन लागू करें जो आपने अपने ऐड-ऑन के डिप्लॉयमेंट रिसॉर्स के
linkPreviewTriggers
सेक्शन में या मेनिफ़ेस्ट फ़ाइल में बताया है:- फ़ंक्शन को एक ऐसे इवेंट ऑब्जेक्ट को स्वीकार करना होगा जिसमें
docs.matchedUrl.url
एक तर्क के तौर पर हो और एक हीCard
ऑब्जेक्ट दिखाया जाए. - अगर आपकी सेवा के लिए अनुमति की ज़रूरत है, तो फ़ंक्शन को ऑथराइज़ेशन फ़्लो को भी शुरू करना चाहिए.
- फ़ंक्शन को एक ऐसे इवेंट ऑब्जेक्ट को स्वीकार करना होगा जिसमें
- हर प्रीव्यू कार्ड के लिए, इंटरफ़ेस के लिए विजेट इंटरैक्टिविटी की सुविधा देने वाला कोई भी कॉलबैक फ़ंक्शन लागू करें. उदाहरण के लिए, अगर आपने "लिंक देखें" बटन शामिल किया है, तो लिंक को नई विंडो में खोलने के लिए, कॉलबैक फ़ंक्शन के बारे में बताने वाली कार्रवाई बनाएं. विजेट इंटरैक्शन के बारे में ज़्यादा जानने के लिए, ऐड-ऑन कार्रवाइयां देखें.
यहां दिया गया कोड, कॉलबैक फ़ंक्शन caseLinkPreview
बनाता है:
Apps Script
Node.js
Python
Java
झलक कार्ड के साथ काम करने वाले कॉम्पोनेंट
Google Workspace ऐड-ऑन में, लिंक की झलक दिखाने वाले कार्ड के लिए नीचे दिए गए विजेट और कार्रवाइयां काम करती हैं:
Apps Script
कार्ड सेवा फ़ील्ड | टाइप |
---|---|
TextParagraph |
विजेट |
DecoratedText |
विजेट |
Image |
विजेट |
IconImage |
विजेट |
ButtonSet |
विजेट |
TextButton |
विजेट |
ImageButton |
विजेट |
Grid |
विजेट |
Divider |
विजेट |
OpenLink |
कार्रवाई |
Navigation |
कार्रवाई के लिए, सिर्फ़ updateCard वाला तरीका इस्तेमाल किया जा सकता है. |
JSON
कार्ड (google.apps.card.v1 ) फ़ील्ड |
टाइप |
---|---|
TextParagraph |
विजेट |
DecoratedText |
विजेट |
Image |
विजेट |
Icon |
विजेट |
ButtonList |
विजेट |
Button |
विजेट |
Grid |
विजेट |
Divider |
विजेट |
OpenLink |
कार्रवाई |
Navigation |
कार्रवाई के लिए, सिर्फ़ updateCard वाला तरीका इस्तेमाल किया जा सकता है. |
पूरा उदाहरण: सहायता अनुरोध वाला ऐड-ऑन
नीचे दिए गए उदाहरण में, Google Workspace ऐड-ऑन दिखाया गया है. इसमें किसी कंपनी के सहायता मामलों और कर्मचारियों की प्रोफ़ाइल के लिंक की झलक दिखाई गई है.
उदाहरण में यह जानकारी दी गई है:
- सहायता मामलों, जैसे कि
https://www.example.com/support/cases/1234
के लिंक की झलक दिखाता है. स्मार्ट चिप पर एक सहायता आइकॉन दिखता है और झलक दिखाने वाले कार्ड में केस आईडी और उसका ब्यौरा होता है. - सहायता केस एजेंट के लिंक की झलक दिखाता है, जैसे कि
https://www.example.com/people/rosario-cruz
. स्मार्ट चिप में एक व्यक्ति का आइकॉन दिखता है. झलक वाले कार्ड में कर्मचारी का नाम, ईमेल पता, पद का नाम, और प्रोफ़ाइल फ़ोटो होती है. - अगर उपयोगकर्ता की स्थान-भाषा स्पैनिश पर सेट है, तो स्मार्ट चिप उसके
labelText
को स्पैनिश में बदल देता है.
डिप्लॉयमेंट संसाधन
Apps Script
JSON
{
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://developers.google.com/workspace/add-ons/images/link-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"
},
{
"runFunction": "URL",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "people"
}
],
"labelText": "People",
"localizedLabelText": {
"es": "Personas"
},
"logoUrl": "https://developers.google.com/workspace/add-ons/images/person-icon.png"
}
]
}
}
}