Method: mediaPlanners.list

इस फ़ंक्शन से, उन सभी मीडिया प्लानर खातों की सूची मिलती है जिन्हें कॉल करने वाला व्यक्ति ऐक्सेस कर सकता है.

क्यूरेटर के लिए, यह उन सभी मीडिया प्लानर को दिखाएगा जिन्होंने क्यूरेटर की शर्तें स्वीकार की हैं.

अन्य खातों के लिए, मीडिया प्लानर को सूची में शामिल करने की कोशिश करने पर गड़बड़ी का मैसेज दिखेगा.

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

GET https://curationpartners.googleapis.com/v1/mediaPlanners

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

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

पैरामीटर
pageSize

integer

ज़्यादा से ज़्यादा कितने मीडिया प्लानर के नाम लौटाने हैं. अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 100 मीडिया प्लानर दिखाए जाएंगे. इसकी ज़्यादा से ज़्यादा वैल्यू 500 हो सकती है. 500 से ज़्यादा वैल्यू को 500 में बदल दिया जाएगा.
pageToken

string

ज़रूरी नहीं. यह एक टोकन है. इससे नतीजों के उस पेज की पहचान होती है जिसे सर्वर को दिखाना चाहिए. यह वैल्यू, ListMediaPlannersResponse.nextPageToken में mediaPlanners.list के पिछले कॉल से मिलती है.
filter

string

Cloud API की सूची में शामिल फ़िल्टर करने के सिंटैक्स का इस्तेमाल करके, क्वेरी स्ट्रिंग को जोड़ा जा सकता है. फ़िल्टर करने के लिए, इन कॉलम का इस्तेमाल किया जा सकता है:

  • name
  • displayName
  • ancestorNames

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

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

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

ऐसा जवाब जिसमें मीडिया प्लानर खाते की जानकारी शामिल हो.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "mediaPlanners": [
    {
      object (MediaPlanner)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
mediaPlanners[]

object (MediaPlanner)

मीडिया प्लानर की सूची.
nextPageToken

string

यह एक टोकन है. इसे mediaPlanners.list तरीके को किए जाने वाले अगले कॉल में पास किया जा सकता है, ताकि ListMediaPlannersRequest.page_token में नतीजों का अगला पेज वापस पाया जा सके.

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

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

  • https://www.googleapis.com/auth/curation-partners

MediaPlanner

यह मीडिया प्लानर खाते को दिखाता है.

JSON के काेड में दिखाना 
{
  "accountId": string,
  "name": string,
  "displayName": string,
  "ancestorNames": [
    string
  ]
}
फ़ील्ड
accountId
(deprecated)

string

सिर्फ़ आउटपुट के लिए. मीडिया प्लानर का खाता आईडी.
name

string

आइडेंटिफ़ायर. मीडिया प्लानर का यूनीक रिसॉर्स नेम. फ़ॉर्मैट: mediaPlanners/{mediaPlannerAccountId}. इसका इस्तेमाल, mediaPlanners.list तरीके के जवाब को फ़िल्टर करने के लिए किया जा सकता है.
displayName

string

सिर्फ़ आउटपुट के लिए. मीडिया प्लानर का डिसप्ले नेम. इसका इस्तेमाल, [mediaPlanners.list][google.ads.authorizedbuyers.marketplace.v1main.MediaPlanners.ListMediaPlanners] तरीके के जवाब को फ़िल्टर करने के लिए किया जा सकता है.
ancestorNames[]

string

सिर्फ़ आउटपुट के लिए. मीडिया प्लानर के पूर्वजों के नाम. फ़ॉर्मैट: mediaPlanners/{mediaPlannerAccountId}. इसका इस्तेमाल, mediaPlanners.list तरीके के जवाब को फ़िल्टर करने के लिए किया जा सकता है.