מוצג לך תיעוד של הגרסה הקודמת של Google Photos Library API.
REST Resource: albums
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משאב: אלבום
ייצוג של אלבום ב-Google Photos. אלבומים הם קונטיינרים לפריטי מדיה. אם האפליקציה שיתפה אלבום, הוא מכיל מאפיין shareInfo נוסף.
| ייצוג ב-JSON |
{
"id": string,
"title": string,
"productUrl": string,
"isWriteable": boolean,
"shareInfo": {
object (ShareInfo)
},
"mediaItemsCount": string,
"coverPhotoBaseUrl": string,
"coverPhotoMediaItemId": string
} |
| שדות |
id |
string
המזהה של האלבום. זהו מזהה קבוע שאפשר להשתמש בו בין סשנים כדי לזהות את האלבום הזה.
|
title |
string
שם האלבום שמוצג למשתמש בחשבון Google Photos שלו. המחרוזת הזו לא יכולה להיות באורך של יותר מ-500 תווים.
|
productUrl |
string
[פלט בלבד] כתובת ה-URL של האלבום ב-Google Photos. כדי לגשת לקישור, המשתמש צריך להיכנס לחשבון Google Photos שלו.
|
isWriteable |
boolean
[פלט בלבד] הערך True מופיע אם אפשר ליצור פריטים של מדיה באלבום הזה. השדה הזה מבוסס על ההיקפים וההרשאות שהוקצו לאלבום. אם היקפי ההרשאות של האלבום משתנים או אם ההרשאות של האלבום משתנות, השדה הזה מתעדכן.
|
shareInfo |
object (ShareInfo)
[פלט בלבד] מידע שקשור לאלבומים משותפים. השדה הזה מאוכלס רק אם האלבום הוא אלבום משותף, המפתח יצר את האלבום והמשתמש העניק את ההיקף photoslibrary.sharing.
|
mediaItemsCount |
string (int64 format)
[פלט בלבד] מספר קובצי המדיה באלבום.
|
coverPhotoBaseUrl |
string
[פלט בלבד] כתובת URL לבייטים של תמונת השער. אסור להשתמש בו כמו שהוא. צריך לצרף את הפרמטרים לכתובת ה-URL הזו לפני השימוש. רשימה מלאה של הפרמטרים הנתמכים מופיעה במסמכי התיעוד למפתחים. לדוגמה, '=w2048-h1024' מגדיר את המידות של תמונת השער לרוחב 2,048 פיקסלים ולגובה של 1,024 פיקסלים.
|
coverPhotoMediaItemId |
string
מזהה של פריט המדיה שמשויך לתמונת השער.
|
ShareInfo
מידע על האלבומים המשותפים. אפשר לכלול את המידע הזה רק אם אתם יצרתם את האלבום, אם הוא משותף ויש לכם הרשאות שיתוף.
| ייצוג ב-JSON |
{
"sharedAlbumOptions": {
object (SharedAlbumOptions)
},
"shareableUrl": string,
"shareToken": string,
"isJoined": boolean,
"isOwned": boolean,
"isJoinable": boolean
} |
| שדות |
sharedAlbumOptions |
object (SharedAlbumOptions)
אפשרויות שקובעים אם אנשים יוכלו להוסיף תמונות לאלבום משותף או להגיב עליו.
|
shareableUrl |
string
קישור לאלבום המשותף ב-Google Photos. כל מי שמקבל את הקישור יכול לראות את תוכן האלבום, לכן צריך להתייחס אליו בזהירות. הפרמטר shareableUrl מוחזר רק אם שיתוף באמצעות קישור מופעל באלבום. אם משתמש מסוים כבר הצטרף לאלבום שלא שותף באמצעות קישור, הוא יכול להשתמש בproductUrl של האלבום כדי להיכנס אליו. shareableUrl לא תקף אם הבעלים השבית את השיתוף באמצעות קישור באפליקציית Google Photos או אם השיתוף של האלבום בוטל.
|
shareToken |
string
אסימון שמשמש כדי להצטרף לאלבום משותף, לעזוב אותו או לאחזר את הפרטים שלו מטעם משתמש שאינו הבעלים. shareToken לא תקף אם הבעלים השבית את השיתוף באמצעות קישור באפליקציית Google Photos או אם השיתוף של האלבום בוטל.
|
isJoined |
boolean
הערך True אם המשתמש הצטרף לאלבום. הבעלים של האלבום תמיד יכולים לעשות זאת.
|
isOwned |
boolean
הערך יהיה TRUE אם האלבום בבעלות המשתמש.
|
isJoinable |
boolean
הערך הוא True אם משתמשים יכולים להצטרף לאלבום.
|
SharedAlbumOptions
אפשרויות השיתוף של אלבום.
| ייצוג ב-JSON |
{
"isCollaborative": boolean,
"isCommentable": boolean
} |
| שדות |
isCollaborative |
boolean
הערך הוא True אם האלבום המשותף מאפשר לשותפי עריכה (משתמשים שהצטרפו לאלבום) להוסיף אליו פריטי מדיה. ברירת המחדל היא false.
|
שיטות |
|
|
הוספת העשרה במיקום מוגדר באלבום מוגדר. |
|
|
הוספת פריט מדיה אחד או יותר בספרייה של המשתמש ב-Google Photos לאלבום. |
|
|
הסרת פריט מדיה אחד או יותר מאלבום מסוים. |
|
|
יצירת אלבום בספריית Google Photos של משתמש. |
|
|
הפונקציה מחזירה את האלבום על סמך הערך שצוין בשדה albumId. |
|
|
רשימה של כל האלבומים שמוצגים למשתמש בכרטיסייה 'אלבומים' באפליקציית Google Photos. |
|
|
מעדכנים את האלבום עם id שצוין. |
|
|
סימון אלבום כמשותף וזמין למשתמשים אחרים. |
|
|
סימון אלבום ששיתפתם בעבר כפרטי. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eThe Album resource represents albums in Google Photos, acting as containers for media items and including share information for shared albums.\u003c/p\u003e\n"],["\u003cp\u003eAlbums have properties like ID, title, product URL, writeability, share details, media item count, and cover photo information.\u003c/p\u003e\n"],["\u003cp\u003eShared albums have options to control collaboration (adding media) and commenting, along with shareable URLs and tokens for access.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use various methods to manage albums, including creating, getting, listing, updating, adding/removing media, sharing, and unsharing.\u003c/p\u003e\n"],["\u003cp\u003eShareInfo and SharedAlbumOptions objects provide further details about shared album configurations and access control.\u003c/p\u003e\n"]]],["This document outlines the structure and functionality of Google Photos albums. An album resource contains metadata like `id`, `title`, `productUrl`, and whether it's writeable. Shared albums have a `shareInfo` object with details like `shareableUrl`, `shareToken`, and join status. Shared album options manage collaboration (`isCollaborative`) and commenting (`isCommentable`). Various methods exist for album management, including creating, retrieving, updating, sharing, adding/removing media items, and enriching albums.\n"],null,[]]
