REST Resource: albums

Referensi: Album

Representasi album di Google Foto. Album adalah penampung untuk item media. Jika album telah dibagikan oleh aplikasi, album tersebut akan berisi properti shareInfo tambahan.

Representasi JSON
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
Kolom
id

string

ID untuk album. Ini adalah pengenal tetap yang dapat digunakan di antara sesi untuk mengidentifikasi album ini.

title

string

Nama album yang ditampilkan kepada pengguna di akun Google Foto mereka. String ini tidak boleh lebih dari 500 karakter.

productUrl

string

[Hanya output] URL Google Foto untuk album. Pengguna harus login ke akun Google Foto mereka untuk mengakses link ini.

isWriteable

boolean

[Output only] Benar jika Anda dapat membuat item media di album ini. Kolom ini didasarkan pada cakupan yang diberikan dan izin album. Jika cakupan diubah atau izin album diubah, kolom ini akan diperbarui.

shareInfo

object (ShareInfo)

[Khusus output] Informasi terkait album bersama. Kolom ini hanya diisi jika album merupakan album bersama, developer membuat album tersebut, dan pengguna telah memberikan cakupan photoslibrary.sharing.

mediaItemsCount

string (int64 format)

[Hanya output] Jumlah item media dalam album.

coverPhotoBaseUrl

string

[Khusus output] URL ke byte foto sampul. Hal ini tidak boleh digunakan sebagaimana adanya. Parameter harus ditambahkan ke URL ini sebelum digunakan. Lihat dokumentasi developer untuk mengetahui daftar lengkap parameter yang didukung. Misalnya, '=w2048-h1024' menetapkan dimensi foto sampul agar memiliki lebar 2.048 piksel dan tinggi 1.024 piksel.

coverPhotoMediaItemId

string

ID untuk item media yang terkait dengan foto sampul.

ShareInfo

Informasi tentang album yang dibagikan. Informasi ini hanya disertakan jika Anda yang membuat album, dibagikan, dan Anda memiliki cakupan berbagi.

Representasi JSON
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
Kolom
sharedAlbumOptions

object (SharedAlbumOptions)

Opsi yang mengontrol apakah seseorang dapat menambahkan item media ke, atau mengomentari album bersama.

shareableUrl

string

Link ke album Google Foto bersama. Siapa pun yang memiliki link dapat melihat konten album, jadi link tersebut harus diperlakukan dengan hati-hati.

Parameter shareableUrl hanya ditampilkan jika berbagi link album diaktifkan. Jika pengguna sudah bergabung ke album yang tidak dibagikan dengan link, mereka dapat menggunakan productUrl album untuk mengaksesnya.

shareableUrl menjadi tidak valid jika pemilik menonaktifkan berbagi link di aplikasi Google Foto, atau jika album dibatalkan pembagiannya.

shareToken

string

Token yang digunakan untuk bergabung, keluar, atau mengambil detail album bersama atas nama pengguna yang bukan pemiliknya.

shareToken menjadi tidak valid jika pemilik menonaktifkan berbagi link di aplikasi Google Foto, atau jika album dibatalkan pembagiannya.

isJoined

boolean

True jika pengguna bergabung ke album. Hal ini selalu berlaku untuk pemilik album.

isOwned

boolean

True jika pengguna memiliki album.

isJoinable

boolean

True jika album dapat digabungkan oleh pengguna.

SharedAlbumOptions

Opsi yang mengontrol berbagi album.

Representasi JSON
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
Kolom
isCollaborative

boolean

Benar jika album bersama memungkinkan kolaborator (pengguna yang telah bergabung dengan album) untuk menambahkan item media ke album tersebut. Nilai defaultnya adalah false (salah).

isCommentable

boolean

Benar jika album bersama mengizinkan kolaborator (pengguna yang telah bergabung ke album) untuk menambahkan komentar ke album. Nilai defaultnya adalah false (salah).

Metode

addEnrichment

Menambahkan pengayaan di posisi tertentu dalam album yang ditentukan.

batchAddMediaItems

Menambahkan satu atau beberapa item media di galeri Google Foto pengguna ke album.

batchRemoveMediaItems

Menghapus satu atau beberapa item media dari album tertentu.

create

Membuat album di galeri Google Foto pengguna.

get

Menampilkan album berdasarkan albumId yang ditentukan.

list

Mencantumkan semua album yang ditampilkan kepada pengguna di tab Album aplikasi Google Foto.

patch

Perbarui album dengan id yang ditentukan.

share

Menandai album sebagai dibagikan dan dapat diakses oleh pengguna lain.

unshare

Menandai album yang dibagikan sebelumnya sebagai pribadi.