Method: customLists.list

यह कस्टम सूचियों का इस्तेमाल करता है.

यह क्रम, orderBy पैरामीटर से तय होता है.

एचटीटीपी अनुरोध

GET https://displayvideo.googleapis.com/v2/customLists

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

अनुरोध किए गए पेज का साइज़. यह 1 और 200 के बीच होना चाहिए. अगर कोई भी वैल्यू सेट नहीं की गई है, तो वह डिफ़ॉल्ट रूप से 100 पर सेट हो जाएगी. अमान्य वैल्यू देने पर, गड़बड़ी कोड INVALID_ARGUMENT दिखाता है.

pageToken

string

एक टोकन, जो सर्वर को दिखाए जाने वाले नतीजों के पेज की पहचान करता है. आम तौर पर, यह nextPageToken की वैल्यू होती है, जो पिछली कॉल टू customLists.list तरीके से मिलती है. अगर इसके बारे में नहीं बताया गया है, तो नतीजों का पहला पेज दिखाया जाएगा.

orderBy

string

वह फ़ील्ड जिसके हिसाब से सूची को क्रम से लगाना है. स्वीकार की जाने वाली वैल्यू ये हैं:

  • customListId (डिफ़ॉल्ट)
  • displayName

क्रम से लगाने का डिफ़ॉल्ट क्रम बढ़ते क्रम में है. किसी फ़ील्ड के घटते क्रम में तय करने के लिए फ़ील्ड के नाम में "ब्यौरा" सफ़िक्स जोड़ना चाहिए. उदाहरण: displayName desc.

filter

string

कस्टम सूची फ़ील्ड के हिसाब से फ़िल्टर करने की अनुमति देता है.

इस्तेमाल किया जा सकने वाला सिंटैक्स:

  • कस्टम सूचियों के लिए फ़िल्टर एक्सप्रेशन में, ज़्यादा से ज़्यादा एक पाबंदी हो सकती है.
  • पाबंदी {field} {operator} {value} तरह की होती है.
  • सभी फ़ील्ड में HAS (:) ऑपरेटर का इस्तेमाल किया जाना चाहिए.

इस्तेमाल किए जा सकने वाले फ़ील्ड:

  • displayName

उदाहरण:

  • वे सभी कस्टम सूचियां जिनके लिए डिसप्ले नेम में "Google" शामिल है: displayName:"Google".

इस फ़ील्ड में 500 से ज़्यादा वर्ण नहीं होने चाहिए.

ज़्यादा जानकारी के लिए, फ़िल्टर LIST के अनुरोध वाली हमारी गाइड देखें.

यूनियन पैरामीटर accessor. ज़रूरी है. इससे पता चलता है कि DV360 की किस इकाई में अनुरोध किया जा रहा है. सूची अनुरोध से, कस्टम सूची वाली सिर्फ़ वे इकाइयां दिखेंगी जिन्हें accessor में पहचानी गई DV360 इकाई के लिए ऐक्सेस किया जा सकता है. accessor इनमें से सिर्फ़ एक हो सकती है:
advertiserId

string (int64 format)

DV360 की मदद से विज्ञापन देने वाले का वह आईडी जिसके पास, फ़ेच की गई कस्टम सूचियों का ऐक्सेस है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

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

जेएसओएन के काेड में दिखाना
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
customLists[]

object (CustomList)

कस्टम सूचियों की सूची.

अगर कोई सूची खाली होगी, तो यह नहीं दिखेगी.

nextPageToken

string

नतीजों का अगला पेज फिर से पाने के लिए टोकन. नतीजों का अगला पेज वापस पाने के लिए, customLists.list को बाद में किए जाने वाले कॉल के pageToken फ़ील्ड में इस वैल्यू को पास करें.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/display-video

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.