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

नतीजों के उस पेज की पहचान करने वाला टोकन जिसे सर्वर को दिखाना चाहिए. आम तौर पर, यह creatives.list वाले तरीके के पिछले कॉल से मिली nextPageToken की वैल्यू होती है. अगर कोई वैल्यू नहीं दी जाती है, तो नतीजों का पहला पेज दिखेगा.
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 (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 की खास जानकारी देखें.