Method: mediaItems.list

Gibt eine Liste der Ambient-Medienelemente aus von Nutzern konfigurierten Medienquellen für das angegebene Gerät zurück.

Standardmäßig bietet listMediaItems den Bildschirmschoner, bei dem eine Auswahl an Medienelementen aus allen vom Nutzer konfigurierten Quellen zurückgegeben wird.

Optional kannst du mediaSourceId in die Anfrage aufnehmen, um eine paginaierte Liste von Elementen aus einer bestimmten Medienquelle abzurufen. So ist eine traditionellere Filterung möglich.

Clientanwendungen sind auf 240 Anfragen pro Gerät und Tag beschränkt.

Ein FAILED_PRECONDITION-Fehler tritt auf, wenn der Nutzer keine Medienquellen konfiguriert hat.

HTTP-Anfrage

GET https://photosambient.googleapis.com/v1/mediaItems

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
deviceId

string

Erforderlich. Die eindeutige Kennung für dieses Gerät.
mediaSourceId

string

Optional. Für den Bildschirmschoner lassen Sie dieses Feld leer. Dadurch wird eine Auswahl von Medienelementen aus allen konfigurierten Quellen zurückgegeben. Die Anzahl der zurückgegebenen Elemente entspricht deiner pageSize-Anfrage, bis zu maximal 100 Elemente. Wenn angegeben, werden nur Elemente aus der angegebenen Medienquelle zurückgegeben.

Die id muss von einer Quelle stammen, die der Nutzer für das angegebene Gerät ausgewählt hat (d.h. eine von AmbientDevice.media_sources.id).

Hinweis: highlights wird nicht unterstützt, auch wenn es vom Nutzer als Quelle für dieses Gerät ausgewählt wurde. Wenn Sie dieses Feld auf highlights festlegen, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageSize

integer

Optional. Die maximale Anzahl der Medienelemente, die zurückgegeben werden sollen.

Der Dienst führt Ihre pageSize-Anfrage aus, gibt aber möglicherweise weniger Elemente zurück als angegeben (einschließlich null Ergebnisse).

Wenn pageSize nicht angegeben oder auf 0 festgelegt ist, werden maximal 50 Medienelemente zurückgegeben. Werte über 100 werden auf den maximal zulässigen Wert von 100 herabgesetzt. Wenn Sie einen negativen Wert angeben, führt dies zu einem INVALID_ARGUMENT-Fehler.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen mediaItems.list-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort auf die mediaItems.list-Methode.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
Felder
mediaItems[]

object (AmbientMediaItem)

Eine Seite mit Bildschirmschonerelementen, die auf dem Gerät angezeigt werden sollen.
nextPageToken

string

Wenn dieses Feld festgelegt ist, kann es als pageToken in einem nachfolgenden mediaItems.list-Aufruf verwendet werden, um die nächste Seite mit Elementen abzurufen.

Wenn dieses Feld weggelassen wird, bedeutet das nicht unbedingt, dass keine weiteren Inhalte zum Abrufen verfügbar sind. Die nachfolgende Inhaltsseite kann auch Medienelemente enthalten, die bereits auf vorherigen Seiten zurückgegeben wurden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/photosambient.mediaitems