כאן רשומים כל האלבומים המשותפים שזמינים בכרטיסייה 'שיתוף' באפליקציית Google Photos של המשתמש.
בקשת HTTP
GET https://photoslibrary.googleapis.com/v1/sharedAlbums
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
מספר האלבומים המקסימלי שיוחזרו בתגובה. ייתכן שיוחזרו פחות אלבומים מהמספר שצוין. ערך ברירת המחדל של |
pageToken |
אסימון המשך לקבלת הדף הבא של התוצאות. הוספה של ערך זה לבקשה תחזיר את השורות אחרי |
excludeNonAppCreatedData |
אם המדיניות מוגדרת, התוצאות לא יכללו פריטי מדיה שלא נוצרו על ידי האפליקציה הזו. ערך ברירת המחדל הוא False (כל האלבומים מוחזרים). המערכת מתעלמת מהשדה הזה אם נעשה שימוש בהיקף photoslibrary.readonly.appcreateddata. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
נשלחה בקשה לרשימת האלבומים המשותפים.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"sharedAlbums": [
{
object ( |
שדות | |
---|---|
sharedAlbums[] |
פלט בלבד. רשימת האלבומים המשותפים. |
nextPageToken |
פלט בלבד. אסימון לשימוש לקבלת הקבוצה הבאה של אלבומים משותפים. השדה הזה יאוכלס אם יש עוד אלבומים משותפים שאפשר לאחזר בשביל הבקשה הזו. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/photoslibrary
https://www.googleapis.com/auth/photoslibrary.readonly
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata