এই নির্দেশিকাটিতে Google ডক্স API তৈরির প্রাথমিক অনুরোধ এবং প্রতিক্রিয়া পদ্ধতিগুলি এবং আপনি কীভাবে ব্যাচে একটি ডকুমেন্ট আপডেট করতে পারেন তা উপস্থাপন করা হয়েছে।
আপনি HTTP অনুরোধ ব্যবহার করে অথবা ভাষা-নির্দিষ্ট ক্লায়েন্ট লাইব্রেরিতে একটি পদ্ধতি আহ্বান ব্যবহার করে Google ডক্স API চালু করতে পারেন। এগুলি মোটামুটিভাবে সমতুল্য।
গুগল ডক্স এপিআই একটি HTTP প্রতিক্রিয়া প্রদান করে, যার মধ্যে সাধারণত অনুরোধের আমন্ত্রণের ফলাফল অন্তর্ভুক্ত থাকে। ক্লায়েন্ট লাইব্রেরি ব্যবহার করে অনুরোধ করার সময়, প্রতিক্রিয়াগুলি একটি ভাষা-নির্দিষ্ট উপায়ে প্রদান করা হয়।
অনুরোধ পদ্ধতি
ডক্স এপিআই নিম্নলিখিত পদ্ধতিগুলি সমর্থন করে:
documents.create: একটি খালি Google Docs ডকুমেন্ট তৈরি করুন।documents.get: নির্দিষ্ট ডকুমেন্টের একটি সম্পূর্ণ উদাহরণ ফেরত পাঠান। আপনি ডকুমেন্টের বিষয়বস্তু, ফর্ম্যাটিং এবং অন্যান্য বৈশিষ্ট্যগুলি বের করার জন্য ফেরত আসা JSON পার্স করতে পারেন।documents.batchUpdate: ডকুমেন্টে পারমাণবিকভাবে প্রয়োগ করার জন্য সম্পাদনা অনুরোধের একটি তালিকা জমা দিন এবং ফলাফলের একটি তালিকা ফেরত দিন।
documents.get এবং documents.batchUpdate পদ্ধতিগুলির জন্য লক্ষ্য ডকুমেন্ট নির্দিষ্ট করার জন্য একটি প্যারামিটার হিসাবে একটি documentId প্রয়োজন। documents.create পদ্ধতিটি তৈরি করা ডকুমেন্টের একটি উদাহরণ প্রদান করে, যেখান থেকে আপনি documentId পড়তে পারেন। documentId সম্পর্কে আরও তথ্যের জন্য, Document ID দেখুন।
প্রকাশিত নথি
প্রকাশিত ডকুমেন্টগুলি পুনরুদ্ধার করার জন্য আপনি documents.get পদ্ধতি ব্যবহার করতে পারবেন না। প্রকাশিত হয়ে গেলে, পাবলিক ডকুমেন্টগুলি একটি স্বতন্ত্র, public documentId সহ একটি ভিন্ন URL ফর্ম্যাট ব্যবহার করে। documents.get পদ্ধতির সাথে public documentId ব্যবহার করার প্রচেষ্টা একটি 404 HTTP স্ট্যাটাস কোড প্রতিক্রিয়া প্রদান করে।
একইভাবে, আপনি প্রকাশিত নথি অনুলিপি করার জন্য Drive API files.copy পদ্ধতি ব্যবহার করতে পারবেন না।
প্রকাশিত ডকুমেন্ট পুনরুদ্ধার বা অনুলিপি করতে, আপনাকে অবশ্যই মূল documentId ব্যবহার করতে হবে। প্রকাশিত ইউআরএল থেকে মূল documentId বের করার কোনও পদ্ধতি নেই।
আরও তথ্যের জন্য, দেখুন:
ব্যাচ আপডেট
documents.batchUpdate পদ্ধতিটি request বস্তুর একটি তালিকা নেয়, প্রতিটিতে একটি একক অনুরোধ সম্পাদন করার জন্য নির্দিষ্ট করা হয়। উদাহরণস্বরূপ, একটি অনুচ্ছেদ ফর্ম্যাট করুন এবং তারপরে একটি ইনলাইন চিত্র যুক্ত করুন। প্রতিটি অনুরোধ প্রয়োগ করার আগে যাচাই করা হয় এবং অনুরোধগুলি ব্যাচ অনুরোধে প্রদর্শিত ক্রম অনুসারে প্রক্রিয়া করা হয়।
ব্যাচ আপডেটের সমস্ত অনুরোধ পরমাণুভাবে প্রয়োগ করা হয়। অর্থাৎ, যদি কোনও অনুরোধ বৈধ না হয়, তাহলে সম্পূর্ণ আপডেটটি ব্যর্থ হবে এবং (সম্ভাব্যভাবে নির্ভরশীল) কোনও পরিবর্তন প্রয়োগ করা হবে না।
কিছু documents.batchUpdate পদ্ধতি প্রয়োগকৃত অনুরোধ সম্পর্কে তথ্য সহ প্রতিক্রিয়া প্রদান করে। এই পদ্ধতিগুলি একটি প্রতিক্রিয়া বডি প্রদান করে যাতে response বস্তুর একটি তালিকা থাকে। অন্যান্য অনুরোধগুলিতে তথ্য প্রদান করে একটি খালি উত্তর প্রকাশ করার প্রয়োজন হয় না। প্রতিক্রিয়া তালিকার বস্তুগুলি সংশ্লিষ্ট অনুরোধের মতো একই সূচক ক্রম ধারণ করে।
ব্যাচ রিকোয়েস্ট তৈরির জন্য একটি জনপ্রিয় প্যাটার্ন দেখতে এরকম:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
আপনার ডক্স এপিআই কলগুলি কীভাবে ব্যাচ করবেন তার সম্পূর্ণ বিবরণের জন্য ব্যাচ অনুরোধের সেরা অনুশীলনগুলি দেখুন এবং documents.batchUpdate অনুরোধ এবং প্রতিক্রিয়ার ধরণের জন্য রেফারেন্স ডকুমেন্টেশন আপডেট করুন।
ব্যাচ আপডেট অপারেশন
বিভিন্ন ধরণের ব্যাচ আপডেট অনুরোধ রয়েছে। এখানে বিভিন্ন বিভাগে বিভক্ত অনুরোধের ধরণগুলির একটি বিশদ বিবরণ দেওয়া হল।