Events: list

নির্দিষ্ট ক্যালেন্ডারের ইভেন্টগুলো ফেরত দেয়। এখনই চেষ্টা করে দেখুন ।

অনুরোধ

HTTP অনুরোধ 

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events

প্যারামিটার

প্যারামিটার নাম মূল্য বর্ণনা
পথের পরামিতি
calendarId string ক্যালেন্ডার শনাক্তকারী। ক্যালেন্ডার আইডিগুলো পেতে calendarList.list মেথডটি কল করুন। আপনি যদি বর্তমানে লগ ইন করা ব্যবহারকারীর প্রাথমিক ক্যালেন্ডার অ্যাক্সেস করতে চান, তাহলে " primary " কীওয়ার্ডটি ব্যবহার করুন।
ঐচ্ছিক কোয়েরি প্যারামিটার
alwaysIncludeEmail boolean বাতিল ও উপেক্ষিত।
eventTypes string ফেরত দেওয়ার জন্য ইভেন্টের প্রকারভেদ। ঐচ্ছিক। বিভিন্ন ধরনের ইভেন্ট ফেরত দেওয়ার জন্য এই প্যারামিটারটি একাধিকবার ব্যবহার করা যেতে পারে। সেট না করা হলে, সব ধরনের ইভেন্ট ফেরত দেওয়া হয়।

গ্রহণযোগ্য মানগুলো হলো:
  • " birthday ": প্রতি বছর অনুষ্ঠিত হওয়া দিনব্যাপী বিশেষ অনুষ্ঠান।
  • ' default ': নিয়মিত ইভেন্ট।
  • " focusTime " : ফোকাস টাইমের ইভেন্টসমূহ।
  • " fromGmail ": জিমেইল থেকে আসা ইভেন্টসমূহ।
  • " outOfOffice ": অফিসের বাইরের কার্যক্রম।
  • " workingLocation " : কর্মস্থল সম্পর্কিত ঘটনাসমূহ।
iCalUID string রেসপন্সে প্রদান করার জন্য iCalendar ফরম্যাটে একটি ইভেন্ট আইডি নির্দিষ্ট করে। এটি ঐচ্ছিক। যদি আপনি iCalendar আইডি দ্বারা কোনো ইভেন্ট অনুসন্ধান করতে চান, তবে এটি ব্যবহার করুন।
maxAttendees integer উত্তরে অন্তর্ভুক্ত করার জন্য অংশগ্রহণকারীদের সর্বোচ্চ সংখ্যা। যদি নির্দিষ্ট সংখ্যার চেয়ে বেশি অংশগ্রহণকারী থাকে, তবে শুধুমাত্র অংশগ্রহণকারীকে ফেরত দেওয়া হবে। ঐচ্ছিক।
maxResults integer একটি ফলাফল পৃষ্ঠায় ফেরত আসা ইভেন্টের সর্বোচ্চ সংখ্যা। ফলাফল পৃষ্ঠার ইভেন্টের সংখ্যা এই মানের চেয়ে কম হতে পারে, অথবা একেবারেই শূন্য হতে পারে, এমনকি যদি কোয়েরির সাথে মেলে এমন আরও ইভেন্ট থাকে। রেসপন্সে একটি অ-খালি nextPageToken ফিল্ড দেখে অসম্পূর্ণ পৃষ্ঠা শনাক্ত করা যায়। ডিফল্টরূপে এর মান হলো ২৫০টি ইভেন্ট। পৃষ্ঠার আকার কখনোই ২৫০০টি ইভেন্টের বেশি হতে পারে না। ঐচ্ছিক।
orderBy string ফলাফলে প্রদর্শিত ঘটনাগুলোর ক্রম। এটি ঐচ্ছিক। ডিফল্ট হলো একটি অনির্দিষ্ট, স্থিতিশীল ক্রম।

গ্রহণযোগ্য মানগুলো হলো:
  • " startTime ": শুরুর তারিখ/সময় অনুসারে আরোহী ক্রমে সাজানো। এটি শুধুমাত্র একক ইভেন্ট কোয়েরি করার সময় উপলব্ধ (অর্থাৎ singleEvents প্যারামিটারটি True হলে)।
  • " updated ": সর্বশেষ পরিবর্তনের সময় অনুসারে আরোহী ক্রমে সাজানো।
pageToken string কোন ফলাফল পৃষ্ঠাটি ফেরত দেওয়া হবে তা নির্ধারণকারী টোকেন। ঐচ্ছিক।
privateExtendedProperty string বর্ধিত প্রোপার্টি সীমাবদ্ধতা `propertyName=value` হিসাবে নির্দিষ্ট করা হয়েছে। এটি শুধুমাত্র ব্যক্তিগত প্রোপার্টিগুলোর সাথে মেলে। প্রদত্ত সমস্ত সীমাবদ্ধতার সাথে মেলে এমন ইভেন্টগুলো ফেরত দেওয়ার জন্য এই প্যারামিটারটি একাধিকবার পুনরাবৃত্তি করা যেতে পারে।
q string নিম্নলিখিত ক্ষেত্রগুলিতে এই পদগুলির সাথে মেলে এমন ইভেন্টগুলি খুঁজে পেতে মুক্ত পাঠ্য অনুসন্ধান পদগুলি ব্যবহার করুন:
  • summary
  • description
  • location
  • অংশগ্রহণকারীর displayName
  • অংশগ্রহণকারীর email
  • আয়োজকের displayName
  • আয়োজকের email
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

এই সার্চ টার্মগুলো কর্মস্থল, অফিসের বাইরে এবং ফোকাস-টাইম ইভেন্টের সমস্ত প্রদর্শিত শিরোনামের অনুবাদের সাথে পূর্বনির্ধারিত কীওয়ার্ডগুলোও মেলায়। উদাহরণস্বরূপ, "Office" বা "Bureau" লিখে সার্চ করলে officeLocation টাইপের কর্মস্থলের ইভেন্টগুলো পাওয়া যায়, অন্যদিকে "Out of office" বা "Abwesend" লিখে সার্চ করলে অফিসের বাইরের ইভেন্টগুলো পাওয়া যায়। ঐচ্ছিক।

sharedExtendedProperty string বর্ধিত প্রোপার্টি সীমাবদ্ধতা `propertyName=value` হিসাবে নির্দিষ্ট করা হয়েছে। এটি শুধুমাত্র শেয়ার করা প্রোপার্টিগুলোর সাথে মেলে। প্রদত্ত সমস্ত সীমাবদ্ধতার সাথে মেলে এমন ইভেন্টগুলো ফেরত দেওয়ার জন্য এই প্যারামিটারটি একাধিকবার পুনরাবৃত্তি করা যেতে পারে।
showDeleted boolean ফলাফলে মুছে ফেলা ইভেন্টগুলো (যেগুলোর status " cancelled ") অন্তর্ভুক্ত করা হবে কিনা। যদি showDeleted এবং singleEvents উভয়ই False হয়, তাহলেও পুনরাবৃত্ত ইভেন্টের বাতিল হওয়া ইনস্ট্যান্সগুলো (কিন্তু মূল পুনরাবৃত্ত ইভেন্টটি নয়) অন্তর্ভুক্ত করা হবে। যদি showDeleted এবং singleEvents উভয়ই True হয়, তাহলে মুছে ফেলা ইভেন্টের শুধুমাত্র একক ইনস্ট্যান্সগুলো (কিন্তু মূল পুনরাবৃত্ত ইভেন্টগুলো নয়) ফেরত দেওয়া হবে। এটি ঐচ্ছিক। ডিফল্ট মান হলো False।
showHiddenInvitations boolean ফলাফলে গোপন আমন্ত্রণ অন্তর্ভুক্ত করা হবে কিনা। ঐচ্ছিক। ডিফল্ট মান হলো False।
singleEvents boolean পুনরাবৃত্তিমূলক ইভেন্টগুলোকে ইনস্ট্যান্সে প্রসারিত করা হবে কিনা এবং শুধুমাত্র একক এককালীন ইভেন্ট ও পুনরাবৃত্তিমূলক ইভেন্টের ইনস্ট্যান্সগুলো ফেরত দেওয়া হবে কিনা, কিন্তু মূল পুনরাবৃত্তিমূলক ইভেন্টগুলো ফেরত দেওয়া হবে না। ঐচ্ছিক। ডিফল্ট মান হলো False।
syncToken string পূর্ববর্তী তালিকা অনুরোধের ফলাফলের শেষ পৃষ্ঠায় ফেরত আসা nextSyncToken ফিল্ড থেকে প্রাপ্ত টোকেন। এটি নিশ্চিত করে যে এই তালিকা অনুরোধের ফলাফলে শুধুমাত্র সেই এন্ট্রিগুলোই থাকবে যেগুলো তখন থেকে পরিবর্তিত হয়েছে। পূর্ববর্তী তালিকা অনুরোধের পর থেকে মুছে ফেলা সমস্ত ইভেন্ট সর্বদা ফলাফল সেটে থাকবে এবং showDeleted কে 'False' সেট করার অনুমতি নেই।
ক্লায়েন্ট স্টেটের সামঞ্জস্যতা নিশ্চিত করার জন্য এমন বেশ কিছু কোয়েরি প্যারামিটার রয়েছে যা nextSyncToken এর সাথে একসাথে নির্দিষ্ট করা যায় না।

এগুলো হলো:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
অনির্ধারিত আচরণ এড়ানোর জন্য অন্যান্য সমস্ত কোয়েরি প্যারামিটার প্রাথমিক সিঙ্ক্রোনাইজেশনের মতোই হওয়া উচিত। যদি syncToken এর মেয়াদ শেষ হয়ে যায়, তাহলে সার্ভার একটি 410 GONE রেসপন্স কোড দিয়ে সাড়া দেবে এবং ক্লায়েন্টের উচিত তার স্টোরেজ খালি করে কোনো syncToken ছাড়াই একটি সম্পূর্ণ সিঙ্ক্রোনাইজেশন সম্পন্ন করা।
ইনক্রিমেন্টাল সিনক্রোনাইজেশন সম্পর্কে আরও জানুন ।
ঐচ্ছিক। ডিফল্ট হিসেবে সমস্ত এন্ট্রি ফেরত দেওয়া হয়।
timeMax datetime কোনো ইভেন্টের শুরুর সময় দ্বারা ফিল্টার করার জন্য সর্বোচ্চ সীমা (একচেটিয়া)। ঐচ্ছিক। ডিফল্ট হলো শুরুর সময় দ্বারা ফিল্টার না করা। এটি অবশ্যই একটি RFC3339 টাইমস্ট্যাম্প হতে হবে, যেখানে বাধ্যতামূলক টাইম জোন অফসেট থাকবে, উদাহরণস্বরূপ, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z। মিলিসেকেন্ড প্রদান করা যেতে পারে, কিন্তু তা উপেক্ষা করা হবে। যদি timeMin সেট করা থাকে, তাহলে timeMax অবশ্যই timeMin চেয়ে বড় হতে হবে।
timeMin datetime কোনো ইভেন্টের শেষ সময় দ্বারা ফিল্টার করার জন্য সর্বনিম্ন সীমা (একচেটিয়া)। ঐচ্ছিক। ডিফল্ট হলো শেষ সময় দ্বারা ফিল্টার না করা। এটি অবশ্যই একটি RFC3339 টাইমস্ট্যাম্প হতে হবে, যেখানে বাধ্যতামূলক টাইম জোন অফসেট থাকবে, উদাহরণস্বরূপ, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z। মিলিসেকেন্ড প্রদান করা যেতে পারে, কিন্তু তা উপেক্ষা করা হবে। যদি timeMax সেট করা থাকে, তাহলে timeMin অবশ্যই timeMax চেয়ে ছোট হতে হবে।
timeZone string প্রতিক্রিয়ায় ব্যবহৃত সময় অঞ্চল। এটি ঐচ্ছিক। ডিফল্ট হলো ক্যালেন্ডারের সময় অঞ্চল।
updatedMin datetime কোনো ইভেন্টের সর্বশেষ পরিবর্তনের সময়ের ( RFC3339 টাইমস্ট্যাম্প হিসেবে) সর্বনিম্ন সীমা, যা দিয়ে ফিল্টার করা হবে। এটি নির্দিষ্ট করা হলে, showDeleted নির্বিশেষে এই সময়ের পর মুছে ফেলা এন্ট্রিগুলো সর্বদা অন্তর্ভুক্ত হবে। ঐচ্ছিক। ডিফল্ট হলো সর্বশেষ পরিবর্তনের সময় দিয়ে ফিল্টার না করা।

অনুমোদন

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

পরিধি
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

আরও তথ্যের জন্য, প্রমাণীকরণ এবং অনুমোদন পৃষ্ঠাটি দেখুন।

অনুরোধকারী শরীর

এই মেথডের সাথে কোনো রিকোয়েস্ট বডি সরবরাহ করবেন না।

প্রতিক্রিয়া

সফল হলে, এই মেথডটি নিম্নলিখিত কাঠামোসহ একটি রেসপন্স বডি রিটার্ন করে: 

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
সম্পত্তির নাম মূল্য বর্ণনা নোট
kind string সংগ্রহের ধরণ (" calendar#events ")।
etag etag সংগ্রহটির ই-ট্যাগ।
summary string ক্যালেন্ডারের শিরোনাম। শুধুমাত্র পঠনযোগ্য।
description string ক্যালেন্ডারের বিবরণ। শুধুমাত্র পঠনযোগ্য।
updated datetime ক্যালেন্ডারের সর্বশেষ পরিবর্তনের সময় ( RFC3339 টাইমস্ট্যাম্প হিসেবে)। শুধুমাত্র পাঠযোগ্য।
timeZone string ক্যালেন্ডারের সময় অঞ্চল। শুধুমাত্র পঠনযোগ্য।
accessRole string এই ক্যালেন্ডারের জন্য ব্যবহারকারীর অ্যাক্সেস রোল। শুধুমাত্র পঠনযোগ্য। সম্ভাব্য মানগুলো হলো:
  • " none " - ব্যবহারকারীর কোনো অ্যাক্সেস নেই।
  • " freeBusyReader " - ব্যবহারকারীর ফ্রি/বিজি তথ্যে পড়ার অ্যাক্সেস আছে।
  • " reader " - ব্যবহারকারীর ক্যালেন্ডারটি পড়ার অ্যাক্সেস আছে। ব্যক্তিগত ইভেন্টগুলো রিডার অ্যাক্সেস থাকা ব্যবহারকারীরা দেখতে পাবেন, কিন্তু ইভেন্টের বিস্তারিত তথ্য গোপন থাকবে।
  • " writerWithoutPrivateAccess " - এই ব্যবহারকারীর ক্যালেন্ডারে পড়া এবং লেখার অ্যাক্সেস আছে। ব্যক্তিগত ইভেন্টগুলো writerWithoutPrivateAccess অ্যাক্সেস থাকা ব্যবহারকারীদের কাছে দেখা যাবে, কিন্তু ইভেন্টের বিস্তারিত তথ্য গোপন থাকবে।
  • " writer " - এই ব্যবহারকারীর ক্যালেন্ডারে পড়া এবং লেখার অ্যাক্সেস রয়েছে। ব্যক্তিগত ইভেন্টগুলো রাইটার অ্যাক্সেস থাকা ব্যবহারকারীদের কাছে প্রদর্শিত হবে এবং ইভেন্টের বিস্তারিত বিবরণ দেখা যাবে।
  • " owner " - এই ব্যবহারকারীর ক্যালেন্ডারে ব্যবস্থাপক অ্যাক্সেস রয়েছে। এই রোলের লেখক রোলের সমস্ত অনুমতির পাশাপাশি অন্যান্য ব্যবহারকারীদের অ্যাক্সেস স্তর দেখা এবং পরিবর্তন করার অতিরিক্ত ক্ষমতাও রয়েছে।

defaultReminders[] list প্রমাণীকৃত ব্যবহারকারীর জন্য ক্যালেন্ডারে থাকা ডিফল্ট রিমাইন্ডারগুলো। এই রিমাইন্ডারগুলো এই ক্যালেন্ডারের সেই সমস্ত ইভেন্টের ক্ষেত্রে প্রযোজ্য, যেগুলো স্পষ্টভাবে এগুলোকে ওভাররাইড করে না (অর্থাৎ, যেগুলোর জন্য reminders.useDefault কে True সেট করা নেই)।
defaultReminders[]. method string এই রিমাইন্ডারে ব্যবহৃত পদ্ধতি। সম্ভাব্য মানগুলো হলো:
  • " email " - রিমাইন্ডার ইমেলের মাধ্যমে পাঠানো হয়।
  • " popup " - রিমাইন্ডারগুলো একটি UI পপআপের মাধ্যমে পাঠানো হয়।

রিমাইন্ডার যোগ করার সময় এটি আবশ্যক।

 লেখার যোগ্য
defaultReminders[]. minutes integer ইভেন্ট শুরু হওয়ার কত মিনিট আগে রিমাইন্ডারটি চালু হবে। বৈধ মান হলো ০ থেকে ৪০৩২০ (মিনিটে ৪ সপ্তাহ)।

রিমাইন্ডার যোগ করার সময় এটি আবশ্যক।

 লেখার যোগ্য
nextPageToken string এই ফলাফলের পরবর্তী পৃষ্ঠা অ্যাক্সেস করতে ব্যবহৃত টোকেন। যদি আর কোনো ফলাফল উপলব্ধ না থাকে তবে এটি বাদ দেওয়া হয়, সেক্ষেত্রে nextSyncToken প্রদান করা হয়।
items[] list ক্যালেন্ডারে থাকা অনুষ্ঠানগুলোর তালিকা।
nextSyncToken string এই ফলাফলটি ফেরত আসার পর থেকে যে এন্ট্রিগুলো পরিবর্তিত হয়েছে, শুধু সেগুলো পুনরুদ্ধার করার জন্য পরবর্তী সময়ে ব্যবহৃত টোকেন। যদি আরও ফলাফল উপলব্ধ থাকে তবে এটি বাদ দেওয়া হয়, সেক্ষেত্রে nextPageToken প্রদান করা হয়।

চেষ্টা করে দেখুন!

লাইভ ডেটার উপর এই মেথডটি কল করতে এবং প্রতিক্রিয়া দেখতে নিচের এপিআই এক্সপ্লোরারটি ব্যবহার করুন।