पेजिनेशन

अभियानों की अधिकतम संख्या को बढ़ाने और किसी खाते से संबद्ध सभी एंटिटी को कुशलतापूर्वक प्राप्त करने के समर्थन के लिए, Advertiser API अब कई GET एंडपॉइंट्स पर पेजिनेशन का समर्थन करता है। यह पेजिंग मैकेनिज़्म इस्तेमाल में आसान है और REST API के कर्सर-आधारित पेजिनेशन के बहुत समान है, जैसा कि कलेक्शनों में नेविगेट करने के लिए कर्सर का उपयोग करना में बताया गया है।

शुरुआत करें

निर्दिष्ट GET अनुरोधों के लिए, अब हम cursor और count क्वेरी पैरामीटर स्वीकार करते हैं, जो दोनों वैकल्पिक हैं। यदि किसी रिस्पॉन्स में count से अधिक एंटिटी हैं, तो ये एंडपॉइंट अब पहली count एंटिटी और रिस्पॉन्स JSON में next_cursor कुंजी लौटाएँगे।

GET https://ads-api.x.com/5/accounts/abc1/campaigns?count=50

{
  "data": \[...\],
  "next_cursor": "c-3yvu1pzhd3i7",
  "request": {...}
}

रिस्पॉन्स की अगली श्रृंखला पाने के लिए, आप अपने query params में cursor जोड़ेंगे:

GET https://ads-api.x.com/5/accounts/abc1/campaigns?cursor=c-3yvu1pzhd3i7&count=50

{
  "data": \[...\],
  "next_cursor": "c-3w3zdyg8ywan",
  "request": {...}
}

और गहराई से समझें

ज़्यादातर एंडपॉइंट के लिए, count का अधिकतम मान 1,000, न्यूनतम 1, और डिफ़ॉल्ट 200 होता है।

next_cursor द्वारा दिया गया मान हमेशा एक string होता है और इसे एक अपारदर्शी मान माना जाना चाहिए; इसका कार्यान्वयन बदल सकता है। अगर परिणाम सेट के मौजूदा पेज में count से कम एंटिटी लौटती हैं, तो next_cursor का मान null होगा।

नोट: analytics एंडपॉइंट इस तरह के पेजिनेशन का समर्थन नहीं करते। stats एंडपॉइंट में paging, समय-अवधि निर्दिष्ट करके समर्थित होती है। अधिक जानकारी के लिए उन एंडपॉइंट के अलग-अलग दस्तावेज़ देखें।