Method: advertisers.creatives.list

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

ज़रूरी है. विज्ञापन देने वाले का वह आईडी जिसके लिए क्रिएटिव को सूची में शामिल करना है.

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

पैरामीटर
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • creativeId (डिफ़ॉल्ट)
  • createTime
  • mediaDuration
  • dimensions (पहले चौड़ाई के अनुसार, फिर ऊंचाई के अनुसार क्रम से लगाता है)

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

filter

string

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

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

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

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

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions ({width}x{height} के रूप में इनपुट)
  • dynamic
  • entityStatus
  • exchangeReviewStatus ({exchange}-{reviewStatus} के रूप में इनपुट)
  • lineItemIds
  • maxDuration ({duration}s के रूप में इनपुट करें. सिर्फ़ सेकंड के लिए इस्तेमाल किया जा सकता है)
  • minDuration ({duration}s के रूप में इनपुट करें. सिर्फ़ सेकंड के लिए इस्तेमाल किया जा सकता है)
  • updateTime (ISO 8601 फ़ॉर्मैट में इनपुट करें या YYYY-MM-DDTHH:MM:SSZ)

ध्यान दें:

  • updateTime के लिए, क्रिएटिव संसाधन के फ़ील्ड की वैल्यू से पता चलता है कि क्रिएटिव को पिछली बार कब अपडेट किया गया था.इसमें सिस्टम से किए गए अपडेट भी शामिल होते हैं. जैसे, क्रिएटिव की समीक्षा से जुड़े अपडेट.

उदाहरण:

  • सभी नेटिव क्रिएटिव: creativeType="CREATIVE_TYPE_NATIVE"
  • 300x400 या 50x100 डाइमेंशन वाले सभी चालू क्रिएटिव: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • ऐसे सभी डाइनैमिक क्रिएटिव जिन्हें AdX या AppNexus से मंज़ूरी मिली है. इनकी कम से कम अवधि 5 सेकंड और 200 मि॰से॰ होनी चाहिए: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • लाइन आइटम आईडी 1 या 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) से जुड़े सभी वीडियो क्रिएटिव
  • एक से ज़्यादा क्रिएटिव आईडी के आधार पर क्रिएटिव ढूंढें: creativeId=1 OR creativeId=2
  • वे सभी क्रिएटिव जिनके अपडेट होने का समय, 2020-11-04T18:54:47Z (ISO 8601 के फ़ॉर्मैट) से ज़्यादा या इसके बराबर है: updateTime>="2020-11-04T18:54:47Z"

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

ज़्यादा जानकारी के लिए, हमारी फ़िल्टर LIST के अनुरोध गाइड देखें.

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

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

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

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

JSON के काेड में दिखाना
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
creatives[]

object (Creative)

क्रिएटिव की सूची.

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

nextPageToken

string

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

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

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

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

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