Method: advertisers.campaigns.list

यह विकल्प किसी विज्ञापन देने वाले के कैंपेन की सूची बनाता है.

ऑर्डर, orderBy पैरामीटर से तय होता है. अगर entityStatus का filter नहीं बताया गया है, तो ENTITY_STATUS_ARCHIVED वाले कैंपेन, नतीजों में शामिल नहीं किए जाएंगे.

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

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

विज्ञापन देने वाले व्यक्ति या कंपनी का आईडी, जिसके लिए कैंपेन की सूची बनानी है.

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

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

string

यह कैंपेन फ़ील्ड के हिसाब से फ़िल्टर करने की अनुमति देता है.

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

  • फ़िल्टर एक्सप्रेशन में एक या ज़्यादा पाबंदियां होती हैं.
  • AND या OR लॉजिकल ऑपरेटर, पाबंदियों को जोड़ सकते हैं. पाबंदियों का क्रम, साफ़ तौर पर AND का इस्तेमाल करता है.
  • पाबंदी {field} {operator} {value} में होती है.
  • updateTime फ़ील्ड में GREATER THAN OR EQUAL TO (>=) या LESS THAN OR EQUAL TO (<=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.
  • अन्य सभी फ़ील्ड में, EQUALS (=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.

इस्तेमाल किए जा सकने वाले फ़ील्ड:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (ISO 8601 फ़ॉर्मैट में इनपुट करें या YYYY-MM-DDTHH:MM:SSZ)

उदाहरण:

  • विज्ञापन देने वाले व्यक्ति या कंपनी के सभी ENTITY_STATUS_ACTIVE या ENTITY_STATUS_PAUSED कैंपेन: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • वे सभी कैंपेन जिनके अपडेट होने का समय 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 के काेड में दिखाना 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
campaigns[]

object (Campaign)

कैंपेन की सूची.

अगर यह सूची खाली होगी, तो यह नहीं होगी.
nextPageToken

string

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

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

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

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

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