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

אסימון העימוד שיועבר לקריאה הבאה של identities.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

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