ফিল্ড মাস্ক ব্যবহার করুন, ফিল্ড মাস্ক ব্যবহার করুন

ফিল্ড মাস্ক হল API কলারদের জন্য সেই ক্ষেত্রগুলি তালিকাভুক্ত করার একটি উপায় যা একটি অনুরোধ ফেরত দেওয়া বা আপডেট করা উচিত৷ একটি FieldMask ব্যবহার করে API অপ্রয়োজনীয় কাজ এড়াতে এবং কর্মক্ষমতা উন্নত করতে অনুমতি দেয়। Google ডক্স API-এ পঠন এবং আপডেট উভয় পদ্ধতির জন্য একটি ফিল্ড মাস্ক ব্যবহার করা হয়।

একটি ফিল্ড মাস্ক সঙ্গে পড়ুন

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

ক্ষেত্র প্যারামিটারের বিন্যাস একটি FieldMask-এর JSON এনকোডিংয়ের মতোই। সংক্ষেপে বলা হয়েছে, একাধিক ভিন্ন ক্ষেত্র কমা-বিচ্ছিন্ন এবং সাবফিল্ডগুলি ডট-বিচ্ছিন্ন। ক্ষেত্রের নাম ক্যামেলকেস বা পৃথক_বাই_আন্ডারস্কোরে উল্লেখ করা যেতে পারে। সুবিধার জন্য, একই ধরনের একাধিক সাবফিল্ড বন্ধনীর মধ্যে তালিকাভুক্ত করা যেতে পারে।

নিম্নলিখিত documents.get অনুরোধের উদাহরণটি নথির শিরোনাম, একটি Body অবজেক্টের Paragraph এবং একটি নথির মধ্যে নথির revisionId আইডি আনতে title title,body.content(paragraph),revisionId এর একটি ফিল্ড মাস্ক ব্যবহার করে:

GET https://docs.googleapis.com/v1/documents/documentId?fields=title,body.content(paragraph),revisionId

এই পদ্ধতি কলের প্রতিক্রিয়া হল একটি Document অবজেক্ট যাতে ফিল্ড মাস্কে অনুরোধ করা উপাদানগুলি রয়েছে:

{
  "title": ""TITLE",
  "body": {
    "content": [
      {},
      {
        "paragraph": {
          "elements": [
            {
              "startIndex": 1,
              "endIndex": 59,
              "textRun": {
                "content": ""CONTENT",
                "textStyle": {}
              }
            }
          ],
          "paragraphStyle": {
            "namedStyleType": "NORMAL_TEXT",
            "direction": "LEFT_TO_RIGHT"
          }
        }
      }
    ]
  },
  "revisionId": "REVISION_ID"
}

ফিল্ড মাস্ক দিয়ে আপডেট করুন

কখনও কখনও আপনাকে অন্য ক্ষেত্রগুলি অপরিবর্তিত রেখে একটি বস্তুর শুধুমাত্র নির্দিষ্ট ক্ষেত্র আপডেট করতে হবে। একটি documents.batchUpdate অপারেশনের মধ্যে আপডেটের অনুরোধগুলি API কে জানাতে ফিল্ড মাস্ক ব্যবহার করে কোন ক্ষেত্রগুলি পরিবর্তন করা হচ্ছে৷ হালনাগাদ অনুরোধ ফিল্ড মাস্কে নির্দিষ্ট করা নেই এমন কোনো ক্ষেত্রকে উপেক্ষা করে, তাদের বর্তমান মানগুলি রেখে দেয়।

আপনি আপডেট করা বার্তায় এটি নির্দিষ্ট না করে, কিন্তু মাস্কে ক্ষেত্র যোগ করে একটি ক্ষেত্র আনসেট করতে পারেন। এটি ক্ষেত্রটির পূর্বে যে মান ছিল তা পরিষ্কার করে।

আপডেট ফিল্ড মাস্কের সিনট্যাক্স রিড ফিল্ড মাস্কের মতই।

নিম্নলিখিত উদাহরণটি 5-20 range মধ্যে নথিতে "Google ডক্স API" শব্দগুলিকে বোল্ড হিসাবে স্টাইল করতে UpdateTextStyleRequest ব্যবহার করে:

POST https://docs.googleapis.com/v1/documents/documentId:batchUpdate
{
  "title": "TITLE",
  "body": {
    "content": [
      {
        "endIndex": 1,
        "sectionBreak": {
          "sectionStyle": {
            "columnSeparatorStyle": "NONE",
            "contentDirection": "LEFT_TO_RIGHT",
            "sectionType": "CONTINUOUS"
          }
        }
      },
      {
        "startIndex": 1,
        "endIndex": 59,
        "paragraph": {
          "elements": [
            {
              "startIndex": 1,
              "endIndex": 5,
              "textRun": {
                "content": "CONTENT",
                "textStyle": {}
              }
            },
            {
              "startIndex": 5,
              "endIndex": 20,
              "textRun": {
                "content": "CONTENT",
                "textStyle": {
                  "bold": true
                }
              }
            },
            {
              "startIndex": 20,
              "endIndex": 59,
              "textRun": {
                "content": "CONTENT",
                "textStyle": {}
              }
            }
          ],
          "paragraphStyle": {
            "namedStyleType": "NORMAL_TEXT",
            "direction": "LEFT_TO_RIGHT"
          }
        }
      }
    ]
   },
   {
      ... // style details
   },
  "revisionId": "REVISION_ID",
  "suggestionsViewMode": "SUGGESTIONS_INLINE",
  "documentId": "DOCUMENT_ID"
}