REST Resource: albums

Recurso: Álbum

Representación de un álbum en Google Fotos. Los álbumes son contenedores de elementos multimedia. Si la aplicación comparte un álbum, este contiene una propiedad shareInfo adicional.

Representación JSON
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
Campos
id

string

Es el identificador del álbum. Este es un identificador persistente que se puede utilizar entre sesiones para identificar este álbum.

title

string

El nombre del álbum que se muestra al usuario en su cuenta de Google Fotos. Esta cadena no debe superar los 500 caracteres.

productUrl

string

[Solo salida] URL de Google Fotos para el álbum. Para acceder a este vínculo, el usuario debe acceder a su cuenta de Google Fotos.

isWriteable

boolean

[Solo salida] Es verdadero si puedes crear elementos multimedia en este álbum. Este campo se basa en los alcances otorgados y los permisos del álbum. Si se cambian los permisos o los permisos del álbum, este campo se actualiza.

shareInfo

object (ShareInfo)

[Solo salida] Información relacionada con los álbumes compartidos. Este campo solo se completa si el álbum es un álbum compartido, si el desarrollador lo creó y el usuario otorgó el alcance photoslibrary.sharing.

mediaItemsCount

string (int64 format)

[Solo salida] Cantidad de elementos multimedia del álbum

coverPhotoBaseUrl

string

[Solo salida] Una URL a los bytes de la foto de portada. No se debe usar tal como está. Se deben agregar parámetros a esta URL antes de usarla. Consulta la documentación para desarrolladores para obtener una lista completa de los parámetros compatibles. Por ejemplo, '=w2048-h1024' establece las dimensiones de la foto de portada para que tengan un ancho de 2048 px y una altura de 1024 px.

coverPhotoMediaItemId

string

Es el identificador del elemento multimedia asociado con la foto de portada.

ShareInfo

Información sobre los álbumes compartidos. Esa información solo se incluye si creaste el álbum, se comparte y tienes permiso para compartir.

Representación JSON
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
Campos
sharedAlbumOptions

object (SharedAlbumOptions)

Opciones que controlan si alguien puede agregar elementos multimedia o comentar un álbum compartido.

shareableUrl

string

Un vínculo al álbum compartido de Google Fotos. Cualquier persona que tenga el vínculo puede ver el contenido del álbum, por lo que se debe tratar con cuidado.

El parámetro shareableUrl solo se muestra si el álbum tiene activado el uso compartido de vínculos. Si un usuario ya se unió a un álbum que no se compartió mediante un vínculo, puede usar el elemento productUrl del álbum para acceder a él.

Una shareableUrl se invalida si el propietario desactiva el uso compartido de vínculos en la app de Google Fotos o si el álbum se deja de compartir.

shareToken

string

Un token que se usa para unirse a un álbum compartido, abandonarlo o recuperarlo en nombre de un usuario que no es el propietario.

Una shareToken se invalida si el propietario desactiva el uso compartido de vínculos en la app de Google Fotos o si el álbum se deja de compartir.

isJoined

boolean

Es verdadero si el usuario se unió al álbum. Esto siempre se aplica al propietario del álbum.

isOwned

boolean

Es verdadero si el usuario es propietario del álbum.

isJoinable

boolean

Es verdadero si usuarios pueden unirse al álbum.

SharedAlbumOptions

Opciones que controlan el uso compartido de un álbum.

Representación JSON
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
Campos
isCollaborative

boolean

Es verdadero si el álbum compartido permite que los colaboradores (usuarios que se unieron al álbum) agreguen elementos multimedia. La configuración predeterminada es "false".

isCommentable

boolean

Es verdadero si el álbum compartido permite que los colaboradores (usuarios que se unieron al álbum) agreguen comentarios al álbum. La configuración predeterminada es "false".

Métodos

addEnrichment

Agrega un enriquecimiento en una posición determinada de un álbum definido.

batchAddMediaItems

Agrega uno o más elementos multimedia de la biblioteca de Google Fotos del usuario a un álbum.

batchRemoveMediaItems

Quita uno o más elementos multimedia de un álbum especificado.

create

Crea un álbum en la biblioteca de Google Fotos de un usuario.

get

Muestra el álbum en función de la albumId especificada.

list

Muestra una lista de todos los álbumes que se muestran a un usuario en la pestaña Álbumes de la app de Google Fotos.

patch

Actualiza el álbum con el id especificado.

share

Marca un álbum como compartido y accesible para otros usuarios.

unshare

Marca un álbum compartido anteriormente como privado.