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。これは、アルバムのオーナーには常に適用されます。
isOwned

boolean

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

boolean

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

SharedAlbumOptions

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

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

boolean

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

boolean

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

メソッド

addEnrichment

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

batchAddMediaItems

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

batchRemoveMediaItems

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

create

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

get

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

list

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

patch

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

share

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

unshare

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