REST Resource: albums

Ressource: Album

Darstellung eines Albums in Google Fotos. Alben sind Container für Medienelemente. Wenn ein Album von der Anwendung geteilt wurde, enthält es eine zusätzliche shareInfo-Eigenschaft.

JSON-Darstellung
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
Felder
id

string

ID für das Album. Dies ist eine dauerhafte ID, die zwischen Sitzungen verwendet werden kann, um dieses Album zu identifizieren.

title

string

Name des Albums, das der Nutzer in seinem Google Fotos-Konto sieht. Dieser String darf maximal 500 Zeichen lang sein.

productUrl

string

[Nur Ausgabe] Google Fotos-URL für das Album. Der Nutzer muss in seinem Google Fotos-Konto angemeldet sein, um auf diesen Link zugreifen zu können.

isWriteable

boolean

[Nur Ausgabe] "True", wenn Sie in diesem Album Medienelemente erstellen können. Dieses Feld basiert auf den gewährten Bereichen und Berechtigungen des Albums. Dieses Feld wird aktualisiert, wenn Bereiche oder Berechtigungen für das Album geändert werden.

shareInfo

object (ShareInfo)

[Nur Ausgabe] Informationen zu geteilten Alben. Dieses Feld wird nur ausgefüllt, wenn das Album ein geteiltes Album ist, der Entwickler das Album erstellt hat und der Nutzer den Bereich photoslibrary.sharing gewährt hat.

mediaItemsCount

string (int64 format)

[Nur Ausgabe] Die Anzahl der Medienelemente im Album.

coverPhotoBaseUrl

string

[Nur Ausgabe] Eine URL zu den Bytes des Titelbilds. Sollte nicht in der vorliegenden Form verwendet werden. Parameter müssen vor der Verwendung an diese URL angehängt werden. Eine vollständige Liste der unterstützten Parameter finden Sie in der Entwicklerdokumentation. Mit '=w2048-h1024' werden beispielsweise die Abmessungen des Titelbilds auf eine Breite von 2.048 Pixel und eine Höhe von 1.024 Pixel festgelegt.

coverPhotoMediaItemId

string

ID des Medienelements, das dem Titelbild zugeordnet ist.

ShareInfo

Informationen zu geteilten Alben. Diese Informationen werden nur angegeben, wenn Sie das Album erstellt haben, es freigegeben ist und Sie den Freigabebereich haben.

JSON-Darstellung
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
Felder
sharedAlbumOptions

object (SharedAlbumOptions)

Optionen, mit denen gesteuert wird, ob jemand Medieninhalte zu geteilten Alben hinzufügen oder kommentieren darf.

shareableUrl

string

Einen Link zum geteilten Google Fotos-Album. Jeder, der über den Link verfügt, kann auf den Inhalt des Albums zugreifen. Daher sollten Sie mit dem Inhalt vorsichtig umgehen.

Der Parameter shareableUrl wird nur zurückgegeben, wenn für das Album die Linkfreigabe aktiviert ist. Wenn ein Nutzer bereits einem Album ohne Linkfreigabe beigetreten ist, kann er stattdessen das productUrl des Albums verwenden, um darauf zuzugreifen.

shareableUrl wird ungültig, wenn der Inhaber die Linkfreigabe in der Google Fotos App deaktiviert oder wenn das Album nicht mehr geteilt wird.

shareToken

string

Ein Token, mit dem Sie einem geteilten Album beitreten, es verlassen oder die Details eines geteilten Albums im Namen eines Nutzers abrufen können, der nicht der Eigentümer ist.

shareToken wird ungültig, wenn der Inhaber die Linkfreigabe in der Google Fotos App deaktiviert oder wenn das Album nicht mehr geteilt wird.

isJoined

boolean

„True“, wenn der Nutzer zum Album gehört. Das ist immer für den Eigentümer des Albums der Fall.

isOwned

boolean

"True", wenn das Album dem Nutzer gehört.

isJoinable

boolean

Dieser Wert ist "True", wenn Nutzer dem Album beitreten können.

SharedAlbumOptions

Optionen, die das Teilen eines Albums steuern.

JSON-Darstellung
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
Felder
isCollaborative

boolean

"True", wenn das geteilte Album Mitbearbeitern (Nutzern, die dem Album beigetreten sind) erlauben, ihm Medienelemente hinzuzufügen. Die Standardeinstellung ist "false".

isCommentable

boolean

"True", wenn das geteilte Album Mitbearbeitern (Nutzern, die dem Album beigetreten sind) erlauben, dem Album Kommentare hinzuzufügen. Die Standardeinstellung ist "false".

Methoden

addEnrichment

Fügt eine Anreicherung an einer bestimmten Position in einem definierten Album hinzu.

batchAddMediaItems

Fügt ein oder mehrere Medienelemente aus der Google Fotos-Galerie eines Nutzers einem Album hinzu.

batchRemoveMediaItems

Entfernt ein oder mehrere Medienelemente aus einem bestimmten Album.

create

Erstellt ein Album in der Google Fotos-Galerie eines Nutzers.

get

Gibt das Album basierend auf dem angegebenen albumId zurück.

list

Listet alle Alben auf, die einem Nutzer in der Google Fotos App auf dem Tab „Alben“ angezeigt werden.

patch

Aktualisiert das Album mit der angegebenen id.

share

Markiert ein Album als freigegeben und für andere Nutzer zugänglich.

unshare

Markiert ein zuvor geteiltes Album als privat.