Method: sharedAlbums.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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