REST Resource: albums

Tài nguyên: Đĩa nhạc

Hình ảnh đại diện cho 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 ứng dụng đã chia sẻ một album, thì album đó sẽ chứa thêm một thuộc tính shareInfo.

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 cho album. Đây là giá trị nhận dạng ổn định có thể được dùng giữa các phiên để xác định album này.
title

string

Tên của album hiển thị cho người dùng 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ỉ xuất] 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ỉ có giá trị đầu ra] Đúng 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 các phạm vi được cấp và quyền của album. Nếu phạm vi hoặc quyền của album thay đổi, trường này sẽ được cập nhật.
shareInfo

object (ShareInfo)

[Chỉ có đầu ra] Thông tin liên quan đến album chia sẻ. Trường này chỉ được điền nếu album là 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ỉ có giá trị đầu ra] Số lượng mục nội dung nghe nhìn trong đĩa nhạc.
coverPhotoBaseUrl

string

[Chỉ có kết quả] URL đến các byte của ảnh bìa. Bạn không nên sử dụng URL này nguyên trạng. Bạn phải thêm các tham số 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 tham số được hỗ trợ. Ví dụ: '=w2048-h1024' đặt kích thước của ảnh bìa có chiều rộng là 2048 px và chiều cao là 1024 px.
coverPhotoMediaItemId

string

Giá trị nhận dạng của mục nội dung nghe nhìn được 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 người khác có thể thêm mục nội dung nghe nhìn vào hoặc bình luận về một album chia sẻ hay không.
shareableUrl

string

Đường liên kết đến album được 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 cần phải cẩn thận khi chia sẻ đường liên kết.

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ẻ bằng đường liên kết, người dùng có thể sử dụng productUrl của album đó để truy cập vào album.

shareableUrl sẽ mất hiệu lực 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 bị huỷ chia sẻ.
shareToken

string

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

shareToken sẽ mất hiệu lực 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 bị huỷ chia sẻ.
isJoined

boolean

Đúng nếu người dùng đã tham gia album. Điều này luôn đúng đối 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 (những người dùng đã tham gia album) thêm các mục nội dung nghe nhìn vào album đó. Giá trị mặc định là sai.
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 bình luận vào album. Giá trị mặc định là sai.

Phương thức

addEnrichment

 Thêm nội dung làm phong phú ở một vị trí đã chỉ định trong album do ứng dụng tạo.

batchAddMediaItems

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

batchRemoveMediaItems

 Xoá một hoặc nhiều mục nội dung nghe nhìn do ứng dụng tạo khỏi một album do ứng dụng tạo được chỉ định.

create

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

get

 Trả về album do ứng dụng tạo dựa trên albumId đã chỉ định.

list

 Liệt kê tất cả album do ứng dụng của bạn tạo.

patch

 Cập nhật album do ứng dụng tạo bằng id đã chỉ định.