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