এই ডকুমেন্টটি ব্যাখ্যা করে কিভাবে Google Drive-এ fields প্যারামিটার ব্যবহার করতে হয়।
আপনার প্রয়োজনীয় সঠিক ক্ষেত্রগুলি ফেরত দিতে এবং কর্মক্ষমতা উন্নত করতে, আপনার মেথড কলে fields সিস্টেম প্যারামিটার ব্যবহার করুন।
ড্রাইভ এপিআই-তে প্রযোজ্য অন্যান্য সিস্টেম প্যারামিটারের তথ্যের জন্য, বিকল্প সিস্টেম প্যারামিটার দেখুন।
ক্ষেত্র প্যারামিটার কিভাবে কাজ করে
fields প্যারামিটার প্রতিক্রিয়া ফিল্টারিং জন্য একটি FieldMask ব্যবহার করে। ফিল্ড মাস্কগুলি ক্ষেত্রগুলির একটি উপসেট নির্দিষ্ট করতে ব্যবহৃত হয় যা একটি অনুরোধ ফেরত দেওয়া উচিত। আপনি অপ্রয়োজনীয় ডেটার অনুরোধ করবেন না তা নিশ্চিত করার জন্য একটি ফিল্ড মাস্ক ব্যবহার করা ভাল ডিজাইন অনুশীলন, যা অপ্রয়োজনীয় প্রক্রিয়াকরণের সময় এড়াতে সহায়তা করে।
আপনি যদি fields পরামিতি নির্দিষ্ট না করেন, সার্ভারটি পদ্ধতির জন্য নির্দিষ্ট ক্ষেত্রগুলির একটি ডিফল্ট সেট প্রদান করে। উদাহরণস্বরূপ, files পদ্ধতিতে list পদ্ধতিটি শুধুমাত্র kind , id , name , এবং mimeType ক্ষেত্রগুলি প্রদান করে। permissions রিসোর্সে get পদ্ধতিটি ডিফল্ট ক্ষেত্রগুলির একটি ভিন্ন সেট প্রদান করে।
about , comments ( delete ব্যতীত), এবং replies ( delete ব্যতীত) সংস্থানগুলির সমস্ত পদ্ধতির জন্য আপনাকে অবশ্যই fields পরামিতি সেট করতে হবে। এই পদ্ধতিগুলি ক্ষেত্রগুলির একটি ডিফল্ট সেট ফেরত দেয় না।
একটি সার্ভার একটি বৈধ অনুরোধ প্রক্রিয়া করার পরে যাতে fields প্যারামিটার অন্তর্ভুক্ত থাকে, এটি অনুরোধ করা ডেটা সহ একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে। যদি ক্ষেত্র প্যারামিটারে একটি ত্রুটি থাকে বা অন্যথায় অবৈধ হয়, সার্ভারটি একটি HTTP 400 Bad Request স্ট্যাটাস কোড প্রদান করে, সাথে একটি ত্রুটি বার্তা উল্লেখ করে যে আপনার ক্ষেত্র নির্বাচনের সাথে কী ভুল হয়েছে৷ উদাহরণস্বরূপ, files.list(fields='files(id,capabilities,canAddChildren)') "অবৈধ ক্ষেত্র নির্বাচন canAddChildren" এর একটি ত্রুটি দেখায়। এই উদাহরণের জন্য সঠিক ক্ষেত্র প্যারামিটার হল files.list(fields='files(id,capabilities/canAddChildren)') ।
fields প্যারামিটার ব্যবহার করে আপনি যে ক্ষেত্রগুলি ফেরত দিতে পারেন তা নির্ধারণ করতে, আপনি যে সংস্থানটি অনুসন্ধান করছেন তার ডকুমেন্টেশন পৃষ্ঠায় যান৷ উদাহরণস্বরূপ, একটি ফাইলের জন্য আপনি কোন ক্ষেত্রগুলি ফেরত দিতে পারেন তা দেখতে, files সংস্থান ডকুমেন্টেশন দেখুন। আরও ফাইল-নির্দিষ্ট ক্যোয়ারী পদের জন্য, অনুসন্ধান ক্যোয়ারী পদ এবং অপারেটর দেখুন।
ক্ষেত্র প্যারামিটার বিন্যাস নিয়ম
ক্ষেত্র অনুরোধ প্যারামিটার মান বিন্যাস শিথিলভাবে XPath সিনট্যাক্সের উপর ভিত্তি করে। নিম্নলিখিত fields পরামিতি জন্য বিন্যাস নিয়ম. এই সমস্ত নিয়ম files.get পদ্ধতি সম্পর্কিত উদাহরণ ব্যবহার করে।
একাধিক ক্ষেত্র নির্বাচন করতে একটি কমা-বিভক্ত তালিকা ব্যবহার করুন, যেমন
'name, mimeType'।a/bক্ষেত্র নির্বাচন করতে a/bব্যবহার করুন যেটি ক্ষেত্রaমধ্যে নেস্ট করা আছে, যেমন'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 ক্ষেত্র (নেস্টেড রিসোর্স) পুনরুদ্ধার করতে, নিম্নলিখিত বিকল্পগুলির যে কোনো একটি ব্যবহার করুন:
-
permissions.getwithfields=role. -
permissions.getwithfields=*সবpermissionsক্ষেত্র দেখাতে। -
files.getwithfields=permissions(role)orfields=permissions/role. -
files.getwithfields=permissionsto show allpermissionsfields. -
fields=changes(file(permissions(role)))সহchanges.list।
একাধিক ক্ষেত্র পুনরুদ্ধার করতে, একটি কমা দ্বারা পৃথক করা তালিকা ব্যবহার করুন৷ উদাহরণস্বরূপ, 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 অপারেশনে প্রযোজ্য কোয়েরি প্যারামিটারগুলি সিস্টেম প্যারামিটারে নথিভুক্ত করা হয়।
সম্পর্কিত বিষয়
, এই ডকুমেন্টটি ব্যাখ্যা করে কিভাবে Google Drive-এ fields প্যারামিটার ব্যবহার করতে হয়।
আপনার প্রয়োজনীয় সঠিক ক্ষেত্রগুলি ফেরত দিতে এবং কর্মক্ষমতা উন্নত করতে, আপনার মেথড কলে fields সিস্টেম প্যারামিটার ব্যবহার করুন।
ড্রাইভ এপিআই-তে প্রযোজ্য অন্যান্য সিস্টেম প্যারামিটারের তথ্যের জন্য, বিকল্প সিস্টেম প্যারামিটার দেখুন।
ক্ষেত্র প্যারামিটার কিভাবে কাজ করে
fields প্যারামিটার প্রতিক্রিয়া ফিল্টারিং জন্য একটি FieldMask ব্যবহার করে। ফিল্ড মাস্কগুলি ক্ষেত্রগুলির একটি উপসেট নির্দিষ্ট করতে ব্যবহৃত হয় যা একটি অনুরোধ ফেরত দেওয়া উচিত। আপনি অপ্রয়োজনীয় ডেটার অনুরোধ করবেন না তা নিশ্চিত করার জন্য একটি ফিল্ড মাস্ক ব্যবহার করা ভাল ডিজাইন অনুশীলন, যা অপ্রয়োজনীয় প্রক্রিয়াকরণের সময় এড়াতে সহায়তা করে।
আপনি যদি fields পরামিতি নির্দিষ্ট না করেন, সার্ভারটি পদ্ধতির জন্য নির্দিষ্ট ক্ষেত্রগুলির একটি ডিফল্ট সেট প্রদান করে। উদাহরণস্বরূপ, files পদ্ধতিতে list পদ্ধতিটি শুধুমাত্র kind , id , name , এবং mimeType ক্ষেত্রগুলি প্রদান করে। permissions রিসোর্সে get পদ্ধতিটি ডিফল্ট ক্ষেত্রগুলির একটি ভিন্ন সেট প্রদান করে।
about , comments ( delete ব্যতীত), এবং replies ( delete ব্যতীত) সংস্থানগুলির সমস্ত পদ্ধতির জন্য আপনাকে অবশ্যই fields পরামিতি সেট করতে হবে। এই পদ্ধতিগুলি ক্ষেত্রগুলির একটি ডিফল্ট সেট ফেরত দেয় না।
একটি সার্ভার একটি বৈধ অনুরোধ প্রক্রিয়া করার পরে যাতে fields প্যারামিটার অন্তর্ভুক্ত থাকে, এটি অনুরোধ করা ডেটা সহ একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে। যদি ক্ষেত্র প্যারামিটারে একটি ত্রুটি থাকে বা অন্যথায় অবৈধ হয়, সার্ভারটি একটি HTTP 400 Bad Request স্ট্যাটাস কোড প্রদান করে, সাথে একটি ত্রুটি বার্তা উল্লেখ করে যে আপনার ক্ষেত্র নির্বাচনের সাথে কী ভুল হয়েছে৷ উদাহরণস্বরূপ, files.list(fields='files(id,capabilities,canAddChildren)') "অবৈধ ক্ষেত্র নির্বাচন canAddChildren" এর একটি ত্রুটি দেখায়। এই উদাহরণের জন্য সঠিক ক্ষেত্র প্যারামিটার হল files.list(fields='files(id,capabilities/canAddChildren)') ।
fields প্যারামিটার ব্যবহার করে আপনি যে ক্ষেত্রগুলি ফেরত দিতে পারেন তা নির্ধারণ করতে, আপনি যে সংস্থানটি অনুসন্ধান করছেন তার ডকুমেন্টেশন পৃষ্ঠায় যান৷ উদাহরণস্বরূপ, একটি ফাইলের জন্য আপনি কোন ক্ষেত্রগুলি ফেরত দিতে পারেন তা দেখতে, files সংস্থান ডকুমেন্টেশন দেখুন। আরও ফাইল-নির্দিষ্ট ক্যোয়ারী পদের জন্য, অনুসন্ধান ক্যোয়ারী পদ এবং অপারেটর দেখুন।
ক্ষেত্র প্যারামিটার বিন্যাস নিয়ম
ক্ষেত্র অনুরোধ প্যারামিটার মান বিন্যাস শিথিলভাবে XPath সিনট্যাক্সের উপর ভিত্তি করে। নিম্নলিখিত fields পরামিতি জন্য বিন্যাস নিয়ম. এই সমস্ত নিয়ম files.get পদ্ধতি সম্পর্কিত উদাহরণ ব্যবহার করে।
একাধিক ক্ষেত্র নির্বাচন করতে একটি কমা-বিভক্ত তালিকা ব্যবহার করুন, যেমন
'name, mimeType'।a/bক্ষেত্র নির্বাচন করতে a/bব্যবহার করুন যেটি ক্ষেত্রaমধ্যে নেস্ট করা আছে, যেমন'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 ক্ষেত্র (নেস্টেড রিসোর্স) পুনরুদ্ধার করতে, নিম্নলিখিত বিকল্পগুলির যে কোনো একটি ব্যবহার করুন:
-
permissions.getwithfields=role. -
permissions.getwithfields=*সবpermissionsক্ষেত্র দেখাতে। -
files.getwithfields=permissions(role)orfields=permissions/role. -
files.getwithfields=permissionsto show allpermissionsfields. -
fields=changes(file(permissions(role)))সহchanges.list।
একাধিক ক্ষেত্র পুনরুদ্ধার করতে, একটি কমা দ্বারা পৃথক করা তালিকা ব্যবহার করুন৷ উদাহরণস্বরূপ, 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 অপারেশনে প্রযোজ্য কোয়েরি প্যারামিটারগুলি সিস্টেম প্যারামিটারে নথিভুক্ত করা হয়।