Method: advertisers.youtubeAdGroups.list

यह YouTube विज्ञापन समूहों की सूची बनाता है.

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

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroups

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

पाथ के पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

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

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

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

string

YouTube के कस्टम विज्ञापन ग्रुप फ़ील्ड के हिसाब से फ़िल्टर करने की सुविधा देता है.

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

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

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

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

उदाहरण:

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

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

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

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

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

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

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

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

object (YoutubeAdGroup)

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

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

string

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

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

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

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

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