Method: advertisers.list

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

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

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

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

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

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

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

पैरामीटर
partnerId

string (int64 format)

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

integer

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

string

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

string

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

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

क्रम से लगाने का डिफ़ॉल्ट क्रम बढ़ते क्रम में है. किसी फ़ील्ड के घटते क्रम में तय करने के लिए फ़ील्ड के नाम में "ब्यौरा" सफ़िक्स जोड़ना चाहिए. उदाहरण के लिए, 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 के अनुरोध वाली हमारी गाइड देखें.

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

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

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

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

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

object (Advertiser)

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

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

string

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

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

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

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

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