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 देखें.