Method: partners.channels.sites.list

चैनल में साइटों की सूची बनाता है.

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

GET https://displayvideo.googleapis.com/v1beta2/partners/{partnerId}/channels/{channelId}/sites

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

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

पैरामीटर
channelId

string (int64 format)

ज़रूरी है. उस पैरंट चैनल का आईडी जिससे अनुरोध की गई साइटें जुड़ी हैं.

partnerId

string (int64 format)

उस पार्टनर का आईडी जिसके पास पैरंट चैनल का मालिकाना हक है.

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

पैरामीटर
pageSize

integer

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

pageToken

string

एक टोकन, जो सर्वर को दिखाए जाने वाले नतीजों के पेज की पहचान करता है.

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

orderBy

string

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

  • urlOrAppId (डिफ़ॉल्ट)

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

filter

string

साइट फ़ील्ड के हिसाब से फ़िल्टर करने की अनुमति देता है.

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

  • साइट के लिए फ़िल्टर एक्सप्रेशन में फ़िलहाल सिर्फ़ एक एक्सप्रेशन हो सकता है
  • पाबंदी.
  • पाबंदी {field} {operator} {value} के रूप में होती है.
  • ऑपरेटर CONTAINS (:) होना चाहिए.
  • इस्तेमाल किए जा सकने वाले फ़ील्ड:
    • urlOrAppId

उदाहरण:

  • वे सभी साइटें जिनके यूआरएल या ऐप्लिकेशन आईडी में "google" शामिल है: urlOrAppId : "google"
advertiserId

string (int64 format)

उस विज्ञापन देने वाले का आईडी जिसके पास पैरंट चैनल का मालिकाना हक है.

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

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

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में ListSitesResponse का एक इंस्टेंस शामिल किया जाता है.

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

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

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

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