Method: advertisers.list

विज्ञापन देने वाले उन लोगों या कंपनियों की सूची बनाता है जिनका ऐक्सेस मौजूदा उपयोगकर्ता के पास है.

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

एक partnerId डालना ज़रूरी है. क्रॉस-पार्टनर लिस्टिंग की सुविधा काम नहीं करती.

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

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

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

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

पैरामीटर
partnerId

string (int64 format)

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

integer

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

string

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

string

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

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

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

string

विज्ञापन देने वाले के फ़ील्ड के हिसाब से फ़िल्टर करने की सुविधा देता है.

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

  • फ़िल्टर एक्सप्रेशन में एक या उससे ज़्यादा पाबंदियां होती हैं.
  • पाबंदियों को AND या OR लॉजिकल ऑपरेटर के साथ जोड़ा जा सकता है.
  • पाबंदी का फ़ॉर्मैट {field} {operator} {value} होता है.
  • updateTime फ़ील्ड में GREATER THAN OR EQUAL TO (>=) या LESS THAN OR EQUAL TO (<=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.
  • अन्य सभी फ़ील्ड में EQUALS (=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.

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

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (ISO 8601 फ़ॉर्मैट में इनपुट या YYYY-MM-DDTHH:MM:SSZ)

उदाहरण:

  • किसी पार्टनर के तहत, विज्ञापन देने वाले सभी सक्रिय लोग या कंपनियां: entityStatus="ENTITY_STATUS_ACTIVE"
  • ऐसे सभी विज्ञापन देने वाले जिनका अपडेट करने का समय 2020-11-04T18:54:47Z (ISO 8601 फ़ॉर्मैट) से कम या उसके बराबर है: updateTime<="2020-11-04T18:54:47Z"
  • विज्ञापन देने वाले सभी ऐसे लोग या कंपनियां जिनके अपडेट का समय 2020-11-04T18:54:47Z (ISO 8601 फ़ॉर्मैट) से ज़्यादा या उसके बराबर है: updateTime>="2020-11-04T18:54:47Z"

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

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

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

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

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

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

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

object (Advertiser)

विज्ञापन देने वालों की सूची.

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

string

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

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

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

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

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