Method: advertisers.list

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

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

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

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

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

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

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

पैरामीटर
partnerId

string (int64 format)

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

integer

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

string

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

string

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

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

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

string

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

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

  • फ़िल्टर एक्सप्रेशन में एक या ज़्यादा पाबंदियां होती हैं.
  • AND या OR लॉजिकल ऑपरेटर की मदद से, पाबंदियां जोड़ी जा सकती हैं. पाबंदियों का क्रम, साफ़ तौर पर AND का इस्तेमाल करता है.
  • पाबंदी {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 (format of ISO 8601) से कम या इसके बराबर है: updateTime<="2020-11-04T18:54:47Z"
  • वे सभी विज्ञापन देने वाले जिनका अपडेट का समय 2020-11-04T18:54:47Z (format of ISO 8601) से ज़्यादा या इसके बराबर है: updateTime>="2020-11-04T18:54:47Z"

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

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

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

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

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

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

object (Advertiser)

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

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

string

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

अनुमति पाने के लिंक

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

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

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