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

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

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

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

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

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

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

object (AdGroup)

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

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

string

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

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

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

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

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