এই ডকুমেন্টটি ব্যাখ্যা করে কিভাবে গুগল ড্রাইভে fields প্যারামিটার ব্যবহার করতে হয়।
আপনার প্রয়োজনীয় সঠিক ক্ষেত্রগুলি ফেরত দিতে এবং কর্মক্ষমতা উন্নত করতে, আপনার পদ্ধতি কলে fields system প্যারামিটারটি ব্যবহার করুন।
ড্রাইভ API-তে প্রযোজ্য অন্যান্য সিস্টেম প্যারামিটার সম্পর্কে তথ্যের জন্য, বিকল্প সিস্টেম প্যারামিটার দেখুন।
ফিল্ড প্যারামিটার কিভাবে কাজ করে
fields প্যারামিটারটি রেসপন্স ফিল্টারিংয়ের জন্য একটি FieldMask ব্যবহার করে। ফিল্ড মাস্কগুলি ফিল্ডের একটি উপসেট নির্দিষ্ট করতে ব্যবহৃত হয় যেখানে একটি অনুরোধ ফেরত পাঠানো উচিত। ফিল্ড মাস্ক ব্যবহার করা একটি ভাল ডিজাইন অনুশীলন যা নিশ্চিত করে যে আপনি অপ্রয়োজনীয় ডেটা অনুরোধ করছেন না, যা অপ্রয়োজনীয় প্রক্রিয়াকরণের সময় এড়াতে সাহায্য করে।
যদি আপনি fields প্যারামিটার নির্দিষ্ট না করেন, তাহলে সার্ভার পদ্ধতির জন্য নির্দিষ্ট ক্ষেত্রগুলির একটি ডিফল্ট সেট ফেরত পাঠাবে। উদাহরণস্বরূপ, files পদ্ধতিতে list পদ্ধতি শুধুমাত্র kind , id , name , এবং mimeType ক্ষেত্রগুলি ফেরত পাঠাবে। permissions রিসোর্সে get পদ্ধতিটি ডিফল্ট ক্ষেত্রগুলির একটি ভিন্ন সেট ফেরত পাঠাবে।
about , comments ( delete ব্যতীত), এবং replies ( delete ব্যতীত) রিসোর্সের সকল পদ্ধতির জন্য আপনাকে fields প্যারামিটার সেট করতে হবে । এই পদ্ধতিগুলি ডিফল্ট ফিল্ড সেট ফেরত দেয় না।
একটি সার্ভার একটি বৈধ অনুরোধ প্রক্রিয়া করার পর, যাতে fields প্যারামিটার অন্তর্ভুক্ত থাকে, এটি অনুরোধকৃত ডেটা সহ একটি HTTP 200 OK স্ট্যাটাস কোড ফেরত পাঠায়। যদি fields প্যারামিটারে কোনও ত্রুটি থাকে বা অন্যথায় অবৈধ হয়, তাহলে সার্ভারটি একটি HTTP 400 Bad Request স্ট্যাটাস কোড ফেরত পাঠায়, এবং আপনার ক্ষেত্র নির্বাচনের সমস্যা সম্পর্কে একটি ত্রুটি বার্তাও প্রদান করে। উদাহরণস্বরূপ, files.list(fields='files(id,capabilities,canAddChildren)') "Invalid field selection canAddChildren" এর একটি ত্রুটি প্রদান করে। এই উদাহরণের জন্য সঠিক fields প্যারামিটার হল files.list(fields='files(id,capabilities/canAddChildren)') ।
fields প্যারামিটার ব্যবহার করে আপনি কোন ক্ষেত্রগুলি ফেরত দিতে পারবেন তা নির্ধারণ করতে, আপনি যে রিসোর্সটি জিজ্ঞাসা করছেন তার ডকুমেন্টেশন পৃষ্ঠাটি দেখুন। উদাহরণস্বরূপ, একটি ফাইলের জন্য আপনি কোন ক্ষেত্রগুলি ফেরত দিতে পারবেন তা দেখতে, files রিসোর্স ডকুমেন্টেশনটি দেখুন। আরও ফাইল-নির্দিষ্ট ক্যোয়ারি পদের জন্য, অনুসন্ধান ক্যোয়ারি পদ এবং অপারেটর দেখুন।
ফিল্ড প্যারামিটার ফর্ম্যাটের নিয়ম
ফিল্ড রিকোয়েস্ট প্যারামিটারের মানের ফর্ম্যাটটি XPath সিনট্যাক্সের উপর ভিত্তি করে তৈরি। fields প্যারামিটারের ফর্ম্যাটিংয়ের নিয়মগুলি নীচে দেওয়া হল। এই সমস্ত নিয়ম files.get পদ্ধতির সাথে সম্পর্কিত উদাহরণ ব্যবহার করে।
'name, mimeType'এর মতো একাধিক ক্ষেত্র নির্বাচন করতে কমা দ্বারা পৃথক করা তালিকা ব্যবহার করুন।a/bব্যবহার করেaফিল্ডের মধ্যে নেস্টেড ফিল্ডbনির্বাচন করুন, যেমন'capabilities/canDownload'। আরও তথ্যের জন্য, নেস্টেড রিসোর্সের ফিল্ডগুলি আনুন দেখুন।"()" বন্ধনীতে এক্সপ্রেশন স্থাপন করে অ্যারে বা বস্তুর নির্দিষ্ট উপ-ক্ষেত্রের একটি সেট অনুরোধ করতে একটি সাব-সিলেক্টর ব্যবহার করুন। উদাহরণস্বরূপ,
'permissions(id)'অনুমতি অ্যারেতে প্রতিটি উপাদানের জন্য শুধুমাত্র অনুমতি আইডি প্রদান করে।কোনও বস্তুর সমস্ত ক্ষেত্র ফেরত দিতে, ক্ষেত্র নির্বাচনের ক্ষেত্রে ওয়াইল্ডকার্ড হিসেবে একটি তারকাচিহ্ন (
*) ব্যবহার করুন। উদাহরণস্বরূপ,'permissions/permissionDetails/*'প্রতিটি অনুমতির জন্য উপলব্ধ সমস্ত অনুমতি বিবরণ ক্ষেত্র নির্বাচন করে। মনে রাখবেন যে ওয়াইল্ডকার্ড ব্যবহার করলে অনুরোধের উপর নেতিবাচক কর্মক্ষমতা প্রভাব পড়তে পারে।
অনুরোধ
এই উদাহরণে, আমরা অনুরোধে ফাইল আইডি পাথ প্যারামিটার এবং একাধিক ক্ষেত্র একটি কোয়েরি প্যারামিটার হিসেবে প্রদান করি। প্রতিক্রিয়াটি ফাইল আইডির জন্য ক্ষেত্রের মানগুলি ফেরত দেয়।
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared
প্রতিক্রিয়া
{
"name": "File1",
"starred": false,
"shared": true
}
}একটি নেস্টেড রিসোর্সের ক্ষেত্রগুলি আনুন
যখন একটি ক্ষেত্র অন্য একটি সম্পদকে নির্দেশ করে, তখন আপনি নেস্টেড সম্পদের কোন ক্ষেত্রগুলি আনা উচিত তা নির্দিষ্ট করতে পারেন।
উদাহরণস্বরূপ, permissions সম্পদের role ক্ষেত্র (নেস্টেড সম্পদ) পুনরুদ্ধার করতে, নিম্নলিখিত বিকল্পগুলির যেকোনো একটি ব্যবহার করুন:
-
fields=roleসহpermissions.get। -
permissions.getব্যবহার করেfields=*ব্যবহার করুন যাতে সকলpermissionsক্ষেত্র দেখা যায়। -
fields=permissions(role)অথবাfields=permissions/roleসহfiles.get। -
files.getএর সাথেfields=permissionsব্যবহার করে সকলpermissionsক্ষেত্র দেখান। -
changes.listসহfields=changes(file(permissions(role)))।
একাধিক ক্ষেত্র পুনরুদ্ধার করতে, কমা দ্বারা পৃথক করা একটি তালিকা ব্যবহার করুন। উদাহরণস্বরূপ, fields=files(id,name,createdTime,modifiedTime,size) সহ files.list ।
অনুরোধ
এই উদাহরণে, আমরা অনুরোধে একটি কোয়েরি প্যারামিটার হিসেবে ফাইল আইডি পাথ প্যারামিটার এবং নেস্টেড পারমিশন রিসোর্সের নির্দিষ্ট ক্ষেত্র সহ একাধিক ক্ষেত্র প্রদান করি। প্রতিক্রিয়াটি ফাইল আইডির জন্য ক্ষেত্র মানগুলি ফেরত দেয়।
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared,permissions(kind,type,role)
প্রতিক্রিয়া
{ "name": "File1", "starred": false, "shared": true, "permissions": [ { "kind": "drive#permission", "type": "user", "role": "owner" } ] }
বিকল্প সিস্টেম পরামিতি
সমস্ত Google ড্রাইভ API ক্রিয়াকলাপের ক্ষেত্রে প্রযোজ্য কোয়েরি প্যারামিটারগুলি সিস্টেম প্যারামিটারে নথিভুক্ত করা হয়েছে।