Method: sharedAlbums.list

רשימה של כל האלבומים המשותפים שזמינים בכרטיסייה 'שיתוף' באפליקציית Google Photos של המשתמש.

בקשת HTTP

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

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

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

פרמטרים
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
  • https://www.googleapis.com/auth/photoslibrary.readonly.originals