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

影集的标识符。这是一个永久标识符，可用于在会话之间标识此影集。
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

与封面照片相关联的媒体内容的标识符。

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。对于影集的所有者而言，这种情况始终为 true。
isOwned

boolean

如果用户是影集的所有者，则为 true。
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

 列出 Google 相册应用的“影集”标签页中向用户显示的所有影集。

patch

 使用指定的 id 更新影集。

share

 将影集标记为共享影集，以供其他用户访问。

unshare

 将先前的共享影集标记为不公开。