REST Resource: albums

資源：Album

相片中的 Google 相簿。相簿是媒體項目的容器。如果應用程式已分享相簿，其中就會包含額外的 shareInfo 屬性。

JSON 表示法 
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
欄位
id

string

專輯的 ID。這是一組永久 ID，可在各工作階段之間用來識別這張專輯。
title

string

使用者在 Google 相簿帳戶中看到的相簿名稱。此字串不得超過 500 個字元。
productUrl

string

[僅限輸出] 相簿的 Google 相簿網址。使用者必須先登入自己的 Google 相簿帳戶，才能存取這個連結。
isWriteable

boolean

[僅限輸出] 如果您可以在這本相簿中建立媒體項目，則為 True。這個欄位是根據授予相簿的範圍和權限所建立。如果範圍有所變更或相簿權限有所變更，這個欄位也會隨之更新。
shareInfo

object (ShareInfo)

[僅限輸出] 共享相簿的相關資訊。只有當相簿是共享相簿、開發人員建立相簿，且使用者已授予 photoslibrary.sharing 範圍時，系統才會填入這個欄位。
mediaItemsCount

string (int64 format)

[僅限輸出] 相簿中的媒體項目數量。
coverPhotoBaseUrl

string

[僅限輸出] 封面相片的位元組網址。這個值不應依原樣使用。使用參數前，必須先為這個網址附加參數。如需支援參數的完整清單，請參閱開發人員說明文件。舉例來說，'=w2048-h1024' 會將封面相片的尺寸設為 2048 px，高度為 1024 px。
coverPhotoMediaItemId

string

與封面相片相關的媒體項目 ID。

ShareInfo

共享相簿的相關資訊。系統只會在您建立相簿時分享這些資訊，而且您擁有分享範圍。

JSON 表示法 
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
欄位
sharedAlbumOptions

object (SharedAlbumOptions)

控管使用者能否在共享相簿中新增媒體項目或在共享相簿中留言的選項。
shareableUrl

string

共享 Google 相簿的連結。知道連結的使用者都可以查看相簿的內容，因此請謹慎處理。

只有在相簿連結共用設定已開啟的情況下，系統才會傳回 shareableUrl 參數。如果使用者已加入未透過連結分享的相簿，可以改用相簿的 productUrl 存取相簿。

如果擁有者關閉 Google 相簿應用程式中的連結共享設定，或是相簿已取消分享，shareableUrl 就會失效。
shareToken

string

憑證，用於代表非擁有者使用者加入、離開或擷取共享相簿的詳細資料。

如果擁有者關閉 Google 相簿應用程式中的連結共享設定，或是相簿已取消分享，shareToken 就會失效。
isJoined

boolean

如果使用者已加入相簿，則為「true」。相簿擁有者永遠是如此。
isOwned

boolean

如果使用者擁有相簿，則為 True。
isJoinable

boolean

如果相簿使用者可以加入，則為「true」。

SharedAlbumOptions

控管相簿共享方式的選項。

JSON 表示法 
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
欄位
isCollaborative

boolean

如果共享相簿允許協作者 (已加入相簿的使用者) 在當中新增媒體項目，則為「是」。預設值為 false。
isCommentable

boolean

如果共享相簿允許協作者 (已加入相簿的使用者) 在相簿上留言，則為「是」。預設值為 false。

方法

addEnrichment

 在定義相簿的指定位置加入充實內容。

batchAddMediaItems

 將使用者的 Google 相簿相片庫的一或多個媒體項目加入相簿。

batchRemoveMediaItems

 從指定相簿移除一或多個媒體項目。

create

 在使用者的 Google 相簿相片庫中建立相簿。

get

 根據指定的 albumId 傳回相簿。

list

 列出 Google 相簿應用程式「相簿」分頁向使用者顯示的所有相簿。

patch

 使用指定的 id 更新相簿。

share

 將相簿標示為已共享且可供其他使用者存取。

unshare

 將先前共享的相簿標示為私人相簿。