এই নির্দেশিকাটিতে গুগল ডক্স এপিআই (Google Docs API) গঠনকারী প্রধান পদ্ধতিসমূহ, একটি ডকুমেন্ট কীভাবে অ্যাক্সেস করতে হয় এবং ডকুমেন্ট তৈরির কার্যপ্রবাহের মতো ধারণাগুলো তুলে ধরা হয়েছে।
এপিআই পদ্ধতি
documents রিসোর্সটি এমন কিছু মেথড সরবরাহ করে যা ব্যবহার করে আপনি ডকস এপিআই (Docs API) কল করতে পারেন। নিম্নলিখিত মেথডগুলো আপনাকে ডকস ডকুমেন্ট তৈরি, পড়া এবং আপডেট করার সুযোগ দেয়:
- ডকুমেন্ট তৈরি করতে
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 মেথডটি ব্যবহার করুন। আরও তথ্যের জন্য, “একটি বিদ্যমান ডকুমেন্ট কপি করুন” দেখুন।
ডিফল্টরূপে, ডকস এপিআই ব্যবহার করার সময় একটি নতুন ডকুমেন্ট ব্যবহারকারীর ড্রাইভের রুট ফোল্ডারে সেভ হয়। ড্রাইভ ফোল্ডারে ফাইল সেভ করার জন্য বিভিন্ন অপশন রয়েছে। আরও তথ্যের জন্য, ‘গুগল ড্রাইভ ফোল্ডার নিয়ে কাজ করুন’ দেখুন।
ডকস ফাইল নিয়ে কাজ করুন
কোনো ব্যবহারকারীর 'মাই ড্রাইভ' থেকে একটি ডকুমেন্ট পুনরুদ্ধার করতে, প্রায়শই প্রথমে ফাইলটির আইডি পাওয়ার জন্য ড্রাইভের files.list মেথডটি ব্যবহার করার প্রয়োজন হয়। কোনো প্যারামিটার ছাড়া মেথডটি কল করলে, এটি ব্যবহারকারীর সমস্ত ফাইল ও ফোল্ডারের একটি তালিকা ফেরত দেয়, যার মধ্যে আইডিগুলোও অন্তর্ভুক্ত থাকে।
একটি ডকুমেন্টের MIME টাইপ ডেটার ধরন এবং ফরম্যাট নির্দেশ করে। Docs-এর জন্য MIME টাইপ ফরম্যাট হলো application/vnd.google-apps.document । MIME টাইপের তালিকার জন্য, Google Workspace এবং Google Drive সমর্থিত MIME টাইপসমূহ দেখুন।
My Drive-এর মধ্যে শুধুমাত্র Docs ফাইলগুলি MIME টাইপ অনুসারে অনুসন্ধান করতে, নিম্নলিখিত কোয়েরি স্ট্রিং ফিল্টারটি যুক্ত করুন:
q: mimeType = 'application/vnd.google-apps.document'
কোয়েরি স্ট্রিং ফিল্টার সম্পর্কে আরও তথ্যের জন্য, ফাইল ও ফোল্ডার অনুসন্ধান দেখুন।
একবার documentId জানা থাকলে, নির্দিষ্ট ডকুমেন্টটির একটি সম্পূর্ণ ইনস্ট্যান্স পেতে documents.get মেথডটি ব্যবহার করুন। আরও তথ্যের জন্য, Requests and responses দেখুন।
Google Workspace ডকুমেন্টের বাইট কন্টেন্ট এক্সপোর্ট করতে, যে ফাইলটি এক্সপোর্ট করতে চান তার documentId এবং সঠিক এক্সপোর্ট MIME টাইপ সহ Drive-এর files.export মেথডটি ব্যবহার করুন। আরও তথ্যের জন্য, Google Workspace ডকুমেন্ট কন্টেন্ট এক্সপোর্ট দেখুন।
Get এবং List পদ্ধতির তুলনা করুন
নিম্নলিখিত সারণিতে Drive এবং Docs পদ্ধতির মধ্যে পার্থক্য এবং প্রতিটির মাধ্যমে প্রাপ্ত ডেটা বর্ণনা করা হয়েছে:
| অপারেটর | বর্ণনা | ব্যবহার |
|---|---|---|
drive.files.get | আইডি দ্বারা একটি ফাইলের মেটাডেটা সংগ্রহ করে। files রিসোর্সের একটি ইনস্ট্যান্স ফেরত দেয়। | একটি নির্দিষ্ট ফাইলের মেটাডেটা পান। |
drive.files.list | ব্যবহারকারীর ফাইলগুলো খুঁজে বের করে। ফাইলগুলোর একটি তালিকা ফেরত দেয়। | কোন ফাইলটি পরিবর্তন করতে হবে সে বিষয়ে নিশ্চিত না হলে ব্যবহারকারীর ফাইলগুলির একটি তালিকা নিন। |
docs.documents.get | সমস্ত ফরম্যাটিং এবং টেক্সট সহ নির্দিষ্ট ডকুমেন্টটির সর্বশেষ সংস্করণটি পাওয়া যায়। এটি documents রিসোর্সের একটি ইনস্ট্যান্স ফেরত দেয়। | একটি নির্দিষ্ট ডকুমেন্ট আইডির জন্য নথিটি সংগ্রহ করুন। |
ডকুমেন্ট তৈরির কর্মপ্রবাহ
একটি নতুন ডকুমেন্ট তৈরি করা এবং তাতে তথ্য যোগ করা বেশ সহজ, কারণ এখানে আগে থেকে থাকা কোনো বিষয়বস্তু নিয়ে চিন্তা করতে হয় না এবং এমন কোনো সহযোগীও নেই যিনি ডকুমেন্টের অবস্থা পরিবর্তন করতে পারেন। ধারণাগতভাবে, এটি নিম্নলিখিত সিকোয়েন্স ডায়াগ্রামে দেখানো পদ্ধতিতে কাজ করে:
চিত্র ১-এ, documents রিসোর্সের সাথে মিথস্ক্রিয়া করার সময় একজন ব্যবহারকারীর তথ্যের প্রবাহ নিম্নরূপ:
- একটি অ্যাপ ওয়েব সার্ভারে
documents.createমেথডটি কল করে। - ওয়েব সার্ভারটি একটি HTTP রেসপন্স পাঠায়, যাতে তৈরি করা ডকুমেন্টটির একটি ইনস্ট্যান্স
documentsরিসোর্স হিসেবে থাকে। - ঐচ্ছিকভাবে, অ্যাপটি ডকুমেন্টটিকে ডেটা দিয়ে পূরণ করার জন্য অ্যাটমিকভাবে একগুচ্ছ সম্পাদনা অনুরোধ সম্পাদন করতে
documents.batchUpdateমেথডটিকে কল করে। - ওয়েব সার্ভার একটি HTTP রেসপন্স পাঠায়। কিছু
documents.batchUpdateমেথড প্রয়োগকৃত রিকোয়েস্টগুলোর তথ্যসহ একটি রেসপন্স বডি প্রদান করে, অপরদিকে অন্যগুলো একটি খালি রেসপন্স দেখায়।
ডকুমেন্ট আপডেট ওয়ার্কফ্লো
বিদ্যমান কোনো ডকুমেন্ট আপডেট করা আরও জটিল। একটি ডকুমেন্ট আপডেট করার জন্য কার্যকর কল করার আগে, আপনাকে অবশ্যই এর বর্তমান অবস্থা জানতে হবে: এটি কী কী উপাদান দিয়ে গঠিত, সেই উপাদানগুলোর মধ্যে কী বিষয়বস্তু রয়েছে এবং ডকুমেন্টের মধ্যে উপাদানগুলোর ক্রম কী। নিম্নলিখিত সিকোয়েন্স ডায়াগ্রামটি দেখায় যে এটি কীভাবে কাজ করে:
চিত্র ২-এ, documents রিসোর্সের সাথে মিথস্ক্রিয়া করার সময় একজন ব্যবহারকারীর তথ্যের প্রবাহ নিম্নরূপ:
- একটি অ্যাপ, যে ফাইলটি খুঁজতে চায় তার
documentIdব্যবহার করে ওয়েব সার্ভারেরdocuments.getমেথডটিকে কল করে। - ওয়েব সার্ভার একটি HTTP রেসপন্স পাঠায়, যাতে
documentsরিসোর্স হিসেবে নির্দিষ্ট ডকুমেন্টটির একটি ইনস্ট্যান্স থাকে। ফেরত আসা JSON-টিতে ডকুমেন্টের বিষয়বস্তু, ফরম্যাটিং এবং অন্যান্য বৈশিষ্ট্য অন্তর্ভুক্ত থাকে। - অ্যাপটি JSON ডেটা পার্স করে, যাতে ব্যবহারকারী নির্ধারণ করতে পারেন যে কোন বিষয়বস্তু বা ফরম্যাট আপডেট করতে হবে।
- অ্যাপটি ডকুমেন্টটি আপডেট করার জন্য অ্যাটমিকভাবে একাধিক সম্পাদনা অনুরোধ সম্পাদন করতে
documents.batchUpdateমেথডটিকে কল করে। - ওয়েব সার্ভার একটি HTTP রেসপন্স পাঠায়। কিছু
documents.batchUpdateমেথড প্রয়োগকৃত রিকোয়েস্টগুলোর তথ্যসহ একটি রেসপন্স বডি প্রদান করে, অপরদিকে অন্যগুলো একটি খালি রেসপন্স দেখায়।
এই ডায়াগ্রামটি এমন ওয়ার্কফ্লো বিবেচনা করে না যেখানে একই ডকুমেন্টে অন্যান্য সহযোগীরা যুগপৎভাবে আপডেট করেন। আরও তথ্যের জন্য, সেরা অনুশীলন বিভাগের ‘ সহযোগিতার জন্য পরিকল্পনা’ অংশটি দেখুন।
সম্পর্কিত বিষয়
- গুগল ডক্স ডকুমেন্টের কাঠামো
- অনুরোধ এবং প্রতিক্রিয়া
- কাঠামোগত সম্পাদনার নিয়ম এবং আচরণ
- সর্বোত্তম ফলাফলের জন্য সর্বোত্তম অনুশীলন