Method: customers.list

لیستی از customers درخواست شده را برمی گرداند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
pageSize

number

حداکثر تعداد customers برای بازگشت در پاسخ.

pageToken

string

یک نشانه صفحه‌بندی که از تماس قبلی با customers.list method برگردانده شده است که نشان می‌دهد این فهرست باید از کجا ادامه یابد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پاسخ برای customers.list .

نمایندگی JSON 
{
  "customers": [
    {
      object (Customer)
    }
  ],
  "nextPageToken": string
}
فیلدها
customers[]

object ( Customer )

list of customers که با درخواست مطابقت دارند.

nextPageToken

string

یک نشانه صفحه‌بندی که از تماس قبلی با customers.list method برگردانده شده است که نشان می‌دهد فهرست از کجا باید ادامه یابد. اگر فیلد مفقود یا خالی باشد، به این معنی است که مشتری دیگری وجود ندارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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