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

boolean

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

שיטות

addEnrichment

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

batchAddMediaItems

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

batchRemoveMediaItems

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

create

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

get

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

list

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

patch

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

share

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

unshare

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