Google Workspace অ্যাড-অনগুলির জন্য ম্যানিফেস্ট

একটি অ্যাড-অন একটি ম্যানিফেস্ট ফাইল ব্যবহার করে অ্যাপ এবং এর ক্রিয়াকলাপ সম্পর্কে নির্দিষ্ট বিবরণ কনফিগার করতে।

এই ডকুমেন্টেশনে Google Workspace অ্যাড-অনের জন্য ম্যানিফেস্ট কনফিগার করার বিশদ বিবরণ রয়েছে।

Google Workspace অ্যাড-অনগুলির জন্য ম্যানিফেস্ট কাঠামো

Google Workspace অ্যাড-অন অ্যাড-অনের চেহারা এবং আচরণের বিভিন্ন দিক নির্ধারণ করতে ম্যানিফেস্ট ফাইল ব্যবহার করে।

ম্যানিফেস্ট অবজেক্ট স্ট্রাকচারের addOns বিভাগের অধীনে Google Workspace অ্যাড-অনগুলির ম্যানিফেস্ট প্রপার্টিগুলি সংগঠিত হয়।

• অ্যাপস স্ক্রিপ্ট ম্যানিফেস্ট ফাইল সম্পর্কে তথ্যের জন্য, ম্যানিফেস্ট কাঠামো পড়ুন।
• HTTP এন্ডপয়েন্টের সাথে তৈরি অ্যাড-অনগুলির জন্য ম্যানিফেস্ট ফাইল সম্পর্কে তথ্যের জন্য, REST রিসোর্স দেখুন: projects.deployments

Google Workspace অ্যাড-অন ম্যানিফেস্ট কনফিগারেশনের নমুনা

নিম্নলিখিত ম্যানিফেস্ট নমুনা একটি ম্যানিফেস্ট ফাইলের বিভাগ দেখায় যা নিম্নলিখিত দিকগুলি সহ Google Workspace অ্যাড-অনগুলিকে সংজ্ঞায়িত করে:

• ম্যানিফেস্টের addOns.common বিভাগটি অ্যাড-অনের জন্য নাম, লোগো URL, রং এবং অন্যান্য সাধারণ, হোস্ট-স্বাধীন সেটিংস সংজ্ঞায়িত করে।
• ম্যানিফেস্ট একটি সাধারণ হোমপেজ সংজ্ঞায়িত করে, তবে ক্যালেন্ডার, ড্রাইভ, ডক্স, শীট এবং স্লাইড-নির্দিষ্ট হোমপেজগুলিকেও সংজ্ঞায়িত করে৷ Gmail ডিফল্ট হোমপেজ ব্যবহার করে।
• নমুনা ম্যানিফেস্ট সেটিংস নিম্নলিখিত সক্ষম করে:
  • ক্যালেন্ডার eventOpen এবং eventUpdated ট্রিগার।
  • (শুধুমাত্র অ্যাপস স্ক্রিপ্ট) দুটি ক্যালেন্ডার সম্মেলন সমাধান ।
  • দুটি সার্বজনীন কর্ম।
  • onItemsSelectedTrigger একটি ড্রাইভ।
  • একটি Gmail রচনা কর্ম এবং প্রাসঙ্গিক ট্রিগার।
  • একটি ডক্স linkPreviewTriggers অবজেক্ট। এই ট্রিগার সম্পর্কে জানতে, স্মার্ট চিপগুলির সাথে প্রিভিউ লিঙ্কগুলি দেখুন।
  • একটি ডক্স createActionTriggers অবজেক্ট। এই ট্রিগার সম্পর্কে জানতে, @ মেনু থেকে তৃতীয় পক্ষের সংস্থান তৈরি করুন দেখুন।
  • ডক্স, শীট এবং স্লাইডের জন্য ফাইল-নির্দিষ্ট ইন্টারফেস।
• oauthScopes ক্ষেত্রটি প্রকল্পের জন্য অনুমোদনের সুযোগ নির্ধারণ করে (সাধারণত অ্যাড-অনগুলির জন্য প্রয়োজনীয়)।
• (শুধুমাত্র অ্যাপস স্ক্রিপ্ট) urlFetchWhitelist ক্ষেত্র হল এমন একটি ক্ষেত্র যা নিশ্চিত করে যে কোনও আনা শেষ পয়েন্ট HTTPS URL উপসর্গগুলির একটি নির্দিষ্ট তালিকার সাথে মেলে। আরও তথ্যের জন্য, অনুমোদনের তালিকা দেখুন।

অ্যাপস স্ক্রিপ্ট এবং HTTP Google Workspace অ্যাড-অনগুলির জন্য সংশ্লিষ্ট ম্যানিফেস্ট রেফারেন্স ডকুমেন্টেশনে সেই ফিল্ডের বর্ণনার সাথে নমুনার লিঙ্কগুলি সরাসরি।

দ্রষ্টব্য: ম্যানিফেস্ট অন্যান্য উপাদান অন্তর্ভুক্ত. addOns ফিল্ডের অধীনে থাকা ক্ষেত্রগুলি সরাসরি Google Workspace অ্যাড-অনগুলির সাথে সম্পর্কিত। এই উদাহরণটি একটি সম্পূর্ণ ম্যানিফেস্ট ফাইলের একটি অংশ এবং এটি একটি সম্পূর্ণ কার্যকরী ম্যানিফেস্ট নয়৷

অ্যাপস স্ক্রিপ্ট

{
  "addOns": {
    "calendar": {
      "createSettingsUrlFunction": "getConferenceSettingsPageUrl",
      "conferenceSolution": [{
        "id": "my-video-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Video Conference",
        "onCreateFunction": "onCreateMyVideoConference"
      }, {
        "id": "my-streamed-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Streamed Conference",
        "onCreateFunction": "onCreateMyStreamedConference"
      }],
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "onDefaultHomePageOpen",
        "enabled": true
      },
      "layoutProperties": {
        "primaryColor": "#ff392b",
        "secondaryColor": "#d68617"
      },
      "logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
      "name": "Demo Google Workspace Add-on",
      "openLinkUrlPrefixes": [
        "https://mail.google.com/",
        "https://script.google.com/a/google.com/d/",
        "https://drive.google.com/a/google.com/file/d/",
        "https://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "selectActions": [
          {
            "text": "Add images to email",
            "runFunction": "getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
        "runFunction": "onLinkPreview",
        "patterns": [
            {
              "hostPattern": "example.com",
              "pathPrefix": "example-path"
            }
        ],
        "labelText": "Link preview",
        "localizedLabelText": {
          "es": "Link preview localized in Spanish"
        },
        "logoUrl": "https://www.example.com/images/smart-chip-icon.png"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "exampleFunction",
          "logoUrl": "https://www.example.com/images/case.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/calendar.addons.execute",
    "https://www.googleapis.com/auth/calendar.addons.current.event.read",
    "https://www.googleapis.com/auth/calendar.addons.current.event.write",
    "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
    "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.locale",
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/documents.currentonly",
    "https://www.googleapis.com/auth/spreadsheets.currentonly",
    "https://www.googleapis.com/auth/presentations.currentonly",
    "https://www.googleapis.com/auth/workspace.linkpreview"
  ],
  "urlFetchWhitelist": [
    "https://www.example.com/myendpoint/"
  ]
}

HTTP

{
  "addOns": {
    "calendar": {
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDefaultHomePageOpen",
        "enabled": true
      },
      "layoutProperties": {
        "primaryColor": "#ff392b",
        "secondaryColor": "#d68617"
      },
      "logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
      "name": "Demo Google Workspace Add-on",
      "openLinkUrlPrefixes": [
        "https://mail.google.com/",
        "https://script.google.com/a/google.com/d/",
        "https://drive.google.com/a/google.com/file/d/",
        "https://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "actions": [
          {
            "label": "Add images to email",
            "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "https://myownpersonaldomain.com/mypage?trigger=onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onLinkPreview",
          "patterns": [
              {
                "hostPattern": "example.com",
                "pathPrefix": "example-path"
              }
          ],
          "labelText": "Link preview",
          "localizedLabelText": {
            "es": "Link preview localized in Spanish"
          },
          "logoUrl": "https://www.example.com/images/smart-chip-icon.png"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCreateAction",
          "logoUrl": "https://www.example.com/images/case.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      }
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/calendar.addons.execute",
    "https://www.googleapis.com/auth/calendar.addons.current.event.read",
    "https://www.googleapis.com/auth/calendar.addons.current.event.write",
    "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
    "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.locale",
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/documents.currentonly",
    "https://www.googleapis.com/auth/spreadsheets.currentonly",
    "https://www.googleapis.com/auth/presentations.currentonly",
    "https://www.googleapis.com/auth/workspace.linkpreview"
  ]
}

অনুমোদিত ইউআরএল

আপনার স্ক্রিপ্ট বা অ্যাড-অন দ্বারা অ্যাক্সেসের জন্য পূর্ব-অনুমোদিত নির্দিষ্ট ইউআরএলগুলিকে মনোনীত করতে আপনি অনুমতি তালিকা ব্যবহার করেন। অনুমোদিত তালিকাগুলি ব্যবহারকারীর ডেটা সুরক্ষিত করতে সহায়তা করে; আপনি যখন একটি অনুমোদিত তালিকা সংজ্ঞায়িত করেন, তখন স্ক্রিপ্ট প্রকল্পগুলি অনুমোদিত তালিকাভুক্ত করা হয়নি এমন URLগুলি অ্যাক্সেস করতে পারে না।

আপনি একটি পরীক্ষা স্থাপনা ইনস্টল করার সময় এই ক্ষেত্রটি ঐচ্ছিক, কিন্তু যখন আপনি একটি সংস্করণযুক্ত স্থাপনা তৈরি করেন তখন এটি প্রয়োজনীয়।

যখন আপনার স্ক্রিপ্ট বা অ্যাড-অন নিম্নলিখিত কাজগুলি সম্পাদন করে তখন আপনি অনুমোদিত তালিকা ব্যবহার করেন:

• Apps Script UrlFetch পরিষেবা ব্যবহার করে একটি বাহ্যিক অবস্থান (যেমন HTTPS এন্ডপয়েন্ট) থেকে তথ্য পুনরুদ্ধার বা আনয়ন করে। আনার জন্য ইউআরএলগুলিকে অনুমতি দিতে, আপনার ম্যানিফেস্ট ফাইলে urlFetchWhitelist ক্ষেত্রটি অন্তর্ভুক্ত করুন।
• ব্যবহারকারীর ক্রিয়াকলাপের প্রতিক্রিয়া হিসাবে একটি URL খোলে বা প্রদর্শন করে (Google Workspace অ্যাড-অনগুলির জন্য প্রয়োজনীয় যা Google-এর বাইরের ইউআরএলগুলি খোলে বা প্রদর্শন করে)। ইউআরএল খোলার অনুমতি দিতে, আপনার ম্যানিফেস্ট ফাইলে addOns.common.openLinkUrlPrefixes ফিল্ড অন্তর্ভুক্ত করুন।

দ্রষ্টব্য: হোয়াইটলিস্ট , যেমনটি urlFetchWhitelist এ ব্যবহৃত হয়, এটি একটি অবনমিত শব্দ যা সমার্থক এবং অনুমোদিত তালিকা দ্বারা প্রতিস্থাপিত। আরও তথ্যের জন্য, অন্তর্ভুক্ত ডকুমেন্টেশন লেখা দেখুন।

আপনার অনুমোদিত তালিকায় উপসর্গ যোগ করা হচ্ছে

যখন আপনি আপনার ম্যানিফেস্ট ফাইলে ( addOns.common.openLinkUrlPrefixes বা urlFetchWhitelist ফিল্ড অন্তর্ভুক্ত করে) অনুমতি তালিকা নির্দিষ্ট করেন, তখন আপনাকে অবশ্যই URL প্রিফিক্সের একটি তালিকা অন্তর্ভুক্ত করতে হবে। আপনি ম্যানিফেস্টে যে উপসর্গগুলি যোগ করবেন সেগুলি অবশ্যই নিম্নলিখিত প্রয়োজনীয়তাগুলি পূরণ করবে:

• প্রতিটি উপসর্গ একটি বৈধ URL হতে হবে।
• প্রতিটি উপসর্গ অবশ্যই https:// ব্যবহার করবে, http:// নয়।
• প্রতিটি উপসর্গের একটি সম্পূর্ণ ডোমেন থাকতে হবে।
• প্রতিটি উপসর্গের একটি অ-খালি পথ থাকতে হবে। উদাহরণস্বরূপ, https://www.google.com/ বৈধ কিন্তু https://www.google.com নয়৷
• ইউআরএল সাবডোমেন প্রিফিক্সের সাথে মেলে ওয়াইল্ডকার্ড ব্যবহার করতে পারেন।
• একটি একক * ওয়াইল্ডকার্ড ব্যবহার করা যেতে পারে addOns.common.openLinkUrlPrefixes ফিল্ডে সমস্ত লিঙ্কের সাথে মেলে, কিন্তু এটি সুপারিশ করা হয় না কারণ এটি একটি ব্যবহারকারীর ডেটাকে ঝুঁকিতে ফেলতে পারে এবং অ্যাড-অন পর্যালোচনা প্রক্রিয়াকে দীর্ঘায়িত করতে পারে। আপনার অ্যাড-অন কার্যকারিতা প্রয়োজন হলে শুধুমাত্র একটি ওয়াইল্ডকার্ড ব্যবহার করুন।

একটি ইউআরএল অনুমোদিত প্রিফিক্সের সাথে মেলে কিনা তা নির্ধারণ করার সময়, নিম্নলিখিত নিয়মগুলি প্রযোজ্য:

• পাথ ম্যাচিং কেস-সংবেদনশীল।
• যদি উপসর্গটি URL-এর সাথে অভিন্ন হয় তবে এটি একটি মিল।
• ইউআরএল একই বা উপসর্গের একটি শিশু হলে, এটি একটি মিল।

উদাহরণস্বরূপ, https://example.com/foo উপসর্গ নিম্নলিখিত URLগুলির সাথে মেলে:

• https://example.com/foo
• https://example.com/foo/
• https://example.com/foo/bar
• https://example.com/foo?bar
• https://example.com/foo#bar

ওয়াইল্ডকার্ড ব্যবহার করে

আপনি urlFetchWhitelist এবং addOns.common.openLinkUrlPrefixes উভয় ক্ষেত্রের জন্য একটি সাবডোমেনের সাথে মেলে একটি একক ওয়াইল্ডকার্ড অক্ষর ( * ) ব্যবহার করতে পারেন৷ আপনি একাধিক সাবডোমেনের সাথে মেলে একাধিক ওয়াইল্ডকার্ড ব্যবহার করতে পারবেন না এবং ওয়াইল্ডকার্ডটি অবশ্যই URL-এর অগ্রণী উপসর্গের প্রতিনিধিত্ব করবে৷

উদাহরণস্বরূপ, উপসর্গ https://*.example.com/foo নিম্নলিখিত URLগুলির সাথে মেলে:

• https://subdomain.example.com/foo
• https://any.number.of.subdomains.example.com/foo

https://*.example.com/foo উপসর্গটি নিম্নলিখিত URLগুলির সাথে মেলে না :

• https://subdomain.example.com/bar (প্রত্যয় অমিল)
• https://example.com/foo (অন্তত একটি সাবডোমেন উপস্থিত থাকতে হবে)

আপনি যখন আপনার ম্যানিফেস্ট সংরক্ষণ করার চেষ্টা করেন তখন কিছু প্রিফিক্স নিয়ম প্রয়োগ করা হয়। উদাহরণস্বরূপ, আপনি সংরক্ষণ করার চেষ্টা করার সময় নিম্নলিখিত উপসর্গগুলি আপনার ম্যানিফেস্টে উপস্থিত থাকলে একটি ত্রুটি সৃষ্টি করে:

• https://*.*.example.com/foo (একাধিক ওয়াইল্ডকার্ড নিষিদ্ধ)
• https://subdomain.*.example.com/foo (ওয়াইল্ডকার্ড একটি অগ্রণী উপসর্গ হিসাবে ব্যবহার করা আবশ্যক)