REST Resource: albums

Ressource: Album

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

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

string

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

title

string

Der Name des Albums, der dem Nutzer in seinem Google Fotos-Konto angezeigt wird. 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] „Wahr“, wenn Sie in diesem Album Medienelemente erstellen können. Dieses Feld basiert auf den gewährten Bereichen und Berechtigungen des Albums. Wenn sich die Bereiche oder Berechtigungen des Albums ändern, wird dieses Feld aktualisiert.

shareInfo

object (ShareInfo)

[Nur Ausgabe] Informationen zu geteilten Alben. Dieses Feld wird nur ausgefüllt, wenn es sich um ein geteiltes Album handelt, der Entwickler das Album erstellt hat und der Nutzer den Zugriffsumfang 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. Diese URL sollte nicht unverändert verwendet werden. Vor der Verwendung sollten Parameter an sie 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 2.048 × 1.024 Pixel festgelegt.

coverPhotoMediaItemId

string

Die Kennung des Medienelements, das mit dem Titelbild verknüpft ist.

ShareInfo

Informationen zu geteilten Alben Diese Informationen werden nur angezeigt, wenn Sie das Album erstellt haben, es geteilt wird und Sie die entsprechenden Freigabeberechtigungen haben.

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

object (SharedAlbumOptions)

Optionen, mit denen festgelegt wird, ob andere Personen einem geteilten Album Medienelemente hinzufügen oder es kommentieren dürfen.

shareableUrl

string

Einen Link zum geteilten Google Fotos-Album. Jeder, der den Link hat, kann sich den Inhalt des Albums ansehen. Daher sollten Sie mit dem Link vorsichtig umgehen.

Der Parameter shareableUrl wird nur zurückgegeben, wenn für das Album die Linkfreigabe aktiviert ist. Wenn ein Nutzer bereits Mitglied eines Albums ist, das nicht per Link geteilt wurde, kann er stattdessen über die productUrl des Albums darauf zugreifen.

Ein shareableUrl wird ungültig, wenn der Inhaber die Linkfreigabe in der Google Fotos App deaktiviert oder die Freigabe des Albums aufgehoben 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.

Ein shareToken wird ungültig, wenn der Inhaber die Linkfreigabe in der Google Fotos App deaktiviert oder die Freigabe des Albums aufgehoben 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 der Nutzer der Inhaber des Albums ist.

isJoinable

boolean

„Wahr“, wenn Nutzer dem Album beitreten können.

SharedAlbumOptions

Optionen, mit denen die Freigabe eines Albums gesteuert wird.

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

boolean

„Wahr“, wenn Mitbearbeiter (Nutzer, die dem Album beigetreten sind) dem geteilten Album Medienelemente hinzufügen können. Die Standardeinstellung ist "false".

isCommentable

boolean

„Wahr“, wenn Mitbearbeiter (Nutzer, die dem Album beigetreten sind) dem geteilten Album Kommentare hinzufügen können. Die Standardeinstellung ist "false".

Methoden

addEnrichment

Fügen Sie einem in einer App erstellten Album an einer bestimmten Position eine Datenanreicherung hinzu.

batchAddMediaItems

Fügen Sie einem von einer App erstellten Album ein oder mehrere von einer App erstellte Medienelemente in der Google Fotos-Mediathek eines Nutzers hinzu.

batchRemoveMediaItems

Entfernt ein oder mehrere von der App erstellte Medienelemente aus einem bestimmten von der App erstellten Album.

create

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

get

Gibt das von der App erstellte Album basierend auf dem angegebenen albumId zurück.

list

Listet alle von Ihrer App erstellten Alben auf.

patch

Aktualisieren Sie das von der App erstellte Album mit der angegebenen id.