Method: users.settings.cse.identities.list

רשימה של הזהויות שהוצפנו מצד הלקוח של משתמש מאומת.

בקשת HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities

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

פרמטרים של נתיב

פרמטרים
userId

string

כתובת האימייל הראשית של מגיש הבקשה. כדי לציין את המשתמש המאומת, אפשר להשתמש בערך המיוחד me.

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

פרמטרים
pageToken

string

אסימון העימוד שמציין איזה דף זהויות צריך להחזיר. אם האסימון לא מסופק, ה-API יחזיר את דף התוצאות הראשון.

pageSize

integer

מספר הזהויות שצריך להחזיר. אם לא תספקו כתובת, גודל הדף יוגדר כברירת מחדל ל-20 רשומות.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
שדות
cseIdentities[]

object (CseIdentity)

דף אחד ברשימת הזהויות של ה-CSE שהוגדרו למשתמש.

nextPageToken

string

אסימון העימוד שיועבר לקריאה הבאה של Identity.list כדי לאחזר את דף הזהויות הבא. אם הערך הזה לא מוחזר או שהוא מחרוזת ריקה, לא נשארים דפים נוספים.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

מידע נוסף זמין במדריך להרשאות.