Method: advertisers.creatives.list

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

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

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

GET https://displayvideo.googleapis.com/v2/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 (पहले चौड़ाई के हिसाब से, फिर ऊंचाई के हिसाब से क्रम में लगाएं)

क्रम से लगाने का डिफ़ॉल्ट क्रम बढ़ते क्रम में है. किसी फ़ील्ड के घटते क्रम में तय करने के लिए फ़ील्ड के नाम में "ब्यौरा" सफ़िक्स जोड़ना चाहिए. उदाहरण: 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")
  • 5 सेकंड और 200 मि.से. की कम से कम अवधि वाले AdX या AppNexus से मंज़ूर सभी डाइनैमिक क्रिएटिव: 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 के अनुरोध वाली हमारी गाइड देखें.

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

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

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

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

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

object (Creative)

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

अगर कोई सूची खाली होगी, तो यह नहीं दिखेगी.
nextPageToken

string

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

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

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

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

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