Method: advertisers.list

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

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

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

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

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

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

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

पैरामीटर
partnerId

string (int64 format)

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

integer

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

string

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

string

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

  • advertiserId (डिफ़ॉल्ट)
  • 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 देखें.