Method: advertisers.insertionOrders.list

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

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

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

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/insertionOrders

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

ज़रूरी है. विज्ञापन देने वाले व्यक्ति या कंपनी का आईडी, जिसके लिए इंसर्शन ऑर्डर की सूची बनानी है.

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

पैरामीटर
pageSize

integer

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

string

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

string

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

  • "displayName" (डिफ़ॉल्ट)
  • "entityStatus"
  • "updateTime"

डिफ़ॉल्ट रूप से, डेटा को बढ़ते क्रम में क्रम से लगाया जाता है. किसी फ़ील्ड के लिए, डेटा को घटते क्रम में लगाने के लिए, फ़ील्ड के नाम में "desc" सफ़िक्स जोड़ें. उदाहरण: 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)

उदाहरण:

  • किसी कैंपेन में मौजूद सभी इंसर्शन ऑर्डर: campaignId="1234"
  • विज्ञापन देने वाले के तहत, सभी 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 अनुरोधों को फ़िल्टर करने से जुड़ी हमारी गाइड देखें.

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

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

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

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

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

object (InsertionOrder)

इंसर्शन ऑर्डर की सूची.

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

string

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

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

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

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

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