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

batchRemoveMediaItems

create

get

list

patch

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

share

unshare