Method: advertisers.campaigns.list

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

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

उस विज्ञापन देने वाले का आईडी जिसके लिए कैंपेन लिस्ट करना है.

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

पैरामीटर
pageSize

integer

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

string

एक टोकन, जो सर्वर को दिखाए जाने वाले नतीजों के पेज की पहचान करता है. आम तौर पर, यह nextPageToken की वैल्यू है. यह वैल्यू, campaigns.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 (=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.

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

  • 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 अनुरोध गाइड देखें.

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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 की खास जानकारी देखें.