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 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.
isCommentable

boolean

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

Methods

addEnrichment

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

batchAddMediaItems

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

batchRemoveMediaItems

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

create

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

get

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

list

 רשימה של כל האלבומים שנוצרו על ידי האפליקציה.

patch

 מעדכנים את האלבום שנוצר על ידי האפליקציה באמצעות id שצוין.