Method: brands.agents.list

किसी ब्रैंड से जुड़े सभी एजेंट की सूची बनाता है.

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

GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents

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

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

पैरामीटर
parent

string

ज़रूरी है. ब्रैंड का यूनीक आइडेंटिफ़ायर. अगर ब्रैंड आइडेंटिफ़ायर "1234" है, तो यह पैरामीटर "brands/1234" हो जाता है. आरबीएम कैरियर के सभी एजेंट दिखाने के लिए, ब्रैंड आइडेंटिफ़ायर "-" होना चाहिए.

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

पैरामीटर
pageSize

integer

तय करें कि सर्वर से ज़्यादा से ज़्यादा कितने नतीजे दिखाए जाएं. सर्वर किसी एक पेज में लौटाए जाने वाले ज़्यादा से ज़्यादा नतीजों को सीमित कर सकता है. अगर pageSize 0 है, तो सर्वर लौटाए जाने वाले नतीजों की संख्या तय करेगा.
pageToken

string

अगर कोई पिछले 'सूची अनुरोध' से NextPageToken मिला है, तो उसकी वैल्यू.

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

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

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

एजेंट की सूची.

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

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

object (Agent)

एजेंट की जानकारी की सूची.
nextPageToken

string

नतीजों का अगला पेज पाने के लिए पेज पर नंबर डालने वाला टोकन. अगर वैल्यू "" है, तो इसका मतलब है कि अनुरोध के लिए कोई और नतीजा नहीं मिला.