Method: partners.list

उन पार्टनर की सूची बनाता है जिन्हें मौजूदा उपयोगकर्ता ऐक्सेस कर सकता है.

क्रम, orderBy पैरामीटर से तय होता है.

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

GET https://displayvideo.googleapis.com/v3/partners

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

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

पैरामीटर
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName

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

filter

string

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

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

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

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

  • entityStatus

उदाहरण:

  • सभी चालू पार्टनर: entityStatus="ENTITY_STATUS_ACTIVE"

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

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

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

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

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

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

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

object (Partner)

पार्टनर की सूची.

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

nextPageToken

string

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

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

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

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

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