Method: advertisers.lineItems.list

विज्ञापन देने वाले के लाइन आइटम की सूची बनाता है.

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

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

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

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

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

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

पैरामीटर
pageSize

integer

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

pageToken

string

नतीजों के उस पेज की पहचान करने वाला टोकन जिसे सर्वर को दिखाना चाहिए. आम तौर पर, यह lineItems.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
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (ISO 8601 फ़ॉर्मैट में इनपुट या YYYY-MM-DDTHH:MM:SSZ)

उदाहरण:

  • इंसर्शन ऑर्डर के तहत सभी लाइन आइटम: insertionOrderId="1234"
  • विज्ञापन देने वाले के सभी ENTITY_STATUS_ACTIVE या ENTITY_STATUS_PAUSED और LINE_ITEM_TYPE_DISPLAY_DEFAULT लाइन आइटम: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • ऐसे सभी लाइन आइटम जिनका अपडेट समय 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 के काेड में दिखाना
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
lineItems[]

object (LineItem)

लाइन आइटम की सूची.

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

nextPageToken

string

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

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

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

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

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