Method: users.settings.cse.identities.list

يتم عرض الهويات المشفّرة من جهة العميل لمستخدم تمت مصادقته.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المعلّمات
userId

string

عنوان البريد الإلكتروني الرئيسي لمقدِّم الطلب للإشارة إلى المستخدم الذي تمت المصادقة عليه، يمكنك استخدام القيمة الخاصة me.

معامِلات طلب البحث

المعلّمات
pageToken

string

رمز مميّز للتقسيم على صفحات يشير إلى صفحة الهويات التي يمكن عرضها إذا لم يتم توفير الرمز المميز، ستعرض واجهة برمجة التطبيقات الصفحة الأولى من النتائج.

pageSize

integer

عدد الهويات المراد عرضها. في حال عدم توفير هذه السياسة، سيتم ضبط الحجم التلقائي للصفحة على 20 إدخالًا.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
الحقول
cseIdentities[]

object (CseIdentity)

صفحة واحدة من قائمة هويات ميزة CSE التي تم ضبطها للمستخدم

nextPageToken

string

الرمز المميّز المقسّم على صفحات سيتم تمريره إلى طلب identity التالي ضمن قائمة الهويات، وذلك لاسترداد صفحة الهويات التالية. وإذا لم يتم عرض هذه القيمة أو كانت السلسلة فارغة، لن يتم الاحتفاظ بأي صفحات أخرى.

نطاقات الأذونات

يتطلب ذلك أحد نطاقات 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

لمزيد من المعلومات، اطّلِع على دليل التفويض.