দলিল

এই নির্দেশিকাটি প্রাথমিক পদ্ধতিগুলি যেমন Google ডক্স API তৈরি করে, কীভাবে একটি নথিতে অ্যাক্সেস করতে হয় এবং একটি নথি তৈরি করার সময় কার্যপ্রবাহের মতো ধারণাগুলি উপস্থাপন করে৷

API পদ্ধতি

documents রিসোর্স আপনি ডক্স এপিআই চালু করার জন্য যে পদ্ধতিগুলি ব্যবহার করেন তা প্রদান করে। নিম্নলিখিত পদ্ধতিগুলি আপনাকে ডক্স ডকুমেন্ট তৈরি করতে, পড়তে এবং আপডেট করতে দেয়:

  • একটি নথি তৈরি করতে documents.create পদ্ধতি ব্যবহার করুন।
  • একটি নির্দিষ্ট নথির বিষয়বস্তু পুনরুদ্ধার করতে documents.get পদ্ধতি ব্যবহার করুন।
  • একটি নির্দিষ্ট নথিতে আপডেটের একটি সেট পারমাণবিকভাবে সম্পাদন করতে documents.batchUpdate পদ্ধতি ব্যবহার করুন।

documents.get এবং documents.batchUpdate পদ্ধতিতে লক্ষ্য নথিটি নির্দিষ্ট করার জন্য একটি প্যারামিটার হিসাবে একটি documentId প্রয়োজন। documents.create পদ্ধতি তৈরি করা নথির একটি উদাহরণ প্রদান করে, যেখান থেকে আপনি documentId পড়তে পারেন। ডক্স API অনুরোধ এবং প্রতিক্রিয়া পদ্ধতি সম্পর্কে আরও তথ্যের জন্য, অনুরোধ এবং প্রতিক্রিয়া দেখুন।

ডকুমেন্ট আইডি

documentId হল নথির অনন্য শনাক্তকারী এবং এটি একটি নথির URL থেকে নেওয়া যেতে পারে। এটি একটি নির্দিষ্ট স্ট্রিং যাতে অক্ষর, সংখ্যা এবং কিছু বিশেষ অক্ষর থাকে। ডকুমেন্টের নাম পরিবর্তন হলেও ডকুমেন্ট আইডি স্থিতিশীল থাকে।

https://docs.google.com/document/d/DOCUMENT_ID/edit

Google ডক্স URL থেকে documentId বের করতে নিম্নলিখিত রেগুলার এক্সপ্রেশন ব্যবহার করা যেতে পারে:

/document/d/([a-zA-Z0-9-_]+)

আপনি যদি Google Drive API-এর সাথে পরিচিত হন, তাহলে documentId files রিসোর্সের id সাথে মিলে যায়।

Google ড্রাইভে নথি পরিচালনা করুন

ডক্স ফাইলগুলি Google ড্রাইভে সংরক্ষণ করা হয়, আমাদের ক্লাউড-ভিত্তিক স্টোরেজ পরিষেবা৷ যদিও ডক্স এপিআই এর নিজস্ব স্বতন্ত্র পদ্ধতি রয়েছে, তবে ব্যবহারকারীর ডক্স ফাইলগুলির সাথে ইন্টারঅ্যাক্ট করতে প্রায়শই Google ড্রাইভ API পদ্ধতিগুলি ব্যবহার করা প্রয়োজন৷ উদাহরণস্বরূপ, ডক্স ফাইলগুলি অনুলিপি করতে, ড্রাইভ API এর files.copy পদ্ধতি ব্যবহার করুন৷ আরও তথ্যের জন্য, একটি বিদ্যমান নথি অনুলিপি করুন দেখুন।

ডিফল্টরূপে, ডক্স API ব্যবহার করার সময় একটি নতুন নথি ড্রাইভে ব্যবহারকারীর রুট ফোল্ডারে সংরক্ষিত হয়। একটি ড্রাইভ ফোল্ডারে একটি ফাইল সংরক্ষণ করার বিকল্প আছে। আরও তথ্যের জন্য, Google ড্রাইভ ফোল্ডারগুলির সাথে কাজ দেখুন।

ডক্স ফাইলের সাথে কাজ করুন

ব্যবহারকারীর মাই ড্রাইভ থেকে একটি নথি পুনরুদ্ধার করার জন্য, একটি ফাইলের জন্য আইডি পুনরুদ্ধার করতে প্রায়ই প্রথমে ড্রাইভের 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 সহ Drive-এর files.export পদ্ধতি ব্যবহার করুন এবং সঠিক এক্সপোর্ট MIME প্রকার । আরও তথ্যের জন্য, Google Workspace ডকুমেন্ট কন্টেন্ট এক্সপোর্ট দেখুন।

Get এবং List পদ্ধতি তুলনা করুন

নিম্নলিখিত সারণীটি ড্রাইভ এবং ডক্স পদ্ধতির মধ্যে পার্থক্য এবং প্রতিটির সাথে ফেরত আসা ডেটা বর্ণনা করে:

অপারেটর বর্ণনা ব্যবহার
drive.files.get আইডি দ্বারা একটি ফাইলের মেটাডেটা পায়। files সম্পদের একটি উদাহরণ প্রদান করে। একটি নির্দিষ্ট ফাইলের জন্য মেটাডেটা পান।
drive.files.list একটি ব্যবহারকারীর ফাইল পায়. ফাইলের একটি তালিকা প্রদান করে। ব্যবহারকারী ফাইলগুলির একটি তালিকা পান যখন আপনি অনিশ্চিত হন যে কোন ফাইলটি আপনাকে সংশোধন করতে হবে৷
docs.documents.get সমস্ত বিন্যাস এবং পাঠ্য সহ নির্দিষ্ট নথির সর্বশেষ সংস্করণ পায়৷ documents সম্পদের একটি উদাহরণ প্রদান করে। একটি নির্দিষ্ট নথি আইডি জন্য নথি পান.

নথি তৈরির কর্মপ্রবাহ

একটি নতুন দস্তাবেজ তৈরি করা এবং পপুলেট করা সহজ, যেহেতু উদ্বিগ্ন হওয়ার মতো কোনও বিদ্যমান সামগ্রী নেই এবং এমন কোনও সহযোগী নেই যারা নথির অবস্থা পরিবর্তন করতে পারে৷ ধারণাগতভাবে, এটি নিম্নলিখিত ক্রম চিত্রে দেখানো হিসাবে কাজ করে:

একটি নতুন নথি তৈরি এবং পপুলেট করার জন্য ওয়ার্কফ্লো।
চিত্র 1. একটি নতুন নথি তৈরি এবং পপুলেট করার জন্য ওয়ার্কফ্লো।

চিত্র 1-এ, documents সম্পদের সাথে ইন্টারঅ্যাক্ট করা একজন ব্যবহারকারীর নিম্নলিখিত তথ্যের প্রবাহ রয়েছে:

  1. একটি অ্যাপ একটি ওয়েব সার্ভারে documents.create পদ্ধতিকে কল করে।
  2. ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায় যাতে একটি documents সম্পদ হিসাবে তৈরি নথির একটি উদাহরণ থাকে।
  3. ঐচ্ছিকভাবে, অ্যাপটি ডকুমেন্টকে ডেটা দিয়ে পূরণ করার জন্য সম্পাদনা অনুরোধের একটি সেট পারমাণবিকভাবে সম্পাদন করতে documents.batchUpdate পদ্ধতিকে কল করে।
  4. ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায়। কিছু documents.batchUpdate পদ্ধতি প্রয়োগ করা অনুরোধ সম্পর্কে তথ্য সহ একটি প্রতিক্রিয়া সংস্থা প্রদান করে, যেখানে অন্যগুলি একটি খালি প্রতিক্রিয়া দেখায়।

ডকুমেন্ট আপডেট ওয়ার্কফ্লো

একটি বিদ্যমান নথি আপডেট করা আরও জটিল। আপনি একটি নথি আপডেট করার জন্য অর্থপূর্ণ কল করার আগে, আপনাকে অবশ্যই তার বর্তমান অবস্থা জানতে হবে: কোন উপাদানগুলি এটি তৈরি করে, সেই উপাদানগুলিতে কী সামগ্রী রয়েছে এবং নথির মধ্যে উপাদানগুলির ক্রম৷ নিম্নলিখিত ক্রম চিত্রটি দেখায় কিভাবে এটি কাজ করে:

একটি নথি আপডেট করতে কর্মপ্রবাহ।
চিত্র 2. একটি নথি আপডেট করার জন্য কর্মপ্রবাহ।

চিত্র 2-এ, documents সম্পদের সাথে ইন্টারঅ্যাক্ট করা একজন ব্যবহারকারীর নিম্নলিখিত তথ্যের প্রবাহ রয়েছে:

  1. একটি অ্যাপ একটি ওয়েব সার্ভারে documents.get মেথডকে কল করে, ফাইলের documentId খুঁজে বের করার জন্য।
  2. ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায় যাতে একটি documents সম্পদ হিসাবে নির্দিষ্ট নথির একটি উদাহরণ থাকে। ফিরে আসা JSON-এ নথির বিষয়বস্তু, বিন্যাস এবং অন্যান্য বৈশিষ্ট্য রয়েছে।
  3. অ্যাপটি JSON পার্স করে যাতে ব্যবহারকারী নির্ধারণ করতে পারে কোন বিষয়বস্তু বা বিন্যাস আপডেট করতে হবে।
  4. অ্যাপটি ডকুমেন্ট আপডেট করার জন্য সম্পাদনা অনুরোধের একটি সেট পারমাণবিকভাবে সম্পাদন করতে documents.batchUpdate পদ্ধতিকে কল করে।
  5. ওয়েব সার্ভার একটি HTTP প্রতিক্রিয়া পাঠায়। কিছু documents.batchUpdate পদ্ধতি প্রয়োগ করা অনুরোধ সম্পর্কে তথ্য সহ একটি প্রতিক্রিয়া সংস্থা প্রদান করে, যেখানে অন্যগুলি একটি খালি প্রতিক্রিয়া দেখায়।

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