Method: albums.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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
  • https://www.googleapis.com/auth/photoslibrary.readonly.originals