Method: advertisers.youtubeAdGroupAds.list

यह डायलॉग बॉक्स YouTube विज्ञापन ग्रुप के विज्ञापनों की सूची बनाता है.

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

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

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

पाथ पैरामीटर

पैरामीटर
advertiserId

string (int64 format)

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

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

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

string

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

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

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

इस्तेमाल किए जा सकने वाले फ़ील्ड:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

उदाहरण:

  • किसी विज्ञापन ग्रुप के सभी विज्ञापन ग्रुप के विज्ञापन: adGroupId="1234"
  • किसी विज्ञापन ग्रुप के तहत आने वाले सभी विज्ञापन ग्रुप के विज्ञापन, जिनकी इकाई ENTITY_STATUS_ACTIVE या ENTITY_STATUS_PAUSED है: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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

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

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

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

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

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

JSON के काेड में दिखाना 
{
  "youtubeAdGroupAds": [
    {
      object (YoutubeAdGroupAd)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
youtubeAdGroupAds[]

object (YoutubeAdGroupAd)

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

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

string

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

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

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

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

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