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 Фото. Эта строка не должна содержать более 500 символов.

productUrl

string

[Только вывод] URL-адрес альбома в Google Фото. Чтобы получить доступ к этой ссылке, пользователю необходимо войти в свою учетную запись 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 Фото. Посмотреть содержимое альбома может любой, у кого есть ссылка, поэтому к нему следует относиться осторожно.

shareableUrl возвращается только в том случае, если для альбома включен общий доступ по ссылке. Если пользователь уже присоединился к альбому, к которому нет общего доступа по ссылке, вместо этого он может использовать productUrl альбома для доступа к нему.

shareableUrl становится недействительным, если владелец отключает общий доступ по ссылке в приложении Google Фото или если доступ к альбому закрыт.

shareToken

string

Токен, который используется для присоединения, выхода из общего альбома или получения сведений об общем альбоме от имени пользователя, не являющегося владельцем.

shareToken становится недействительным, если владелец отключает общий доступ по ссылке в приложении Google Фото или если доступ к альбому закрыт.

isJoined

boolean

True, если пользователь присоединился к альбому. Это всегда справедливо для владельца альбома.

isOwned

boolean

True, если альбом принадлежит пользователю.

isJoinable

boolean

True, если к альбому могут присоединиться пользователи.

Общие параметры альбома

Параметры, управляющие общим доступом к альбому.

JSON-представление
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
Поля
isCollaborative

boolean

Значение true, если общий альбом позволяет соавторам (пользователям, присоединившимся к альбому) добавлять в него элементы мультимедиа. По умолчанию ложь.

isCommentable

boolean

Значение true, если общий альбом позволяет соавторам (пользователям, присоединившимся к альбому) добавлять комментарии к альбому. По умолчанию ложь.

Методы

addEnrichment

 Добавляет дополнение в указанную позицию в определенном альбоме.

batchAddMediaItems

 Добавляет в альбом один или несколько мультимедийных элементов из библиотеки Google Фото пользователя.

batchRemoveMediaItems

 Удаляет один или несколько элементов мультимедиа из указанного альбома.

create

 Создает альбом в библиотеке Google Фото пользователя.

get

 Возвращает альбом на основе указанного albumId .

list

 Список всех альбомов, отображаемых пользователю на вкладке «Альбомы» приложения Google Фото.

patch

 Обновите альбом с указанным id .

share

 Отмечает альбом как общий и доступный для других пользователей.

unshare

 Отмечает альбом, которым ранее поделились, как личный.