The Ad Manager API provides collections of data, most commonly in List methods. Collections can be arbitrarily sized and are paginated in API responses.
মৌলিক বিষয়
Request messages for collections define an optional integer pageSize field to specify the maximum number of results to return.
pageSize প্যারামিটারটি 1000 এর কম একটি ধনাত্মক সংখ্যায় সেট করুন। আপনি যদি কোনো মান সেট না করেন বা প্যারামিটারটি শূন্যে সেট করেন, তাহলে API ডিফল্ট মান হিসেবে 50 ব্যবহার করবে। আপনি যদি প্যারামিটারটি একটি ঋণাত্মক মানে সেট করেন, তাহলে API একটি INVALID_ARGUMENT ত্রুটি ফেরত দেবে।
Refer to the resource reference documentation, for example AdBreaks , for a resource specific pageSize value.
এপিআই অনুরোধ করা সংখ্যার চেয়ে কম ফলাফল ফেরত দিতে পারে (এমনকি শূন্য ফলাফলও), যদিও তা সংগ্রহের শেষে না-ও হতে পারে। সংগ্রহে অতিরিক্ত ফলাফল আছে কিনা তা নির্ধারণ করতে 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 থাকে, যা ফিল্টারিং প্রয়োগ করার পর মোট এনটিটির সংখ্যা নির্দেশ করে। এই ফিল্ডটি শুধুমাত্র তখনই পূরণ করা হয় যখন `field mask`- এ এর জন্য অনুরোধ করা হয়।
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
ফলাফল অর্ডার করুন
Request messages for collections define a string orderBy field to specify sorting order.
ভ্যালুগুলো কমা দিয়ে আলাদা করা ফিল্ডের একটি তালিকা হওয়া উচিত। উদাহরণস্বরূপ: foo,bar । ডিফল্ট সর্টিং অর্ডার হলো অ্যাসেন্ডিং (ঊর্ধ্বক্রম)। কোনো ফিল্ডের জন্য ডিসেন্ডিং (অধঃক্রম) অর্ডার নির্দিষ্ট করতে, শেষে একটি desc সাফিক্স যোগ করুন; উদাহরণস্বরূপ: foo desc, bar । সিনট্যাক্সে অপ্রয়োজনীয় স্পেস ক্যারেক্টার উপেক্ষা করা হয়। foo, bar desc , foo , bar desc , এবং foo,bar desc এই orderBy ভ্যালুগুলো সবই সমতুল্য। সাবফিল্ডগুলো একটি . ক্যারেক্টার দিয়ে নির্দিষ্ট করা হয়, যেমন foo.bar বা address.street ।
শুধুমাত্র প্রিমিটিভ ফিল্ডের ক্ষেত্রেই অর্ডারিং সমর্থিত।
ফলাফল এড়িয়ে যান
Methods for a paginated operation define an integer skip field to skip results. The skip value refers to the number of individual resources to skip, not the number of pages.
উদাহরণস্বরূপ:
A request with no page token and a skip value of 30 returns a single page of results starting with the 31st result.
৫১তম ফলাফলের সাথে সঙ্গতিপূর্ণ একটি পেজ টোকেন (কারণ প্রথম ৫০টি ফলাফল প্রথম পৃষ্ঠায় দেখানো হয়েছিল) এবং ৩০-এর একটি স্কিপ ভ্যালু সহ একটি অনুরোধ ৮১তম ফলাফল থেকে শুরু করে ফলাফলের একটি একক পৃষ্ঠা ফেরত দেয়।
If a skip value is provided that causes the cursor to move past the end of the collection of results, the response is 200 OK with an empty result set with no nextPageToken .