Method: users.settings.cse.identities.list

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

אדמינים שמנהלים זהויות וצמדי מפתחות של משתמשים בארגון שלהם צריכים לאשר בקשות באמצעות חשבון שירות שיש לו הרשאת הענקת הרשאות גישה ברמת הדומיין להתחזות למשתמשים עם היקף ההרשאות https://www.googleapis.com/auth/gmail.settings.basic.

משתמשים שמנהלים את הזהויות ואת זוגות המפתחות שלהם צריכים להפעיל ולהגדיר הצפנה של מפתחות פיזיים כדי לשלוח בקשות.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
userId

string

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

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

פרמטרים
pageToken

string

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

integer

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

גוף הבקשה

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

גוף התשובה

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

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

object (CseIdentity)

דף אחד ברשימת הזהויות של חיפוש מותאם אישית שהוגדרו למשתמש.
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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.