নির্দিষ্ট ক্ষেত্র ফেরত দিন, নির্দিষ্ট ক্ষেত্র ফেরত দিন, নির্দিষ্ট ক্ষেত্র ফেরত দিন, নির্দিষ্ট ক্ষেত্র ফেরত দিন

এই ডকুমেন্টটিতে গুগল ড্রাইভে fields প্যারামিটারটি কীভাবে ব্যবহার করতে হয়, তা ব্যাখ্যা করা হয়েছে।

আপনার প্রয়োজনীয় সুনির্দিষ্ট ফিল্ডগুলো ফেরত পেতে এবং পারফরম্যান্স উন্নত করতে, আপনার মেথড কলে fields সিস্টেম প্যারামিটারটি ব্যবহার করুন।

Drive 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 রিসোর্সের ডকুমেন্টেশন দেখুন। ফাইল-নির্দিষ্ট আরও কোয়েরি টার্মের জন্য, ‘সার্চ কোয়েরি টার্মস অ্যান্ড অপারেটরস’ দেখুন।

ফিল্ড প্যারামিটার ফরম্যাট নিয়মাবলী

`fields` রিকোয়েস্ট প্যারামিটার ভ্যালুর ফরম্যাটটি মূলত XPath সিনট্যাক্সের উপর ভিত্তি করে তৈরি। ` fields প্যারামিটারের জন্য নিম্নলিখিত ফরম্যাটিং নিয়মগুলো দেওয়া হলো। এই সমস্ত নিয়মে files.get মেথড সম্পর্কিত উদাহরণ ব্যবহার করা হয়েছে।

  • একাধিক ফিল্ড নির্বাচন করতে কমা দিয়ে আলাদা করা তালিকা ব্যবহার করুন, যেমন 'name, mimeType'

  • ' a ফিল্ডের মধ্যে থাকা b ফিল্ড নির্বাচন করতে a/b ব্যবহার করুন, যেমন 'capabilities/canDownload' । আরও তথ্যের জন্য, 'Fetch the fields of a nested resource ' দেখুন।

  • অ্যারে বা অবজেক্টের নির্দিষ্ট কিছু সাব-ফিল্ড অনুরোধ করতে, এক্সপ্রেশনগুলিকে বন্ধনীতে "()" রেখে একটি সাব-সিলেক্টর ব্যবহার করুন। উদাহরণস্বরূপ, 'permissions(id)' permissions` অ্যারের প্রতিটি উপাদানের জন্য শুধুমাত্র অনুমতি আইডি ফেরত দেয়।

  • একটি অবজেক্টের সমস্ত ফিল্ড ফেরত পেতে, ফিল্ড নির্বাচনের সময় ওয়াইল্ডকার্ড হিসেবে একটি অ্যাস্টারিস্ক ( * ) ব্যবহার করুন। উদাহরণস্বরূপ, '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.get এর সাথে fields=role ব্যবহার করুন।
  • সমস্ত permissions ক্ষেত্রগুলি দেখানোর জন্য permissions.get এর সাথে fields=* করুন।
  • files.get fields=permissions(role) অথবা fields=permissions/role যুক্ত করুন।
  • সমস্ত permissions ক্ষেত্রগুলি দেখানোর জন্য files.get এর সাথে fields=permissions
  • changes.listfields=changes(file(permissions(role))) .

একাধিক ফিল্ড পুনরুদ্ধার করতে, কমা দিয়ে আলাদা করা একটি তালিকা ব্যবহার করুন। উদাহরণস্বরূপ, files.listfields=files(id,name,createdTime,modifiedTime,size)

অনুরোধ

এই উদাহরণে, আমরা অনুরোধে একটি কোয়েরি প্যারামিটার হিসেবে ফাইল আইডি পাথ প্যারামিটার এবং নেস্টেড পারমিশন রিসোর্সের নির্দিষ্ট কিছু ফিল্ডসহ একাধিক ফিল্ড প্রদান করি। প্রতিক্রিয়াটি ফাইল আইডির জন্য ফিল্ডের মানগুলো ফেরত দেয়।

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"
    }
  ]
}

বিকল্প সিস্টেম প্যারামিটার

গুগল ড্রাইভ এপিআই-এর সকল অপারেশনের ক্ষেত্রে প্রযোজ্য কোয়েরি প্যারামিটারগুলো সিস্টেম প্যারামিটারস (System Parameters) অংশে নথিভুক্ত করা আছে।