Method: advertisers.adGroups.list

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

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

GET https://displayvideo.googleapis.com/v3/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 देखें.