Method: customers.list

מחזירה רשימה של customers המבוקשים.

בקשת HTTP

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

כתובת ה-URL כוללת תחביר gRPC קידוד מחדש.

פרמטרים של שאילתה

פרמטרים
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