REST Resource: albums

Ресурс: Альбом

Представление альбома в Google Фото. Альбомы — это контейнеры для элементов мультимедиа. Если приложение предоставило общий доступ к альбому, оно содержит дополнительное свойство 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 Фото, чтобы получить доступ к этой ссылке.

isWriteable

boolean

[Только вывод] True, если в этом альбоме можно создавать медиафайлы. Это поле основано на предоставленных областях и разрешениях альбома. При изменении областей действия или прав доступа к альбому это поле обновляется.

shareInfo

object ( ShareInfo )

[Только вывод] Информация об общих альбомах. Это поле заполняется только в том случае, если альбом является общим альбомом, разработчик создал альбом и пользователь предоставил область photoslibrary.sharing .

mediaItemsCount

string ( int64 format)

[Только вывод] Количество медиафайлов в альбоме.

coverPhotoBaseUrl

string

[Только вывод] URL-адрес байтов обложки. Это не должно использоваться как есть. Параметры должны быть добавлены к этому URL-адресу перед использованием. Полный список поддерживаемых параметров см. в документации для разработчиков. Например, '=w2048-h1024' задает размеры обложки: ширину 2048 пикселей и высоту 1024 пикселей.

coverPhotoMediaItemId

string

Идентификатор элемента мультимедиа, связанного с обложкой.

Поделиться информацией

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

Представление 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

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

isOwned

boolean

Истинно, если пользователь владеет альбомом.

isJoinable

boolean

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

SharedAlbumOptions

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

Представление 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

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