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 です。
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 です。

メソッド

addEnrichment

 アプリで作成したアルバムの指定した位置にエンリッチメントを追加します。

batchAddMediaItems

 アプリで作成された 1 つ以上のメディア アイテムを、ユーザーの Google フォト ライブラリ内のアプリで作成されたアルバムに追加します。

batchRemoveMediaItems

 アプリで作成されたアルバムから、アプリで作成された 1 つ以上のメディア アイテムを削除します。

create

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

get

 指定された albumId に基づいて、アプリが作成したアルバムを返します。

list

 アプリが作成したすべてのアルバムを一覧表示します。

patch

 指定された id を使用して、アプリが作成したアルバムを更新します。