REST Resource: albums

資源：相簿

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 像素和 1024 像素。
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

如果使用者已加入相簿，則值為「是」。相簿擁有者一律可使用這項功能。
isOwned

boolean

如果使用者擁有相簿，則傳回「是」。
isJoinable

boolean

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

SharedAlbumOptions

用於控制相簿共用設定的選項。

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

boolean

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

boolean

如果共享相簿允許協作者 (已加入相簿的使用者) 在相簿中新增留言，則為 true。預設值為 false。

方法

addEnrichment

 在應用程式建立的相簿中，在指定位置新增強化內容。

batchAddMediaItems

 將使用者 Google 相簿程式庫中由應用程式建立的一或多個媒體項目，新增至由應用程式建立的相簿。

batchRemoveMediaItems

 從指定的應用程式建立的相簿中移除一或多個應用程式建立的媒體項目。

create

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

get

 傳回應用程式根據指定 albumId 建立的相簿。

list

 列出應用程式建立的所有相簿。

patch

 使用指定的 id 更新應用程式建立的相簿。