Method: advertisers.adGroups.list

विज्ञापन ग्रुप की सूची दिखाता है.

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

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/adGroups

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

ज़रूरी है. विज्ञापन देने वाले उस व्यक्ति या कंपनी का आईडी जिससे विज्ञापन ग्रुप जुड़े हैं.

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

डिफ़ॉल्ट रूप से, डेटा को बढ़ते क्रम में लगाया जाता है. किसी फ़ील्ड के लिए घटते क्रम को तय करने के लिए, फ़ील्ड के नाम में सफ़िक्स "desc" जोड़ना चाहिए. उदाहरण: displayName desc.
filter

string

ज़रूरी नहीं. यह नीति, विज्ञापन ग्रुप के कस्टम फ़ील्ड के हिसाब से फ़िल्टर करने की अनुमति देती है.

इस्तेमाल किया जा सकने वाला सिंटैक्स:

  • फ़िल्टर एक्सप्रेशन, एक या उससे ज़्यादा पाबंदियों से बने होते हैं.
  • पाबंदियों को AND और OR के हिसाब से जोड़ा जा सकता है. पाबंदियों का क्रम, साफ़ तौर पर AND का इस्तेमाल करता है.
  • पाबंदी का फ़ॉर्मैट {field} {operator} {value} है.
  • सभी फ़ील्ड में EQUALS (=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.

इस्तेमाल की जा सकने वाली प्रॉपर्टी:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

उदाहरण:

  • लाइन आइटम के तहत आने वाले सभी विज्ञापन ग्रुप: lineItemId="1234"
  • विज्ञापन देने वाले व्यक्ति या कंपनी के सभी ENTITY_STATUS_ACTIVE या ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM विज्ञापन ग्रुप: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

इस फ़ील्ड में 500 से ज़्यादा वर्ण नहीं होने चाहिए.

ज़्यादा जानकारी के लिए, LIST अनुरोधों को फ़िल्टर करना गाइड देखें.

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

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

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
adGroups[]

object (AdGroup)

विज्ञापन ग्रुप की सूची.

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

string

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

अनुमति पाने के लिंक

नीचे दिए गए OAuth अनुमति की ज़रूरत हाेती है:

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

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