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

[فقط خروجی] اگر بتوانید موارد رسانه ای را در این آلبوم ایجاد کنید درست است. این فیلد بر اساس محدوده های اعطا شده و مجوزهای آلبوم است. اگر محدوده ها تغییر کند یا مجوزهای آلبوم تغییر کند، این قسمت به روز می شود.

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 آلبوم برای دسترسی به آن استفاده کند.

اگر مالک اشتراک‌گذاری پیوند را در برنامه Google Photos غیرفعال کند، یا اگر آلبوم به اشتراک گذاشته نشود shareableUrl باطل می‌شود.

shareToken

string

رمزی که برای پیوستن، خروج یا بازیابی جزئیات یک آلبوم مشترک از طرف کاربری که مالک نیست استفاده می‌شود.

اگر مالک اشتراک‌گذاری پیوند را در برنامه Google Photos غیرفعال کند، یا اگر آلبوم به اشتراک گذاشته نشود، shareToken باطل می‌شود.

isJoined

boolean

درست است اگر کاربر به آلبوم ملحق شده باشد. این همیشه برای صاحب آلبوم صادق است.

isOwned

boolean

درست است اگر کاربر مالک آلبوم باشد.

isJoinable

boolean

درست است اگر کاربران بتوانند به آلبوم ملحق شوند.

SharedAlbumOptions

گزینه‌هایی که اشتراک‌گذاری آلبوم را کنترل می‌کنند.

نمایندگی JSON
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
زمینه های
isCollaborative

boolean

درست است اگر آلبوم مشترک به همکاران (کاربرانی که به آلبوم ملحق شده اند) اجازه دهد موارد رسانه را به آن اضافه کنند. پیش فرض به نادرست.

isCommentable

boolean

درست است اگر آلبوم مشترک به همکاران (کاربرانی که به آلبوم ملحق شده اند) اجازه دهد نظراتی را به آلبوم اضافه کنند. پیش فرض به نادرست.

مواد و روش ها

addEnrichment

 غنی سازی را در یک موقعیت مشخص در یک آلبوم تعریف شده اضافه می کند.

batchAddMediaItems

 یک یا چند مورد رسانه ای را در کتابخانه Google Photos کاربر به یک آلبوم اضافه می کند.

batchRemoveMediaItems

 یک یا چند مورد رسانه را از یک آلبوم مشخص حذف می کند.

create

 آلبومی را در کتابخانه Google Photos کاربر ایجاد می کند.

get

 آلبوم را بر اساس شناسه albumId مشخص شده برمی گرداند.

list

 همه آلبوم‌هایی را که در برگه آلبوم‌های برنامه Google Photos به کاربر نشان داده می‌شود فهرست می‌کند.

patch

 آلبوم را با id مشخص شده به روز کنید.

share

 آلبومی را به‌عنوان اشتراک‌گذاری شده و قابل دسترسی برای سایر کاربران علامت‌گذاری می‌کند.

unshare

 آلبومی که قبلاً به اشتراک گذاشته شده است را به عنوان خصوصی علامت گذاری می کند.