Method: mediaItems.list

Renvoie la liste des éléments multimédias ambiants à partir des sources multimédias configurées par l'utilisateur pour l'appareil spécifié.

Par défaut, listMediaItems fournit l'expérience Ambient, en renvoyant un ensemble sélectionné d'éléments multimédias à partir de toutes les sources configurées par l'utilisateur.

Vous pouvez également inclure mediaSourceId dans la requête pour récupérer une liste paginée d'éléments à partir d'une source multimédia spécifique, ce qui permet un filtrage plus traditionnel.

Les applications clientes sont limitées à 240 requêtes par appareil et par jour.

Une erreur FAILED_PRECONDITION se produit si l'utilisateur n'a configuré aucune source multimédia.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
deviceId

string

Obligatoire. Identifiant unique de cet appareil.

mediaSourceId

string

Facultatif. Pour l'expérience Ambient, omettez ce champ. Cette commande renvoie un ensemble d'éléments multimédias sélectionnés à partir de toutes les sources configurées. Le nombre d'éléments renvoyés respectera votre requête pageSize, dans la limite de 100 éléments. Si elle est spécifiée, seuls les éléments de la source multimédia spécifiée sont renvoyés.

id doit être une source sélectionnée par l'utilisateur pour l'appareil spécifié (c'est-à-dire l'un des AmbientDevice.media_sources.id).

Remarque : highlights n'est pas compatible, même si l'utilisateur a sélectionné cette source pour cet appareil. Si vous définissez ce champ sur highlights, une erreur INVALID_ARGUMENT est renvoyée.

pageSize

integer

Facultatif. Nombre maximal d'éléments multimédias à renvoyer.

Le service traitera votre requête pageSize, mais il est possible qu'il renvoie moins d'éléments que spécifié (y compris aucun résultat).

Si pageSize n'est pas spécifié ou est défini sur 0, 50 éléments multimédias au maximum sont renvoyés. Les valeurs supérieures à 100 sont réduites à la valeur maximale autorisée de 100. Si vous indiquez une valeur négative, une erreur INVALID_ARGUMENT sera générée.

pageToken

string

Facultatif. Jeton de page reçu d'un appel mediaItems.list précédent. Fournissez-le pour récupérer la page suivante.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse à la méthode mediaItems.list.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
Champs
mediaItems[]

object (AmbientMediaItem)

Page d'éléments multimédias ambiants à afficher sur l'appareil.

nextPageToken

string

Si ce champ est défini, il peut être utilisé comme pageToken dans un appel mediaItems.list ultérieur pour récupérer la page suivante d'éléments.

Si ce champ est omis, cela ne signifie pas nécessairement qu'aucun autre contenu ne peut être récupéré, mais plutôt que la page de contenu suivante peut contenir des éléments multimédias déjà renvoyés sur les pages précédentes.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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