সম্পাদক কর্ম

Google Workspace অ্যাড-অনগুলিতে ইন্টারেক্টিভ আচরণ তৈরি করতে অ্যাকশন অবজেক্ট ব্যবহার করুন।

অ্যাকশন অবজেক্টগুলি সংজ্ঞায়িত করে যখন কোনও ব্যবহারকারী অ্যাড-অন UI-তে কোনও উইজেটের (উদাহরণস্বরূপ, একটি বোতাম) সাথে ইন্টারঅ্যাক্ট করে তখন কী ঘটে।

একটি উইজেটে একটি অ্যাকশন যোগ করুন

একটি উইজেটে একটি অ্যাকশন সংযুক্ত করতে, একটি উইজেট হ্যান্ডলার ফাংশন ব্যবহার করুন, যা ক্রিয়াটিকে ট্রিগার করে এমন অবস্থাকেও সংজ্ঞায়িত করে৷ ট্রিগার করা হলে, কর্মটি একটি মনোনীত কলব্যাক ফাংশন চালায়। কলব্যাক ফাংশনটি একটি ইভেন্ট অবজেক্ট পাস করা হয় যা ব্যবহারকারীর ক্লায়েন্ট-সাইড মিথস্ক্রিয়া সম্পর্কে তথ্য বহন করে। আপনাকে অবশ্যই কলব্যাক ফাংশন বাস্তবায়ন করতে হবে এবং এটিকে একটি নির্দিষ্ট প্রতিক্রিয়া বস্তু ফিরিয়ে দিতে হবে।

উদাহরণ: একটি বোতাম ক্লিক করা হলে একটি নতুন কার্ড প্রদর্শন করুন

আপনি যদি আপনার অ্যাড-অনে একটি বোতাম যোগ করতে চান যা ক্লিক করলে একটি নতুন কার্ড তৈরি এবং প্রদর্শন করে, নীচের পদক্ষেপগুলি অনুসরণ করুন:

  1. একটি বোতাম উইজেট তৈরি করুন।
  2. একটি কার্ড-বিল্ডিং অ্যাকশন সেট করতে, বোতামটি যোগ করুন উইজেট হ্যান্ডলার ফাংশন setOnClickAction(action)
  3. একটি Apps স্ক্রিপ্ট কলব্যাক ফাংশন তৈরি করুন এবং উইজেট হ্যান্ডলার ফাংশনের মধ্যে এটিকে (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 অ্যাড-অনগুলি যেগুলি সম্পাদকদের প্রসারিত করে এবং REST API ব্যবহার করে ফাইল অ্যাক্সেসের অনুরোধ করার জন্য একটি অতিরিক্ত উইজেট অ্যাকশন অন্তর্ভুক্ত করতে পারে। এই ক্রিয়াটির জন্য একটি বিশেষ প্রতিক্রিয়া বস্তু ফেরত দেওয়ার জন্য সংশ্লিষ্ট কর্ম কলব্যাক ফাংশন প্রয়োজন:

অ্যাকশনের চেষ্টা করা হয়েছে কলব্যাক ফাংশন ফিরে আসা উচিত
বর্তমান_ডকুমেন্টের জন্য ফাইল অ্যাক্সেসের অনুরোধ করুন EditorFileScopeActionResponse

এই উইজেট অ্যাকশন এবং রেসপন্স অবজেক্ট ব্যবহার করতে, নিচের সবগুলো সত্য হতে হবে:

  • অ্যাড-অন REST API ব্যবহার করে।
  • অ্যাড-অন CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build(); পদ্ধতি
  • অ্যাড-অন এর ম্যানিফেস্টে https://www.googleapis.com/auth/drive.file এডিটর স্কোপ এবং onFileScopeGranted ট্রিগার অন্তর্ভুক্ত করে।

বর্তমান নথির জন্য ফাইল অ্যাক্সেস অনুরোধ

বর্তমান নথির জন্য ফাইল অ্যাক্সেসের অনুরোধ করতে, এই পদক্ষেপগুলি অনুসরণ করুন:

  1. একটি হোমপেজ কার্ড তৈরি করুন যা অ্যাড-অনের drive.file স্কোপ আছে কিনা তা পরীক্ষা করে।
  2. যে ক্ষেত্রে অ্যাড-অনটিকে drive.file স্কোপ দেওয়া হয়নি, ব্যবহারকারীদের বর্তমান নথির জন্য drive.file স্কোপ দেওয়ার অনুরোধ করার একটি উপায় তৈরি করুন।

উদাহরণ: Google ডক্সে বর্তমান নথির অ্যাক্সেস পান

নিম্নলিখিত উদাহরণটি Google ডক্সের জন্য একটি ইন্টারফেস তৈরি করে যা বর্তমান নথির আকার প্রদর্শন করে। অ্যাড-অন-এ 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();
}