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

アルバムの識別子。セッション間でこのアルバムを識別するために使用できる永続的な識別子です。
title

string

ユーザーの Google フォト アカウントでユーザーに表示されるアルバムの名前。この文字列は 500 文字以下にする必要があります。
productUrl

string

[出力専用] アルバムの Google フォトの URL。ユーザーがこのリンクにアクセスするには、Google フォトのアカウントにログインする必要があります。
isWriteable

boolean

[出力のみ] このアルバム内にメディア アイテムを作成できる場合は true。このフィールドは、付与されるスコープとアルバムの権限に基づきます。スコープが変更されたり、アルバムの権限が変更されたりすると、このフィールドが更新されます。
shareInfo

object (ShareInfo)

[出力専用] 共有アルバムに関する情報。このフィールドが入力されるのは、アルバムが共有アルバムであり、デベロッパーがアルバムを作成し、ユーザーが photoslibrary.sharing スコープを付与している場合のみです。
mediaItemsCount

string (int64 format)

[出力専用] アルバム内のメディア アイテムの数。
coverPhotoBaseUrl

string

[出力専用] カバー写真のバイトへの URL。これをそのまま使用しないでください。使用する前に、この URL にパラメータを追加する必要があります。サポートされているパラメータの一覧については、デベロッパー向けドキュメントをご覧ください。たとえば、'=w2048-h1024' と指定すると、カバー写真のサイズは、幅 2,048 ピクセル、高さ 1,024 ピクセルに設定されます。
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。これは、アルバムの所有者は常に true です。
isOwned

boolean

ユーザーがアルバムを所有している場合は true。
isJoinable

boolean

ユーザーがアルバムに参加できる場合は true。

SharedAlbumOptions

アルバムの共有を管理するオプション。

JSON 表現 
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
フィールド
isCollaborative

boolean

共有アルバムで共同編集者（アルバムに参加しているユーザー）にメディア アイテムの追加を許可する場合は true に設定します。デフォルトは false です。
isCommentable

boolean

共有アルバムで共同編集者（アルバムに参加しているユーザー）がアルバムにコメントを追加できるようにする場合は true に設定します。デフォルトは false です。

Methods

addEnrichment

 定義されたアルバムの指定された位置にエンリッチメントを追加します。

batchAddMediaItems

 ユーザーの Google フォト ライブラリ内のメディア アイテムをアルバムに追加します。

batchRemoveMediaItems

 指定したアルバムから 1 つ以上のメディア アイテムを削除します。

create

 ユーザーの Google フォト ライブラリにアルバムを作成します。

get

 指定した albumId に基づいてアルバムを返します。

list

 Google フォト アプリの [アルバム] タブでユーザーに表示されるすべてのアルバムを一覧表示します。

patch

 指定した id でアルバムを更新します。

share

 アルバムを共有としてマークし、他のユーザーがアクセスできるようにします。

unshare

 以前に共有したアルバムを非公開としてマークします。