অ্যাড ম্যানেজার এপিআই ডেটা সংগ্রহ করে, সাধারণত List পদ্ধতিতে। সংগ্রহগুলি নির্বিচারে আকারের হতে পারে এবং API প্রতিক্রিয়াগুলিতে পৃষ্ঠাযুক্ত করা হয়৷
বেসিক
সংগ্রহের জন্য অনুরোধ বার্তা একটি ঐচ্ছিক পূর্ণসংখ্যা pageSize ক্ষেত্র সংজ্ঞায়িত করে ফলাফলের সর্বাধিক সংখ্যা নির্দিষ্ট করতে।
pageSize প্যারামিটারটিকে একটি ধনাত্মক সংখ্যায় সেট করুন, 1000 এর কম। আপনি যদি কোনো মান সেট না করেন বা প্যারামিটারটি শূন্যে সেট না করেন, তাহলে API 50 এর একটি ডিফল্ট মান ব্যবহার করে। আপনি যদি প্যারামিটারটিকে একটি নেতিবাচক মান সেট করেন, তাহলে API একটি INVALID_ARGUMENT ত্রুটি প্রদান করে৷
রিসোর্স রেফারেন্স ডকুমেন্টেশন পড়ুন, উদাহরণস্বরূপ AdBreaks , একটি রিসোর্স নির্দিষ্ট pageSize মানের জন্য।
সংগ্রহের শেষে না হলেও API অনুরোধ করা সংখ্যার চেয়ে কম ফলাফল দিতে পারে (শূন্য ফলাফল সহ)। সংগ্রহে অতিরিক্ত ফলাফল আছে কিনা তা নির্ধারণ করতে nextPageToken ক্ষেত্রের উপস্থিতি ব্যবহার করুন।
সংগ্রহের জন্য প্রতিক্রিয়া বার্তা একটি স্ট্রিং nextPageToken ক্ষেত্র সংজ্ঞায়িত করে, যা পরবর্তী পৃষ্ঠা পুনরুদ্ধার করতে ব্যবহার করা যেতে পারে। nextPageToken ক্ষেত্রটি খালি থাকে যখন সংগ্রহ শেষ হয়। আপনি একটি সংগ্রহের শেষে পৌঁছেছেন কিনা তা নির্ধারণ করার এটিই একমাত্র উপায়।
সংগ্রহের জন্য অনুরোধ বার্তা সংগ্রহের পরবর্তী পৃষ্ঠায় অগ্রসর হওয়ার জন্য একটি ঐচ্ছিক স্ট্রিং pageToken ক্ষেত্র সংজ্ঞায়িত করে। পরবর্তী পৃষ্ঠাগুলির জন্য অনুরোধে pageSize আকারে পরিবর্তন অনুমোদিত। অন্য সব যুক্তি একই হতে হবে; কোনো আর্গুমেন্ট ভিন্ন হলে, API একটি INVALID_ARGUMENT ত্রুটি প্রদান করে।
উদাহরণ
cURL
প্রাথমিক অনুরোধ
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500
{
"adUnits": [ ... ],
"nextPageToken": "eCGwAcs6hUerggzd2DGv"
}
পরবর্তী পৃষ্ঠার অনুরোধ
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv
{
"adUnits": [ ... ]
}
মোট আকার
সংগ্রহের জন্য প্রতিক্রিয়া বার্তাগুলি একটি পূর্ণসংখ্যার totalSize প্রদান করে যা ফিল্টারিং প্রয়োগ করার পরে সত্তার মোট সংখ্যাকে প্রতিনিধিত্ব করে। ফিল্ড মাস্কে অনুরোধ করা হলেই এই ক্ষেত্রটি পপুলেট করা হয়।
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
অর্ডার ফলাফল
সংগ্রহের জন্য অনুরোধ বার্তা বাছাই ক্রম নির্দিষ্ট করতে ক্ষেত্রের দ্বারা একটি স্ট্রিং orderBy সংজ্ঞায়িত করে।
মানগুলি ক্ষেত্রগুলির একটি কমা দ্বারা বিভক্ত তালিকা হওয়া উচিত৷ উদাহরণস্বরূপ: foo,bar । ডিফল্ট সাজানোর ক্রম ক্রমবর্ধমান। একটি ক্ষেত্রের জন্য অবরোহ ক্রম নির্দিষ্ট করতে, একটি desc প্রত্যয় যুক্ত করুন; উদাহরণস্বরূপ: foo desc, bar । সিনট্যাক্সে অপ্রয়োজনীয় স্থান অক্ষর উপেক্ষা করা হয়. orderBy দ্বারা foo, bar desc , foo , bar desc , এবং foo,bar desc সবই সমতুল্য। সাবফিল্ডগুলি একটি দিয়ে নির্দিষ্ট করা হয়েছে . অক্ষর, যেমন foo.bar বা address.street ।
অর্ডার শুধুমাত্র আদিম ক্ষেত্রে সমর্থিত.
ফলাফল এড়িয়ে যান
একটি পেজিনেটেড অপারেশনের পদ্ধতি ফলাফল এড়িয়ে যাওয়ার জন্য একটি পূর্ণসংখ্যা skip ক্ষেত্র নির্ধারণ করে। স্কিপ মানটি বাদ দেওয়ার জন্য পৃথক সম্পদের সংখ্যা বোঝায়, পৃষ্ঠার সংখ্যা নয়।
যেমন:
পৃষ্ঠার টোকেন ছাড়াই একটি অনুরোধ এবং 30 এর একটি বাদ মান 31 তম ফলাফল থেকে শুরু করে ফলাফলের একটি একক পৃষ্ঠা প্রদান করে।
51 তম ফলাফলের সাথে সম্পর্কিত একটি পৃষ্ঠা টোকেন সহ একটি অনুরোধ (কারণ প্রথম পৃষ্ঠায় প্রথম 50টি ফলাফল ফেরত দেওয়া হয়েছিল) এবং 30 এর একটি বাদ মান 81 তম ফলাফল থেকে শুরু করে ফলাফলের একটি একক পৃষ্ঠা প্রদান করে৷
যদি একটি স্কিপ মান প্রদান করা হয় যার ফলে ফলাফল সংগ্রহের শেষের দিকে কার্সার চলে যায়, তাহলে প্রতিক্রিয়াটি 200 OK একটি খালি ফলাফল সেটের সাথে কোন nextPageToken নেই।