Google Workspace অ্যাড-অনগুলিতে ইন্টারেক্টিভ আচরণ তৈরি করতে অ্যাকশন অবজেক্ট ব্যবহার করুন।
অ্যাকশন অবজেক্টগুলি সংজ্ঞায়িত করে যে যখন কোনও ব্যবহারকারী অ্যাড-অন UI-তে একটি উইজেটের (উদাহরণস্বরূপ, একটি বোতাম) সাথে ইন্টারঅ্যাক্ট করে তখন কী ঘটে।
একটি উইজেটে একটি অ্যাকশন যোগ করুন
একটি উইজেটে একটি অ্যাকশন সংযুক্ত করতে, একটি উইজেট হ্যান্ডলার ফাংশন ব্যবহার করুন, যা অ্যাকশনটি ট্রিগার করার শর্তটিও সংজ্ঞায়িত করে। ট্রিগার করা হলে, অ্যাকশনটি একটি নির্দিষ্ট কলব্যাক ফাংশন কার্যকর করে। কলব্যাক ফাংশনটি একটি ইভেন্ট অবজেক্ট পাস করে যা ব্যবহারকারীর ক্লায়েন্ট-সাইড ইন্টারঅ্যাকশন সম্পর্কে তথ্য বহন করে। আপনাকে কলব্যাক ফাংশনটি বাস্তবায়ন করতে হবে এবং এটিকে একটি নির্দিষ্ট প্রতিক্রিয়া অবজেক্ট ফেরত দিতে হবে।
উদাহরণ: একটি বোতামে ক্লিক করলে একটি নতুন কার্ড প্রদর্শন করুন
যদি আপনি আপনার অ্যাড-অনে এমন একটি বোতাম যোগ করতে চান যা ক্লিক করলে একটি নতুন কার্ড তৈরি করে এবং প্রদর্শন করে, তাহলে নীচের পদক্ষেপগুলি অনুসরণ করুন:
- একটি বোতাম উইজেট তৈরি করুন।
- কার্ড তৈরির অ্যাকশন সেট করতে, বোতাম উইজেট হ্যান্ডলার ফাংশন
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();
}