इस पेज पर, Google Workspace ऐड-ऑन बनाने का तरीका बताया गया है. इसकी मदद से, Google Docs, Sheets, और Slides के उपयोगकर्ता तीसरे पक्ष की सेवा के लिंक की झलक देख सकते हैं.
Google Workspace ऐड-ऑन, आपकी सेवा के लिंक का पता लगा सकता है और उपयोगकर्ताओं से उनकी झलक देखने के लिए कह सकता है. एक से ज़्यादा यूआरएल पैटर्न की झलक देखने के लिए, ऐड-ऑन कॉन्फ़िगर किया जा सकता है. जैसे, सपोर्ट केस के लिंक, सेल्स लीड, और कर्मचारियों की प्रोफ़ाइल.
उपयोगकर्ता, लिंक की झलक कैसे देखते हैं
लिंक की झलक देखने के लिए, उपयोगकर्ता स्मार्ट चिप और कार्ड का इस्तेमाल करते हैं.
जब उपयोगकर्ता किसी दस्तावेज़ में यूआरएल टाइप करते हैं या चिपकाते हैं, तो Google Docs उन्हें लिंक को स्मार्ट चिप से बदलने के लिए कहता है. स्मार्ट चिप, लिंक के कॉन्टेंट का एक आइकॉन और छोटा टाइटल या जानकारी दिखाता है. जब लोग चिप पर कर्सर घुमाते हैं, तो उन्हें एक कार्ड इंटरफ़ेस दिखता है. इसमें फ़ाइल या लिंक के बारे में ज़्यादा जानकारी देखी जा सकती है.
इस वीडियो में दिखाया गया है कि कोई उपयोगकर्ता किसी लिंक को स्मार्ट चिप में कैसे बदलता है और कार्ड की झलक कैसे दिखाता है:
उपयोगकर्ता, Sheets और Slides में लिंक की झलक कैसे देखते हैं
Sheets और Slides में, लिंक की झलक दिखाने के लिए तीसरे पक्ष के स्मार्ट चिप काम नहीं करते. जब उपयोगकर्ता किसी स्प्रेडशीट या प्रज़ेंटेशन में कोई यूआरएल टाइप करते हैं या चिपकाते हैं, तो Sheets या Slides से उन्हें निर्देश मिलता है कि लिंक को चिप के बजाय, लिंक किए गए टेक्स्ट के तौर पर लिखा जाए. जब लोग लिंक के टाइटल पर कर्सर घुमाते हैं, तो उन्हें एक कार्ड इंटरफ़ेस दिखता है. इसमें लिंक के बारे में जानकारी की झलक दिखती है.
इस इमेज में दिखाया गया है कि Sheets और Slides में लिंक की झलक कैसे रेंडर होती है:
ज़रूरी शर्तें
Apps Script
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस quickstart को अपनाएं.
Node.js
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस quickstart को अपनाएं.
Python
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस quickstart को अपनाएं.
Java
- आपके पास Google Workspace खाता होना चाहिए.
- Google Workspace ऐड-ऑन. ऐड-ऑन बनाने के लिए, इस quickstart को अपनाएं.
ज़रूरी नहीं: तीसरे पक्ष की सेवा के लिए पुष्टि करने की सुविधा सेट अप करना
अगर आपका ऐड-ऑन किसी ऐसी सेवा से कनेक्ट होता है जिसके लिए अनुमति की ज़रूरत है, तो उपयोगकर्ताओं को लिंक की झलक देखने के लिए सेवा की पुष्टि करनी होगी. इसका मतलब है कि जब उपयोगकर्ता किसी Docs, Sheets या Slides की फ़ाइल में पहली बार आपकी सेवा का लिंक चिपकाते हैं, तो आपके ऐड-ऑन को ऑथराइज़ेशन फ़्लो शुरू करना होगा.
OAuth सेवा या अपनी पसंद के मुताबिक अनुमति देने का अनुरोध सेट अप करने के लिए, इनमें से कोई एक गाइड देखें:
अगर आपने अपना ऐड-ऑन Apps Script का इस्तेमाल करके बनाया है, तो Google Workspace ऐड-ऑन की मदद से, Google से बाहर की सेवाओं से कनेक्ट करना देखें.
अगर आपने अपना ऐड-ऑन किसी दूसरे रनटाइम का इस्तेमाल करके बनाया है, तो अपने ऐड-ऑन को तीसरे पक्ष की सेवा से कनेक्ट करना देखें.
अपने ऐड-ऑन के लिए लिंक की झलक सेट अप करना
इस सेक्शन में अपने ऐड-ऑन के लिए लिंक की झलक सेट अप करने का तरीका बताया गया है. इसमें, ये चरण शामिल हैं:
- अपने ऐड-ऑन के डिप्लॉयमेंट संसाधन या मेनिफ़ेस्ट फ़ाइल में लिंक की झलक कॉन्फ़िगर करें.
- अपने लिंक के लिए, स्मार्ट चिप और कार्ड का इंटरफ़ेस बनाएं.
लिंक की झलक कॉन्फ़िगर करें
लिंक की झलक कॉन्फ़िगर करने के लिए, अपने ऐड-ऑन के डिप्लॉयमेंट संसाधन या मेनिफ़ेस्ट फ़ाइल में नीचे दिए गए सेक्शन और फ़ील्ड शामिल करें:
addOnsसेक्शन में, Docs को बड़ा करने के लिएdocsफ़ील्ड, Sheets को बड़ा करने के लिएsheetsफ़ील्ड, और Slides को बड़ा करने के लिएslidesफ़ील्ड जोड़ें.हर फ़ील्ड में,
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"
}
}
]
},
"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"
}
}
]
}
}
}
उदाहरण में, Google Workspace ऐड-ऑन में किसी कंपनी की सहायता अनुरोध सेवा के लिंक की झलक दिखती है. लिंक की झलक देखने के लिए, ऐड-ऑन तीन यूआरएल पैटर्न तय करता है. जब भी कोई लिंक किसी एक यूआरएल पैटर्न से मेल खाता है, तो कॉलबैक फ़ंक्शन caseLinkPreview कार्ड और स्मार्ट चिप बनाता और दिखाता है. Sheets और Slides में, यूआरएल की जगह लिंक का टाइटल भी डाल दिया जाता है.
स्मार्ट चिप और कार्ड बनाएं
किसी लिंक का स्मार्ट चिप और कार्ड दिखाने के लिए, आपको linkPreviewTriggers ऑब्जेक्ट में बताए गए सभी फ़ंक्शन लागू करने होंगे.
जब कोई उपयोगकर्ता किसी तय किए गए यूआरएल पैटर्न से मैच करने वाले लिंक से इंटरैक्ट करता है, तो
linkPreviewTriggers ट्रिगर सक्रिय होता है और उसका कॉलबैक फ़ंक्शन, इवेंट
ऑब्जेक्ट EDITOR_NAME.matchedUrl.url को तर्क के तौर पर पास करता है. इस इवेंट ऑब्जेक्ट के पेलोड का इस्तेमाल इसलिए किया जाता है, ताकि लिंक की झलक दिखाने के लिए स्मार्ट चिप और कार्ड बनाया जा सके.
उदाहरण के लिए, अगर कोई उपयोगकर्ता Docs में https://www.example.com/cases/123456 लिंक की झलक देखता है, तो यह इवेंट पेलोड दिखता है:
JSON
{
"docs": {
"matchedUrl": {
"url": "https://www.example.com/support/cases/123456"
}
}
}
कार्ड का इंटरफ़ेस बनाने के लिए, आपको लिंक के बारे में जानकारी दिखाने के लिए विजेट का इस्तेमाल करना होता है. आपके पास ऐसी कार्रवाइयां भी बनाने का विकल्प है जिनसे उपयोगकर्ता लिंक को खोल सकते हैं या लिंक के कॉन्टेंट में बदलाव कर सकते हैं. उपलब्ध विजेट और कार्रवाइयों की सूची के लिए, झलक कार्ड के लिए इस्तेमाल किए जा सकने वाले कॉम्पोनेंट देखें.
लिंक की झलक के लिए स्मार्ट चिप और कार्ड बनाने के लिए:
- वह फ़ंक्शन लागू करें जो आपने ऐड-ऑन के डिप्लॉयमेंट रिसॉर्स या मेनिफ़ेस्ट फ़ाइल के
linkPreviewTriggersसेक्शन में बताया है:- फ़ंक्शन को ऐसे इवेंट ऑब्जेक्ट को स्वीकार करना होगा जिसमें
EDITOR_NAME.matchedUrl.urlएक तर्क के तौर पर हो और एकCardऑब्जेक्ट दिखाए. - अगर आपकी सेवा को अनुमति की ज़रूरत है, तो फ़ंक्शन को ऑथराइज़ेशन फ़्लो शुरू करना भी चाहिए.
- फ़ंक्शन को ऐसे इवेंट ऑब्जेक्ट को स्वीकार करना होगा जिसमें
- हर झलक कार्ड के लिए, इंटरफ़ेस के लिए विजेट इंटरैक्टिविटी देने वाले किसी भी कॉलबैक फ़ंक्शन को लागू करें. उदाहरण के लिए, अगर आपने "लिंक देखें" बटन शामिल किया है, तो लिंक को नई विंडो में खोलने के लिए, कोई ऐसी कार्रवाई सेट की जा सकती है जो कॉलबैक फ़ंक्शन के बारे में बताती हो. विजेट इंटरैक्शन के बारे में ज़्यादा जानने के लिए, ऐड-ऑन कार्रवाइयां देखें.
यह कोड, Docs के लिए कॉलबैक फ़ंक्शन 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 ऐड-ऑन दिया गया है. इसमें किसी कंपनी के सहायता अनुरोधों के लिंक की झलक, Google Docs में दिखती है.
इस उदाहरण में यह जानकारी दी गई है:
- सहायता मामलों, जैसे कि
https://www.example.com/support/cases/1234के लिंक की झलक दिखाता है. स्मार्ट चिप, सहायता आइकॉन दिखाता है और झलक वाले कार्ड में केस आईडी और उसका ब्यौरा होता है. - अगर उपयोगकर्ता की स्थान-भाषा स्पैनिश पर सेट है, तो स्मार्ट चिप उसके
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/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"
}
]
}
}
}
कोड
Apps Script
Node.js
Python
Java
इसी विषय से जुड़े लिंक
- स्मार्ट चिप की मदद से, Google Books पर मौजूद लिंक की झलक देखना
- ऐड-ऑन को टेस्ट करना
- Google Docs डिप्लॉयमेंट संसाधन
- लिंक की झलक के लिए कार्ड इंटरफ़ेस