Method: customLists.list

कस्टम सूचियां दिखाता है.

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

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

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

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

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

पैरामीटर
pageSize

integer

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

string

नतीजों के उस पेज की पहचान करने वाला टोकन जिसे सर्वर को दिखाना चाहिए. आम तौर पर, यह customLists.list वाले तरीके के पिछले कॉल से मिली nextPageToken की वैल्यू होती है. अगर कोई वैल्यू नहीं दी जाती है, तो नतीजों का पहला पेज दिखेगा.
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 की खास जानकारी देखें.