Google Workspace অ্যাড-অন এন্ডপয়েন্ট ইন্টারফেস


পরিষেবা ওভারভিউ

কোনও ব্যবহারকারী কাজ করে এমন হোস্ট অ্যাপ্লিকেশনে (Gmail, Google Calendar, Google Drive, Google Chat, Google Docs, Google Sheets, Google Slides বা Workspace Studio) ইন্টার‍্যাকশন ট্রিগার করলে, হোস্ট আপনার কনফিগার করা অ্যাড-অন কলব্যাক URL-এ (/*) HTTP POST ইভেন্ট পেলোড পাঠায়।

আপনার অ্যাড-অন এন্ডপয়েন্টকে অবশ্যই একটি EventObject অনুরোধ পেলোড পেতে হবে এবং Response: HandleEventResponse-এ ডকুমেন্ট করা পাঁচটি সঠিক JSON রেসপন্স টাইপের মধ্যে একটি ফেরত দিতে হবে।


ওয়েবহুক এন্ডপয়েন্ট চুক্তি

পদ্ধতি এন্ডপয়েন্ট পাথ অনুরোধের বডি প্রতিক্রিয়ার বডি
POST /* (অথবা কনফিগার করা কলব্যাক পাথ) EventObject ৫টি উত্তরের ধরনের মধ্যে একটি

অনুরোধ: EventObject

একটি EventObject-এ টপ-লেভেল মেটাডেটা, সাধারণ ইভেন্ট ফিল্ড এবং হোস্ট-অ্যাপ্লিকেশন প্রাসঙ্গিক বিবরণ থাকে:

সাধারণ ও অনুমোদনের প্রসঙ্গ

  • commonEventObject: ব্যবহারকারীর লোকেল, হোস্ট অ্যাপ্লিকেশন enum (GMAIL, CALENDAR, DRIVE, CHAT, DOCS, SHEETS, SLIDES, WORKFLOW), ব্যবহারকারীর প্ল্যাটফর্ম, টাইমজোন, উইজেট ফর্ম ইনপুট ভ্যালু (formInputs) এবং কাস্টম প্যারামিটার। CommonEventObject দেখুন।
  • authorizationEventObject: ব্যবহারকারীর OAuth অ্যাক্সেস টোকেন, ব্যবহারকারীর আইডি টোকেন এবং সিস্টেম-অনুমোদিত স্কোপ। AuthorizationEventObject দেখুন।

হোস্ট অ্যাপ্লিকেশন ইভেন্ট অবজেক্ট

কোন অ্যাপ্লিকেশন কলব্যাককে আহ্বান করে তার উপর নির্ভর করে, নিম্নলিখিত হোস্ট অবজেক্টগুলির মধ্যে একটি উপস্থিত থাকে:

  • Gmail: মেসেজ আইডি, থ্রেড আইডি, সাময়িক অ্যাক্সেস টোকেন এবং মেসেজ প্রাপকের তালিকা (toRecipients, ccRecipients, bccRecipients)। GmailEventObject দেখুন।
  • Calendar: ইভেন্ট আইডি, পৌনঃপুনিক ইভেন্ট আইডি, ক্যালেন্ডার আইডি, আয়োজকের তথ্য, অংশগ্রহণকারী, কনফারেন্স ডেটা এবং এন্ট্রি পয়েন্ট। CalendarEventObject দেখুন।
  • Drive: বেছে নেওয়া ফাইল বা ফোল্ডার (selectedItems) এবং কার্সার বর্তমানে যে আইটেমে আছে সেটির মেটাডেটা (activeCursorItem)। DriveEventObject দেখুন।
  • Chat: ইভেন্টের ধরন (ADDED_TO_SPACE, REMOVED_FROM_SPACE, MESSAGE, CARD_CLICKED), স্পেস মেটাডেটা, ব্যবহারকারীর বিবরণ ও পেলোড ডেটা। ChatEventObject দেখুন।
  • Workspace Studio: অ্যাকশন ইনভোকেশন, ট্রিগার লাইফসাইকেল ইভেন্ট, এলিমেন্ট কনফিগারেশন, রিসোর্স রিট্রিভাল এবং ভেরিয়েবল ডেটা ম্যাপ। WorkflowEventObject দেখুন।
  • Docs: ডকুমেন্ট আইডি, শীর্ষক, ফাইল-স্কোপ অনুমতির ফ্ল্যাগ এবং মিলে যাওয়া URL প্যাটার্ন। DocsEventObject দেখুন।
  • Sheets: স্প্রেডশিট আইডি, শীর্ষক, ফাইল-স্কোপ অনুমতি ফ্ল্যাগ, এবং মিলে যাওয়া URL প্যাটার্ন। SheetsEventObject দেখুন।
  • Slides: প্রেজেন্টেশন আইডি, শীর্ষক, ফাইল-স্কোপ অনুমতি ফ্ল্যাগ, এবং মিলে যাওয়া URL প্যাটার্ন। SlidesEventObject দেখুন।

উত্তর: HandleEventResponse

আপনার ওয়েবহুক এন্ডপয়েন্ট থেকে পাওয়া HTTP রেসপন্স হল একটি ট্যাগ না করা রুট JSON অবজেক্ট যা অবশ্যই নিম্নলিখিত পাঁচটি রেসপন্স ধরনের মধ্যে একটি হতে হবে:

  1. RenderActions: নতুন কার্ড রেন্ডার করে, কার্ড স্ট্যাক নেভিগেট করে বা UI অ্যাকশন (যেমন, {"action": {"navigations": [...]}} বা {"renderActions": ...}) এক্সিকিউট করে।
  2. SubmitFormResponse: কার্ড রেন্ডার করার নির্দেশাবলী এবং একটি ঐচ্ছিক স্টেট আপডেট ইন্ডিকেটর (যেমন, {"renderActions": {...}, "stateChanged": true}) সহ ব্যবহারকারীর ফর্ম জমা দেওয়ার অ্যাকশনের উত্তর দেয়।
  3. GetAutocompletionResponse: উইজেট অটো-কমপ্লিট ফিল্ডের জন্য ডায়নামিক টেক্সট সাজেশন প্রদান করে (যেমন, {"autoComplete": {"items": [...]}})।
  4. DataActions: কলব্যাক (যেমন, {"hostAppDataAction": {...}}) দ্বারা ট্রিগার করা ডকুমেন্ট মিউটেশন বা Chat স্পেস অ্যাকশন সম্পাদন করে।
  5. AuthorizationError: ব্যবহারকারীকে এক্সটার্নাল থার্ড-পার্টি ক্রেডেনশিয়াল অনুমোদন করার জন্য প্রম্পট করে অথবা অতিরিক্ত Google OAuth স্কোপের (যেমন, {"basicAuthorizationPrompt": {"authorizationUrl": "..."}}) জন্য অনুরোধ করে।

স্ট্যান্ডঅ্যালোন OpenAPI 3.0 স্পেসিফিকেশন এবং JSON স্কিমা

আপনার কলব্যাক এন্ডপয়েন্টের জন্য সার্ভার স্টাব, SDK ক্লায়েন্ট লাইব্রেরি বা পেলোড যাচাইকরণ স্কিমা অটোমেটিক জেনারেট করতে, নিম্নলিখিত স্পেসিফিকেশন ফাইল দেখুন:

  • OpenAPI 3.0.3 স্পেসিফিকেশন: addon_callback_openapi.json
  • JSON স্কিমা সংজ্ঞা: endpoint_interface.schema.json
    • স্কিমা ফ্র্যাগমেন্টের অনুরোধ করুন: endpoint_interface.schema.json#/definitions/GoogleAppsAddonsV1EventObject
    • রেসপন্স স্কিমা ফ্র্যাগমেন্ট: endpoint_interface.schema.json#/definitions/GoogleAppsAddonsV1HandleEventResponse