Method: advertisers.list

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

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

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

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

GET https://displayvideo.googleapis.com/v5/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 (आईएसओ 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 देखें.