खोज नतीजों को पेजों में बांटना

Ad Manager REST API, डेटा का कलेक्शन उपलब्ध कराता है. यह आम तौर पर लिस्ट में होता है तरीकों का इस्तेमाल करना होगा. कलेक्शन का साइज़ अपने हिसाब से तय किया जा सकता है. साथ ही, एपीआई में उन्हें पेजों में बांटा जा सकता है जवाब.

बुनियादी बातें

कलेक्शन के अनुरोध मैसेज में वैकल्पिक पूर्णांक pageSize फ़ील्ड होता है दिए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या तय करें.

अगर pageSize सेट नहीं है या 0 है, तो डिफ़ॉल्ट वैल्यू 50 का इस्तेमाल किया जाता है. अगर pageSize, पेज का साइज़ 1,000 से ज़्यादा है, तो एपीआई पेज का साइज़ 1,000 तक होना चाहिए. नेगेटिव वैल्यू की वजह से INVALID_ARGUMENT गड़बड़ी होती है.

ऐसा हो सकता है कि एपीआई, अनुरोध की गई संख्या से कम नतीजे दिखाए. इसमें शून्य भी शामिल हैं नतीजों के साथ दिखाया जाता है), भले ही वह कलेक्शन के आखिर में न हो. इन इवेंट में आपकी मौजूदगी का इस्तेमाल करें nextPageToken फ़ील्ड की मदद से यह तय किया जा सकता है कि संग्रह.

कलेक्शन के रिस्पॉन्स मैसेज में स्ट्रिंग nextPageToken फ़ील्ड होता है, जो का इस्तेमाल अगले पेज को वापस पाने के लिए किया जा सकता है. जब कलेक्शन खत्म होता है, तो nextPageToken फ़ील्ड खाली होता है पहुंच गया. यह पता करने का यह एक तरीका है कि आपने आखिर में संग्रह.

कलेक्शन के अनुरोध के मैसेज में वैकल्पिक स्ट्रिंग pageToken फ़ील्ड का पता चलता है संग्रह के अगले पेज पर जाने के लिए. बाद के पेजों के अनुरोध में pageSize में बदलाव करने की अनुमति है. अन्य सभी तर्क एक जैसे होने चाहिए; अगर कोई तर्क अलग-अलग है, तो एपीआई 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.

अहम जानकारी: skip फ़ील्ड का इस्तेमाल विकल्प के तौर पर नहीं किया जाना चाहिए खोज नतीजों को पेजों में बांटना. पेज पर नंबर डालने वाला टोकन यह पक्का करता है कि रिस्पॉन्स उसी शुरुआती हिस्से से आए नतीजा सेट किया जा सकता है.