Method: albums.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
pageSize

integer

מספר האלבומים המקסימלי שיוחזרו בתגובה. ייתכן שיוחזרו פחות אלבומים מהמספר שצוין. ערך ברירת המחדל של pageSize הוא 20, המקסימום הוא 50.
pageToken

string

אסימון המשך לקבלת הדף הבא של התוצאות. הוספה של ערך זה לבקשה תחזיר את השורות אחרי pageToken. pageToken צריך להיות הערך שהוחזר בפרמטר nextPageToken בתגובה לבקשה של listAlbums.
excludeNonAppCreatedData

boolean

אם המדיניות מוגדרת, התוצאות לא יכללו פריטי מדיה שלא נוצרו על ידי האפליקציה הזו. ערך ברירת המחדל הוא False (כל האלבומים מוחזרים). המערכת מתעלמת מהשדה הזה אם נעשה שימוש בהיקף photoslibrary.readonly.appcreateddata.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

רשימת האלבומים שהוגשה בקשה.

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "albums": [
    {
      object (Album)
    }
  ],
  "nextPageToken": string
}
שדות
albums[]

object (Album)

פלט בלבד. רשימת האלבומים שמוצגת בכרטיסייה 'אלבומים' באפליקציית Google Photos של המשתמש.
nextPageToken

string

פלט בלבד. אסימון שבו אפשר להשתמש כדי לקבל את קבוצת האלבומים הבאה. השדה הזה יאוכלס אם יש עוד אלבומים שאפשר לאחזר בהתאם לבקשה הזו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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