Google Workspace के ऐड-ऑन में इंटरैक्टिव व्यवहार बनाने के लिए, कार्रवाई ऑब्जेक्ट का इस्तेमाल करें.
ऐक्शन ऑब्जेक्ट से यह तय होता है कि जब कोई उपयोगकर्ता ऐड-ऑन के यूज़र इंटरफ़ेस (यूआई) में किसी विजेट (उदाहरण के लिए, बटन) के साथ इंटरैक्ट करता है, तो क्या होता है.
विजेट में कोई कार्रवाई जोड़ना
किसी विजेट में कार्रवाई जोड़ने के लिए, विजेट हैंडलर फ़ंक्शन का इस्तेमाल करें. इससे, कार्रवाई को ट्रिगर करने वाली शर्त भी तय होती है. ट्रिगर होने पर, कार्रवाई किसी तय किए गए कॉलबैक फ़ंक्शन को लागू करती है. कॉलबैक फ़ंक्शन को एक इवेंट ऑब्जेक्ट दिया जाता है, जिसमें उपयोगकर्ता के क्लाइंट-साइड इंटरैक्शन की जानकारी होती है. आपको कॉलबैक फ़ंक्शन लागू करना होगा और उसे कोई खास रिस्पॉन्स ऑब्जेक्ट दिखाना होगा.
उदाहरण: किसी बटन पर क्लिक करने पर नया कार्ड दिखाना
अगर आपको अपने ऐड-ऑन में ऐसा बटन जोड़ना है जिस पर क्लिक करने पर नया कार्ड बन जाए और दिख जाए, तो यह तरीका अपनाएं:
- बटन विजेट बनाएं.
- कार्ड बनाने की कार्रवाई सेट करने के लिए, बटन विजेट हैंडलर फ़ंक्शन जोड़ें
setOnClickAction(action)
. - Apps Script कॉलबैक फ़ंक्शन बनाएं और उसे विजेट हैंडलर फ़ंक्शन में
(action)
के तौर पर सेट करें. इस मामले में, कॉलबैक फ़ंक्शन को आपका पसंदीदा कार्ड बनाना चाहिए औरActionResponse
ऑब्जेक्ट दिखाना चाहिए. रिस्पॉन्स ऑब्जेक्ट, ऐड-ऑन को कॉलबैक फ़ंक्शन से बनाया गया कार्ड दिखाने के लिए कहता है.
नीचे दिए गए उदाहरण में, बटन विजेट बनाने का तरीका बताया गया है. कार्रवाई, ऐड-ऑन की ओर से मौजूदा फ़ाइल के लिए drive.file
स्कोप का अनुरोध करती है.
/** * Adds a section to the Card Builder that displays a "REQUEST PERMISSION" button. * When it's clicked, the callback triggers file scope permission flow. This is used in * the add-on when the home-page displays basic data. */ function addRequestFileScopeButtonToBuilder(cardBuilder) { var buttonSection = CardService.newCardSection(); // If the add-on does not have access permission, add a button that // allows the user to provide that permission on a per-file basis. var buttonAction = CardService.newAction() .setFunctionName("onRequestFileScopeButtonClickedInEditor"); var button = CardService.newTextButton() .setText("Request permission") .setBackgroundColor("#4285f4") .setTextButtonStyle(CardService.TextButtonStyle.FILLED) .setOnClickAction(buttonAction); buttonSection.addWidget(button); cardBuilder.addSection(buttonSection); } /** * Callback function for a button action. Instructs Docs to display a * permissions dialog to the user, requesting `drive.file` scope for the * current file on behalf of this add-on. * * @param {Object} e The parameters object that contains the document’s ID * @return {editorFileScopeActionResponse} */ function onRequestFileScopeButtonClickedInEditor(e) { return CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build();
REST API के लिए फ़ाइल ऐक्सेस करने से जुड़े इंटरैक्शन
Google Workspace के ऐसे ऐड-ऑन जो Editors की सुविधाओं को बेहतर बनाते हैं और REST API का इस्तेमाल करते हैं, उनमें फ़ाइल ऐक्सेस करने का अनुरोध करने के लिए, विजेट की एक और कार्रवाई शामिल की जा सकती है. इस कार्रवाई के लिए, कार्रवाई से जुड़े कॉलबैक फ़ंक्शन को खास रिस्पॉन्स ऑब्जेक्ट दिखाना ज़रूरी है:
कार्रवाई की कोशिश की गई | कॉलबैक फ़ंक्शन को यह वैल्यू दिखानी चाहिए |
---|---|
current_document के लिए फ़ाइल का ऐक्सेस पाने का अनुरोध करना | EditorFileScopeActionResponse |
इस विजेट ऐक्शन और रिस्पॉन्स ऑब्जेक्ट का इस्तेमाल करने के लिए, ये सभी बातें ज़रूरी हैं:
- यह ऐड-ऑन, REST API का इस्तेमाल करता है.
- ऐड-ऑन,
CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build();
तरीके का इस्तेमाल करके, अनुरोध फ़ाइल के दायरे का डायलॉग बॉक्स दिखाता है. - ऐड-ऑन के मेनिफ़ेस्ट में,
https://www.googleapis.com/auth/drive.file
एडिटर स्कोप औरonFileScopeGranted
ट्रिगर शामिल होता है.
मौजूदा दस्तावेज़ के लिए फ़ाइल का ऐक्सेस पाने का अनुरोध करना
मौजूदा दस्तावेज़ के लिए फ़ाइल का ऐक्सेस पाने का अनुरोध करने के लिए, यह तरीका अपनाएं:
- होम पेज का ऐसा कार्ड बनाएं जो यह जांच करता हो कि ऐड-ऑन में
drive.file
स्कोप है या नहीं. - जिन मामलों में एड-ऑन को
drive.file
स्कोप नहीं दिया गया है उनके लिए, उपयोगकर्ताओं से मौजूदा दस्तावेज़ के लिएdrive.file
स्कोप देने का अनुरोध करने का तरीका बनाएं.
उदाहरण: Google Docs में मौजूदा दस्तावेज़ का ऐक्सेस पाना
यहां दिए गए उदाहरण में, Google Docs के लिए एक इंटरफ़ेस बनाया गया है. यह मौजूदा दस्तावेज़ का साइज़ दिखाता है. अगर ऐड-ऑन के पास drive.file
अनुमति नहीं है, तो वह फ़ाइल के दायरे की अनुमति शुरू करने के लिए एक बटन दिखाता है.
/**
* Build a simple card that checks selected items' quota usage. Checking
* quota usage requires user-permissions, so this add-on provides a button
* to request `drive.file` scope for items the add-on doesn't yet have
* permission to access.
*
* @param e The event object passed containing information about the
* current document.
* @return {Card}
*/
function onDocsHomepage(e) {
return createAddOnView(e);
}
function onFileScopeGranted(e) {
return createAddOnView(e);
}
/**
* For the current document, display either its quota information or
* a button that allows the user to provide permission to access that
* file to retrieve its quota details.
*
* @param e The event containing information about the current document
* @return {Card}
*/
function createAddOnView(e) {
var docsEventObject = e['docs'];
var builder = CardService.newCardBuilder();
var cardSection = CardService.newCardSection();
if (docsEventObject['addonHasFileScopePermission']) {
cardSection.setHeader(docsEventObject['title']);
// This add-on uses the recommended, limited-permission `drive.file`
// scope to get granular per-file access permissions.
// See: https://developers.google.com/drive/api/v2/about-auth
// If the add-on has access permission, read and display its quota.
cardSection.addWidget(
CardService.newTextParagraph().setText(
"This file takes up: " + getQuotaBytesUsed(docsEventObject['id'])));
} else {
// If the add-on does not have access permission, add a button that
// allows the user to provide that permission on a per-file basis.
cardSection.addWidget(
CardService.newTextParagraph().setText(
"The add-on needs permission to access this file's quota."));
var buttonAction = CardService.newAction()
.setFunctionName("onRequestFileScopeButtonClicked");
var button = CardService.newTextButton()
.setText("Request permission")
.setOnClickAction(buttonAction);
cardSection.addWidget(button);
}
return builder.addSection(cardSection).build();
}
/**
* Callback function for a button action. Instructs Docs to display a
* permissions dialog to the user, requesting `drive.file` scope for the
* current file on behalf of this add-on.
*
* @param {Object} e The parameters object that contains the document’s ID
* @return {editorFileScopeActionResponse}
*/
function onRequestFileScopeButtonClicked(e) {
return CardService.newEditorFileScopeActionResponseBuilder()
.requestFileScopeForActiveDocument().build();
}