Method: customLists.list

कस्टम सूचियों की जानकारी देता है.

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

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

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

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

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

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

string

इसकी मदद से, कस्टम लिस्ट फ़ील्ड के हिसाब से फ़िल्टर किया जा सकता है.

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

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

इन फ़ील्ड के लिए यह सुविधा उपलब्ध है:

  • displayName

उदाहरण:

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

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

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

string (int64 format)

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

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

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

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

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

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

object (CustomList)

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

अगर यह सूची खाली होगी, तो यह मौजूद नहीं होगी.
nextPageToken

string

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

अनुमति पाने के लिंक

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

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

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