Method: customers.list

इससे customers की सूची मिलती है.

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

GET https://sasportal.googleapis.com/v1alpha1/customers

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

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

पैरामीटर
pageSize

number

जवाब में वापस जाने की ज़्यादा से ज़्यादा संख्या customers.

pageToken

string

किसी पिछले कॉल से, customers.list method पर नंबर डालने वाला टोकन दिखाया गया. इससे पता चलता है कि इस लिस्टिंग को कहां से जारी रखना चाहिए.

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

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

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

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

customers.list के लिए जवाब.

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

object (Customer)

अनुरोध से मेल खाने वाला list of customers.

nextPageToken

string

पेजों को क्रम में लगाने का टोकन, पिछले कॉल से customers.list method पर ले जाया गया. इससे पता चलता है कि लिस्टिंग कहां से शुरू होनी चाहिए. अगर फ़ील्ड मौजूद नहीं है या खाली है, तो इसका मतलब है कि सूची में कोई और ग्राहक नहीं है.

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

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

  • https://www.googleapis.com/auth/userinfo.email