ফিল্ড মাস্ক

অ্যাড ম্যানেজার REST API আংশিক পড়া এবং লেখার জন্য ফিল্ড মাস্ক ব্যবহার করে। এটি স্থানান্তরিত ডেটার পরিমাণ সীমিত করে কর্মক্ষমতা উন্নত করতে পারে। ফিল্ড মাস্কগুলি কমা দ্বারা বিভক্ত ক্ষেত্রের নামের তালিকা দ্বারা উপস্থাপিত হয়। যেমন:

startTime,endTime,targeting.geoTargeting

মুখোশ পড়ুন

মাস্ক পড়ুন নিয়ন্ত্রণ করুন কোন ক্ষেত্রগুলি একটি API প্রতিক্রিয়াতে উপস্থিত রয়েছে। আপনি দুটি উপায়ে আপনার অনুরোধে একটি রিড মাস্ক সেট করতে পারেন:

1. fields ক্যোয়ারী প্যারামিটার:

   curl https://admanager.googleapis.com/v1/networks/123456/adUnits?fields=adUnits,nextPageToken,totalSize

2. X-Goog-FieldMask HTTP হেডার:

   curl -H "X-Goog-FieldMask: adUnits,nextPageToken,totalSize" \
       https://admanager.googleapis.com/v1/networks/123456/adUnits

দ্রষ্টব্য: camelCase এবং snake_case উভয়ই ফিল্ড মাস্ক স্ট্রিংগুলিতে সমর্থিত।

ডিফল্ট মাস্ক পড়া

কিছু এপিআই পদ্ধতিতে এমন ক্ষেত্রগুলির জন্য একটি ডিফল্ট ফিল্ড মাস্ক রয়েছে যা ফেরত দেওয়া ব্যয়বহুল। তালিকা পদ্ধতি এই একটি উদাহরণ. ডিফল্টরূপে, তারা totalSize ক্ষেত্র অন্তর্ভুক্ত করে না।

এই ক্ষেত্রগুলি অবশ্যই নাম দ্বারা বা * ওয়াইল্ডকার্ড ব্যবহার করে ফিল্ড মাস্কে স্পষ্টভাবে অনুরোধ করতে হবে।

মাস্ক আপডেট করুন

হালনাগাদ মাস্ক নিয়ন্ত্রণ করে কোন ক্ষেত্রগুলি একটি আপডেট ( PATCH ) অনুরোধে পরিবর্তন করা হবে৷ যখন একটি আপডেট মাস্ক সেট করা হয়, অনুরোধের বডিতে যে ক্ষেত্রগুলি সেট করা হোক না কেন শুধুমাত্র মাস্কের ক্ষেত্রগুলি আপডেট করা হবে৷

আপডেট মাস্ক ক্যোয়ারী পরামিতি হিসাবে সেট করা হয়. যেমন:

curl -X PATCH https://admanager.googleapis.com/v1/networks/1234/order/4567?updateMask=displayName

ফিল্ড ট্রাভার্সাল

ফিল্ড মাস্ক ব্যবহার করে একটি সত্তার মধ্যে ক্ষেত্র নির্দিষ্ট করতে পারে . ট্রাভার্সাল জন্য চরিত্র. এটি ফিল্টার দ্বারা ব্যবহৃত একই সিনট্যাক্স।

ফিল্ড মাস্ক সবসময় প্রতিক্রিয়া বস্তুর আপেক্ষিক হয়. উদাহরণস্বরূপ, একটি LineItem পড়ার জন্য একটি মাস্ক primaryGoal.units অন্তর্ভুক্ত হতে পারে। LineItems তালিকাভুক্ত করার জন্য সংশ্লিষ্ট মুখোশ হল lineItems.primaryGoal.units ।

আপনি একটি সম্পূর্ণ ক্ষেত্র বা এর একটি সাবফিল্ড উল্লেখ করতে পারেন। primaryGoal এবং primaryGoal.units উভয়ই বৈধ।

এটি পুনরাবৃত্তি ক্ষেত্রের ক্ষেত্রেও প্রযোজ্য। creativePlaceholders.size এর একটি LineItem ফিল্ড মাস্ক বৈধ এবং শুধুমাত্র প্রতিটি CreativePlaceholder এর জন্য size ক্ষেত্র অন্তর্ভুক্ত করে।

দ্রষ্টব্য: ফিল্ড মাস্কগুলি সূচী দ্বারা পুনরাবৃত্ত ক্ষেত্রের একটি নির্দিষ্ট উপাদান অ্যাক্সেস করার অনুমতি দেয় না। এর ফলে একটি INVALID_ARGUMENT ত্রুটি হয়েছে৷

ওয়াইল্ডকার্ড

সতর্কতা: আপডেট মাস্কে ওয়াইল্ডকার্ড ব্যবহার করা ফরওয়ার্ড সামঞ্জস্যপূর্ণ নয়। ওয়াইল্ডকার্ড আপনার ক্লায়েন্টের অজানা যে কোনো ক্ষেত্র সাফ করবে।

ফিল্ড মাস্ক * অক্ষর সমর্থন করে যা বার্তার সমস্ত ক্ষেত্র নির্দেশ করে। নিম্নলিখিত উদাহরণগুলি Orders তালিকাভুক্ত করার সময় ওয়াইল্ডকার্ড ব্যবহার প্রদর্শন করে৷ এই পদ্ধতিতে একটি ডিফল্ট রিড মাস্ক রয়েছে যেটিতে total_size ক্ষেত্র অন্তর্ভুক্ত নয়।

উদাহরণ	অর্থ
*	total_size সহ সমস্ত ক্ষেত্র অন্তর্ভুক্ত করে
orders	শুধুমাত্র orders ক্ষেত্র এবং এর সমস্ত সাবফিল্ড অন্তর্ভুক্ত করে
orders.*	শুধুমাত্র orders ক্ষেত্র এবং এর সমস্ত সাবফিল্ড অন্তর্ভুক্ত করে

অবৈধ ক্ষেত্র

যদি একটি ফিল্ড মাস্ক এমন একটি মানকে বোঝায় যা বিদ্যমান নেই, তাহলে API একটি INVALID_ARGUMENT ত্রুটির সাথে প্রতিক্রিয়া জানাবে৷