Google দস্তাবেজ API ব্যবহার করার সময় আপনার অনুসরণ করা উচিত বেশ কয়েকটি নীতি। এর মধ্যে রয়েছে:
- দক্ষতার জন্য পিছনের দিকে সম্পাদনা করুন
- সহযোগিতার জন্য পরিকল্পনা করুন
-
WriteControl
ক্ষেত্র ব্যবহার করে রাষ্ট্রের ধারাবাহিকতা নিশ্চিত করুন - অ্যাকাউন্টে ট্যাব নিন
নিম্নলিখিত বিভাগগুলি এই নীতিগুলি ব্যাখ্যা করে।
দক্ষতার জন্য পিছনের দিকে সম্পাদনা করুন
documents.batchUpdate
পদ্ধতিতে একটি একক কলের মধ্যে, আপনার অনুরোধগুলি সূচী অবস্থানের ক্রমানুসারে অর্ডার করুন। এটি সন্নিবেশ এবং মুছে ফেলার কারণে সূচক পরিবর্তনগুলি গণনা করার প্রয়োজনীয়তা দূর করে।
সহযোগিতার জন্য পরিকল্পনা করুন
নথির অবস্থার পরিবর্তন আশা করুন। একটি পদ্ধতি কল এবং অন্যটির মধ্যে, অন্যান্য সহযোগীরা নথিটি আপডেট করতে পারে, যেমনটি নিম্নলিখিত চিত্রে দেখানো হয়েছে:
আপনার সূচী ভুল হলে এটি ত্রুটি হতে পারে। একাধিক ব্যবহারকারী UI ব্যবহার করে একটি নথি সম্পাদনা করে, Google ডক্স স্বচ্ছভাবে এর যত্ন নেয়। যাইহোক, একজন API ক্লায়েন্ট হিসাবে আপনার অ্যাপকে অবশ্যই এটি পরিচালনা করতে হবে। এমনকি যদি আপনি নথিতে সহযোগিতার প্রত্যাশা না করেন, তবে এটি সুরক্ষামূলকভাবে প্রোগ্রাম করা এবং নথির অবস্থা সামঞ্জস্যপূর্ণ থাকে তা নিশ্চিত করা গুরুত্বপূর্ণ। ধারাবাহিকতা নিশ্চিত করার এক উপায়ের জন্য, WriteControl
বিভাগটি পর্যালোচনা করুন।
WriteControl এর সাথে রাষ্ট্রের সামঞ্জস্য স্থাপন করুন
আপনি যখন একটি নথি পড়েন এবং তারপর আপডেট করেন, তখন আপনি documents.batchUpdate
পদ্ধতিতে WriteControl
ক্ষেত্র ব্যবহার করে প্রতিযোগিতামূলক পরিবর্তনগুলি কীভাবে পরিচালনা করা হয় তার আচরণ নিয়ন্ত্রণ করতে পারেন। WriteControl
কীভাবে লেখার অনুরোধগুলি কার্যকর করা হয় তার উপর কর্তৃত্ব প্রদান করে।
আপনি এটি কীভাবে ব্যবহার করেন তা এখানে:
-
documents.get
মেথড ব্যবহার করে ডকুমেন্টটি পান এবং রিটার্ন করাdocuments
রিসোর্স থেকেrevisionId
সেভ করুন। - আপনার আপডেট অনুরোধ রচনা করুন.
- দুটি বিকল্পের একটি সহ একটি ঐচ্ছিক
WriteControl
অবজেক্ট অন্তর্ভুক্ত করুন:-
requiredRevisionId
ক্ষেত্রটি যে নথিতে লেখার অনুরোধ প্রয়োগ করা হয়েছে তারrevisionId
আইডিতে সেট করা আছে। এপিআই রিড রিকোয়েস্টের পর থেকে ডকুমেন্টটি পরিবর্তন করা হলে লেখার অনুরোধ প্রসেস করা হয় না এবং এটি একটি ত্রুটি ফেরত দেয়। -
targetRevisionId
ক্ষেত্রটি নথিরrevisionId
সেট করা হয়েছে যেটিতে লেখার অনুরোধ প্রয়োগ করা হয়েছে। এপিআই রিড রিকোয়েস্টের পর থেকে ডকুমেন্টটি পরিবর্তন করা হলে, লেখার অনুরোধের পরিবর্তনগুলি সহযোগী পরিবর্তনের বিরুদ্ধে প্রয়োগ করা হয়। লেখার অনুরোধের ফলাফলে লেখার অনুরোধের পরিবর্তন এবং সহযোগী নথির একটি নতুন সংশোধনে পরিবর্তন উভয়ই অন্তর্ভুক্ত করে। ডক্স সার্ভার বিষয়বস্তু মার্জ করার জন্য দায়ী৷
-
WriteControl
ব্যবহার করে কীভাবে একটি ব্যাচ অনুরোধ তৈরি করতে হয় তার উদাহরণের জন্য, এই ব্যাচ অনুরোধের উদাহরণটি দেখুন।
অ্যাকাউন্টে ট্যাব নিন
একটি একক নথিতে একাধিক ট্যাব থাকতে পারে, যার জন্য আপনার API অনুরোধগুলিতে নির্দিষ্ট হ্যান্ডলিং প্রয়োজন৷
এখানে যা মনে রাখতে হবে:
- একটি নথির সমস্ত ট্যাব থেকে সামগ্রী পুনরুদ্ধার করতে
documents.get
পদ্ধতিতেincludeTabsContent
প্যারামিটারটিকেtrue
হিসাবে সেট করুন৷ ডিফল্টরূপে, সমস্ত ট্যাবের বিষয়বস্তু ফেরত দেওয়া হয় না। -
documents.batchUpdate
পদ্ধতিতে প্রতিটিRequest
প্রয়োগ করতে ট্যাব(গুলি) এর ID(গুলি) নির্দিষ্ট করুন৷ প্রতিটিRequest
আপডেটটি প্রয়োগ করার জন্য ট্যাবগুলি নির্দিষ্ট করার একটি উপায় রয়েছে৷ ডিফল্টরূপে, যদি একটি ট্যাব নির্দিষ্ট করা না থাকে,Request
বেশিরভাগ ক্ষেত্রে নথির প্রথম ট্যাবে প্রয়োগ করা হবে। সুনির্দিষ্ট জন্যRequest
এর ডকুমেন্টেশন পড়ুন.