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' מגדיר את המידות של תמונת השער כך שיהיו ברוחב של 2048 פיקסלים ובגובה של 1024 פיקסלים.
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', או אם האלבום לא משותף.
shareToken

string

אסימון שמשמש להצטרפות, לעזיבה או לשחזור של הפרטים של אלבום משותף מטעם משתמש שאינו הבעלים.

shareToken לא תקף אם הבעלים השבית את השיתוף באמצעות קישור באפליקציית 'תמונות Google', או אם האלבום לא משותף.
isJoined

boolean

True אם המשתמש מצורף לאלבום. זה נכון תמיד לגבי הבעלים של האלבום.
isOwned

boolean

True אם האלבום הוא הבעלים של האלבום.
isJoinable

boolean

True אם משתמשים יכולים להצטרף לאלבום.

SharedAlbumOptions

האפשרויות שקובעות את השיתוף של אלבום.

ייצוג JSON 
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
שדות
isCollaborative

boolean

True אם האלבום המשותף מאפשר לשותפי עריכה (משתמשים שהצטרפו לאלבום) להוסיף אליו פריטי מדיה. ברירת המחדל היא FALSE.
isCommentable

boolean

הערך הוא True אם באלבום המשותף מאפשרים לשותפי עריכה (משתמשים שהצטרפו לאלבום) להוסיף תגובות לאלבום. ברירת המחדל היא FALSE.

שיטות

addEnrichment

 הוספת העשרה במיקום ספציפי באלבום מוגדר.

batchAddMediaItems

 הוספה של פריט מדיה אחד או יותר מספריית Google Photos של המשתמש לאלבום.

batchRemoveMediaItems

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

create

 יוצר אלבום בספריית Google Photos של המשתמש.

get

 מחזירה את האלבום על סמך albumId שצוין.

list

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

patch

 עדכון האלבום עם id שצוין.

share

 סימון אלבום כמשותף ונגיש למשתמשים אחרים.

unshare

 סימון אלבום ששותף בעבר כפרטי.