এই নির্দেশিকাটিতে Google Docs API তৈরির প্রাথমিক পদ্ধতি, একটি নথি কীভাবে অ্যাক্সেস করবেন এবং একটি নথি তৈরি করার সময় কর্মপ্রবাহের মতো ধারণাগুলি উপস্থাপন করা হয়েছে।
API পদ্ধতি
documents রিসোর্সটি ডক্স এপিআই চালু করার জন্য আপনার ব্যবহৃত পদ্ধতিগুলি প্রদান করে। নিম্নলিখিত পদ্ধতিগুলি আপনাকে ডক্স ডকুমেন্ট তৈরি করতে, পড়তে এবং আপডেট করতে দেয়:
- একটি ডকুমেন্ট তৈরি করতে
documents.createপদ্ধতি ব্যবহার করুন। - একটি নির্দিষ্ট ডকুমেন্টের বিষয়বস্তু পুনরুদ্ধার করতে
documents.getপদ্ধতি ব্যবহার করুন। - একটি নির্দিষ্ট ডকুমেন্টে আপডেটের একটি সেট পারমাণবিকভাবে সম্পাদন করতে
documents.batchUpdateপদ্ধতি ব্যবহার করুন।
documents.get এবং documents.batchUpdate পদ্ধতিগুলির লক্ষ্য ডকুমেন্ট নির্দিষ্ট করার জন্য একটি প্যারামিটার হিসাবে একটি documentId প্রয়োজন। documents.create পদ্ধতিটি তৈরি করা ডকুমেন্টের একটি উদাহরণ প্রদান করে, যেখান থেকে আপনি documentId পড়তে পারেন। Docs API অনুরোধ এবং প্রতিক্রিয়া পদ্ধতি সম্পর্কে আরও তথ্যের জন্য, অনুরোধ এবং প্রতিক্রিয়া দেখুন।
ডকুমেন্ট আইডি
documentId হলো ডকুমেন্টের অনন্য শনাক্তকারী এবং এটি একটি ডকুমেন্টের URL থেকে নেওয়া যেতে পারে। এটি একটি নির্দিষ্ট স্ট্রিং যাতে অক্ষর, সংখ্যা এবং কিছু বিশেষ অক্ষর থাকে। ডকুমেন্টের নাম পরিবর্তন হলেও ডকুমেন্ট আইডি স্থিতিশীল থাকে।
https://docs.google.com/document/d/DOCUMENT_ID/edit
গুগল ডক্স ইউআরএল থেকে documentId বের করতে নিম্নলিখিত রেগুলার এক্সপ্রেশন ব্যবহার করা যেতে পারে:
/document/d/([a-zA-Z0-9-_]+)
যদি আপনি গুগল ড্রাইভ এপিআই এর সাথে পরিচিত হন, তাহলে documentId files রিসোর্সে id এর সাথে মিলে যায়।
গুগল ড্রাইভে ডকুমেন্ট পরিচালনা করুন
ডক্স ফাইলগুলি আমাদের ক্লাউড-ভিত্তিক স্টোরেজ পরিষেবা, গুগল ড্রাইভে সংরক্ষণ করা হয়। ডক্স এপিআই-এর নিজস্ব স্বতন্ত্র পদ্ধতি থাকলেও, ব্যবহারকারীর ডক্স ফাইলগুলির সাথে ইন্টারঅ্যাক্ট করার জন্য প্রায়শই গুগল ড্রাইভ এপিআই পদ্ধতি ব্যবহার করা প্রয়োজন। উদাহরণস্বরূপ, ডক্স ফাইলগুলি অনুলিপি করতে, ড্রাইভ এপিআই-এর files.copy পদ্ধতি ব্যবহার করুন। আরও তথ্যের জন্য, একটি বিদ্যমান ডকুমেন্ট অনুলিপি করুন দেখুন।
ডিফল্টরূপে, ডক্স এপিআই ব্যবহার করার সময় একটি নতুন ডকুমেন্ট ব্যবহারকারীর ড্রাইভের রুট ফোল্ডারে সংরক্ষণ করা হয়। ড্রাইভ ফোল্ডারে একটি ফাইল সংরক্ষণের বিকল্প রয়েছে। আরও তথ্যের জন্য, গুগল ড্রাইভ ফোল্ডারগুলির সাথে কাজ করুন দেখুন।
ডক্স ফাইল নিয়ে কাজ করুন
ব্যবহারকারীর My Drive থেকে একটি ডকুমেন্ট পুনরুদ্ধার করতে, প্রায়শই প্রথমে Drive এর files.list পদ্ধতি ব্যবহার করে ফাইলের আইডি পুনরুদ্ধার করতে হয়। কোনও প্যারামিটার ছাড়াই পদ্ধতিটি কল করলে ব্যবহারকারীর জন্য আইডি সহ সমস্ত ফাইল এবং ফোল্ডারের একটি তালিকা ফিরে আসে।
একটি ডকুমেন্টের MIME টাইপ ডেটা টাইপ এবং ফর্ম্যাট নির্দেশ করে। ডক্সের জন্য MIME টাইপ ফর্ম্যাট হল application/vnd.google-apps.document । MIME টাইপের তালিকার জন্য, Google Workspace এবং Google Drive সমর্থিত MIME টাইপ দেখুন।
আমার ড্রাইভের মধ্যে শুধুমাত্র ডক্স ফাইলের জন্য MIME টাইপ অনুসারে অনুসন্ধান করতে, নিম্নলিখিত কোয়েরি স্ট্রিং ফিল্টারটি যুক্ত করুন:
q: mimeType = 'application/vnd.google-apps.document'
কোয়েরি স্ট্রিং ফিল্টার সম্পর্কে আরও তথ্যের জন্য, ফাইল এবং ফোল্ডার অনুসন্ধান দেখুন।
documentId জানার পর, নির্দিষ্ট ডকুমেন্টের সম্পূর্ণ উদাহরণ পুনরুদ্ধার করতে documents.get পদ্ধতিটি ব্যবহার করুন। আরও তথ্যের জন্য, অনুরোধ এবং প্রতিক্রিয়া দেখুন।
Google Workspace ডকুমেন্ট বাইট কন্টেন্ট এক্সপোর্ট করতে, এক্সপোর্ট করার জন্য ফাইলের documentId এবং সঠিক এক্সপোর্ট MIME টাইপ ব্যবহার করে Drive এর files.export পদ্ধতি ব্যবহার করুন। আরও তথ্যের জন্য, এক্সপোর্ট গুগল ওয়ার্কস্পেস ডকুমেন্ট কন্টেন্ট দেখুন।
Get এবং List পদ্ধতির তুলনা করুন
নিম্নলিখিত টেবিলে ড্রাইভ এবং ডক্স পদ্ধতির মধ্যে পার্থক্য এবং প্রতিটি পদ্ধতির সাথে ফিরে আসা ডেটা বর্ণনা করা হয়েছে:
| অপারেটর | বিবরণ | ব্যবহার |
|---|---|---|
drive.files.get | ID দ্বারা একটি ফাইলের মেটাডেটা পায়। files রিসোর্সের একটি উদাহরণ প্রদান করে। | একটি নির্দিষ্ট ফাইলের মেটাডেটা পান। |
drive.files.list | ব্যবহারকারীর ফাইলগুলি পায়। ফাইলগুলির একটি তালিকা ফেরত দেয়। | কোন ফাইলটি পরিবর্তন করতে হবে তা নিশ্চিত না হলে ব্যবহারকারীর ফাইলগুলির একটি তালিকা পান। |
docs.documents.get | সমস্ত ফর্ম্যাটিং এবং টেক্সট সহ নির্দিষ্ট ডকুমেন্টের সর্বশেষ সংস্করণ পায়। documents রিসোর্সের একটি উদাহরণ প্রদান করে। | একটি নির্দিষ্ট ডকুমেন্ট আইডির জন্য ডকুমেন্টটি পান। |
ডকুমেন্ট তৈরির কর্মপ্রবাহ
একটি নতুন ডকুমেন্ট তৈরি এবং পূরণ করা সহজ, কারণ এতে চিন্তা করার মতো কোনও বিদ্যমান কন্টেন্ট নেই এবং ডকুমেন্টের অবস্থা পরিবর্তন করতে পারে এমন কোনও সহযোগী নেই। ধারণাগতভাবে, এটি নিম্নলিখিত সিকোয়েন্স ডায়াগ্রামে দেখানো হিসাবে কাজ করে:
চিত্র ১-এ, documents রিসোর্সের সাথে ইন্টারঅ্যাক্ট করা একজন ব্যবহারকারীর তথ্যের প্রবাহ নিম্নরূপ:
- একটি অ্যাপ একটি ওয়েব সার্ভারে
documents.createপদ্ধতিকে কল করে। - ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায় যাতে তৈরি করা নথির একটি উদাহরণ
documentsরিসোর্স হিসেবে থাকে। - ঐচ্ছিকভাবে, অ্যাপটি
documents.batchUpdateপদ্ধতিকে কল করে যা পারমাণবিকভাবে সম্পাদনা অনুরোধের একটি সেট সম্পাদন করে যাতে ডকুমেন্টে ডেটা ভরে যায়। - ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায়। কিছু
documents.batchUpdateপদ্ধতি প্রয়োগকৃত অনুরোধ সম্পর্কে তথ্য সহ একটি প্রতিক্রিয়া বডি প্রদান করে, যেখানে অন্যগুলি একটি খালি প্রতিক্রিয়া প্রকাশ করে।
ডকুমেন্ট আপডেট ওয়ার্কফ্লো
একটি বিদ্যমান নথি আপডেট করা আরও জটিল। একটি নথি আপডেট করার জন্য অর্থপূর্ণ কল করার আগে, আপনাকে অবশ্যই এর বর্তমান অবস্থা জানতে হবে: এটি কোন উপাদানগুলি তৈরি করে, সেই উপাদানগুলিতে কী বিষয়বস্তু রয়েছে এবং নথির মধ্যে উপাদানগুলির ক্রম। নিম্নলিখিত ক্রম চিত্রটি দেখায় যে এটি কীভাবে কাজ করে:
চিত্র ২-এ, documents রিসোর্সের সাথে ইন্টারঅ্যাক্ট করা একজন ব্যবহারকারীর তথ্যের প্রবাহ নিম্নরূপ:
- একটি অ্যাপ ওয়েব সার্ভারে
documents.getপদ্ধতিকে কল করে, যেখানে ফাইলটিরdocumentIdখুঁজে বের করতে হয়। - ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায় যাতে
documentsরিসোর্স হিসেবে নির্দিষ্ট ডকুমেন্টের একটি উদাহরণ থাকে। ফিরে আসা JSON-এ ডকুমেন্টের বিষয়বস্তু, ফর্ম্যাটিং এবং অন্যান্য বৈশিষ্ট্য থাকে। - অ্যাপটি JSON পার্স করে যাতে ব্যবহারকারী কোন কন্টেন্ট বা ফর্ম্যাট আপডেট করতে হবে তা নির্ধারণ করতে পারে।
- ডকুমেন্ট আপডেট করার জন্য সম্পাদনা অনুরোধের একটি সেট পারমাণবিকভাবে সম্পাদন করার জন্য অ্যাপটি
documents.batchUpdateপদ্ধতিকে কল করে। - ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায়। কিছু
documents.batchUpdateপদ্ধতি প্রয়োগকৃত অনুরোধ সম্পর্কে তথ্য সহ একটি প্রতিক্রিয়া বডি প্রদান করে, যেখানে অন্যগুলি একটি খালি প্রতিক্রিয়া প্রকাশ করে।
এই চিত্রটি সেই কর্মপ্রবাহগুলিকে বিবেচনা করে না যেখানে অন্যান্য সহযোগীদের দ্বারা একই নথিতে সমসাময়িক আপডেট করা হয়। আরও তথ্যের জন্য, " সহযোগিতার পরিকল্পনা" বিভাগটি দেখুন।
সম্পর্কিত বিষয়
- গুগল ডক্স ডকুমেন্টের গঠন
- অনুরোধ এবং প্রতিক্রিয়া
- কাঠামোগত সম্পাদনার নিয়ম এবং আচরণ
- সেরা ফলাফলের জন্য সেরা অনুশীলন