REST Resource: albums

Tài nguyên: Album

Hình ảnh minh hoạ một album trong Google Photos. Album là vùng chứa cho các mục nội dung nghe nhìn. Nếu một album đã được ứng dụng chia sẻ, album đó chứa một thuộc tính shareInfo bổ sung.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
Trường
id

string

Giá trị nhận dạng của album. Đây là giá trị nhận dạng cố định có thể dùng giữa các phiên để xác định album này.

title

string

Tên của album mà người dùng nhìn thấy trong tài khoản Google Photos của họ. Chuỗi này không được dài quá 500 ký tự.

productUrl

string

[Chỉ thiết bị ra] URL của album trên Google Photos. Người dùng cần đăng nhập vào tài khoản Google Photos để truy cập vào đường liên kết này.

isWriteable

boolean

[Chỉ thiết bị ra] True nếu bạn có thể tạo các mục nội dung nghe nhìn trong album này. Trường này dựa trên phạm vi đã cấp và quyền của album. Nếu phạm vi thay đổi hoặc các quyền của album thay đổi, thì trường này sẽ được cập nhật.

shareInfo

object (ShareInfo)

[Chỉ cho ra kết quả] Thông tin liên quan đến album chia sẻ. Trường này chỉ được điền sẵn nếu album là một album chia sẻ, nhà phát triển đã tạo album và người dùng đã cấp phạm vi photoslibrary.sharing.

mediaItemsCount

string (int64 format)

[Chỉ đầu ra] Số mục nội dung nghe nhìn trong album.

coverPhotoBaseUrl

string

[Chỉ đầu ra] URL đến các byte của ảnh bìa. Bạn không nên sử dụng thông số này theo nguyên trạng. Các tham số phải được thêm vào URL này trước khi sử dụng. Hãy xem tài liệu dành cho nhà phát triển để biết danh sách đầy đủ các thông số được hỗ trợ. Ví dụ: '=w2048-h1024' đặt kích thước của ảnh bìa là chiều rộng 2048 px và chiều cao là 1024 px.

coverPhotoMediaItemId

string

Giá trị nhận dạng cho mục nội dung đa phương tiện liên kết với ảnh bìa.

ShareInfo

Thông tin về những album được chia sẻ. Thông tin này chỉ được đưa vào nếu bạn đã tạo album, album được chia sẻ và bạn có phạm vi chia sẻ.

Biểu diễn dưới dạng JSON
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
Trường
sharedAlbumOptions

object (SharedAlbumOptions)

Các lựa chọn kiểm soát việc một người có thể thêm các mục nội dung nghe nhìn vào hoặc nhận xét về một album chia sẻ hay không.

shareableUrl

string

Đường liên kết đến album chia sẻ trên Google Photos. Bất kỳ ai có đường liên kết đều có thể xem nội dung của album. Vì vậy, bạn phải cẩn thận khi xem album.

Tham số shareableUrl chỉ được trả về nếu album đã bật tính năng chia sẻ đường liên kết. Nếu đã tham gia một album không được chia sẻ đường liên kết, thì người dùng có thể sử dụng productUrl của album đó để truy cập vào album đó.

shareableUrl sẽ không hợp lệ nếu chủ sở hữu tắt tính năng chia sẻ đường liên kết trong ứng dụng Google Photos hoặc nếu album không được chia sẻ.

shareToken

string

Mã thông báo được dùng để tham gia, rời khỏi hoặc truy xuất thông tin chi tiết của album chia sẻ thay mặt cho người dùng không phải là chủ sở hữu.

shareToken sẽ không hợp lệ nếu chủ sở hữu tắt tính năng chia sẻ đường liên kết trong ứng dụng Google Photos hoặc nếu album không được chia sẻ.

isJoined

boolean

Đúng nếu người dùng được tham gia vào album. Điều này luôn đúng với chủ sở hữu album.

isOwned

boolean

Đúng nếu người dùng sở hữu album.

isJoinable

boolean

Đúng nếu người dùng có thể tham gia album.

SharedAlbumOptions

Các tuỳ chọn kiểm soát việc chia sẻ album.

Biểu diễn dưới dạng JSON
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
Trường
isCollaborative

boolean

Đúng nếu album chia sẻ cho phép cộng tác viên (người dùng đã tham gia album) thêm mục nội dung nghe nhìn vào album đó. Giá trị mặc định là false.

isCommentable

boolean

Đúng nếu album chia sẻ cho phép cộng tác viên (những người dùng đã tham gia album) thêm nhận xét vào album. Giá trị mặc định là false.

Phương thức

addEnrichment

Thêm phần bổ sung ở một vị trí đã chỉ định trong album xác định.

batchAddMediaItems

Thêm một hoặc nhiều mục nội dung nghe nhìn trong thư viện Google Photos của người dùng vào một album.

batchRemoveMediaItems

Xoá một hoặc nhiều mục nội dung nghe nhìn khỏi album đã chỉ định.

create

Tạo một album trong thư viện Google Photos của người dùng.

get

Trả về album dựa trên albumId đã chỉ định.

list

Liệt kê tất cả album mà người dùng nhìn thấy trong thẻ Album của ứng dụng Google Photos.

patch

Cập nhật album bằng id đã chỉ định.

share

Đánh dấu một album là đã chia sẻ và những người dùng khác có thể truy cập vào album.

unshare

Đánh dấu album đã chia sẻ trước đó là riêng tư.