Method: advertisers.creatives.list

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

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

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

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 से मंज़ूरी पा चुके सभी डाइनैमिक क्रिएटिव, जिनकी अवधि कम से कम पांच सेकंड और 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 (आईएसओ 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 Overview देखें.