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