Method: sharedAlbums.list

همه آلبوم‌های به اشتراک‌گذاشته‌شده موجود در برگه اشتراک‌گذاری برنامه Google Photos کاربر را فهرست می‌کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
pageSize

integer

حداکثر تعداد آلبوم برای بازگشت در پاسخ. ممکن است تعداد کمتری آلبوم از تعداد مشخص شده بازگردانده شود. pageSize پیش فرض 20 و حداکثر 50 است.

pageToken

string

یک نشانه ادامه برای دریافت صفحه بعدی نتایج. با افزودن این به درخواست، ردیف‌های بعد از pageToken برمی‌گردد. pageToken باید مقداری باشد که در پارامتر nextPageToken در پاسخ به درخواست listSharedAlbums برگردانده شده است.

excludeNonAppCreatedData

boolean

اگر تنظیم شود، نتایج شامل موارد رسانه‌ای نمی‌شوند که توسط این برنامه ایجاد نشده‌اند. پیش فرض ها به false (همه آلبوم ها برگردانده می شوند). اگر از محدوده 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