Method: sharedAlbums.list

يسرد هذا الإجراء جميع الألبومات المشترَكة المتوفّرة في علامة التبويب "المشاركة" في تطبيق "صور Google" الخاص بالمستخدم.

طلب HTTP

GET https://photoslibrary.googleapis.com/v1/sharedAlbums

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

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

المعلمات
pageSize

integer

الحد الأقصى لعدد الألبومات التي يمكن عرضها في الردّ قد يتم عرض عدد ألبومات أقل من العدد المحدّد. القيمة التلقائية pageSize هي 20، والحد الأقصى هو 50.
pageToken

string

رمز استمرارية للحصول على الصفحة التالية من النتائج تؤدي إضافة هذه القاعدة إلى الطلب إلى عرض الصفوف بعد pageToken. يجب أن تكون السمة pageToken هي القيمة التي تعرضها المَعلمة nextPageToken في الردّ على طلب listSharedAlbums.
excludeNonAppCreatedData

boolean

في حال ضبط هذا الخيار، تستبعد النتائج عناصر الوسائط التي لم ينشئها هذا التطبيق. الإعداد التلقائي هو خطأ (يتم عرض كل الألبومات). يتم تجاهل هذا الحقل في حال استخدام النطاق photoslibrary.readonly.appcreateddata.

نص الطلب

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

نص الاستجابة

قائمة الألبومات المشترَكة المطلوبة

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

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

object (Album)

النتائج فقط. قائمة الألبومات المشترَكة
nextPageToken

string

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

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/photoslibrary
  • https://www.googleapis.com/auth/photoslibrary.readonly
  • https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata