Method: mediaItems.list

Zwraca listę elementów multimediów z źródeł multimediów skonfigurowanych przez użytkownika na określonym urządzeniu.

Domyślnie listMediaItems wyświetla tryb Ambient, zwracając wyselekcjonowany zestaw multimediów ze wszystkich źródeł skonfigurowanych przez użytkownika.

Opcjonalnie możesz dodać mediaSourceId w żądaniu, aby pobrać ponumerowane listy elementów z konkretnego źródła multimediów, co umożliwia bardziej tradycyjne filtrowanie.

Aplikacje klienckie są ograniczone do 240 żądań na urządzenie dziennie.

Jeśli użytkownik nie skonfigurował żadnych źródeł multimediów, wystąpi błąd FAILED_PRECONDITION.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
deviceId

string

Wymagane. Unikalny identyfikator tego urządzenia.

mediaSourceId

string

Opcjonalnie. W przypadku dźwięku otoczenia pomiń to pole. Zwróci to wybrany zbiór multimediów ze wszystkich skonfigurowanych źródeł. Liczba zwracanych produktów będzie zgodna z Twoją prośbą pageSize, do maksymalnie 100 produktów. Jeśli jest określony, zwracane są tylko elementy z wybranego źródła multimediów.

id musi pochodzić ze źródła wybranego przez użytkownika dla określonego urządzenia (czyli z jednego z tych AmbientDevice.media_sources.id).

Uwaga: usługa highlights nie jest obsługiwana, nawet jeśli użytkownik wybrał ją jako źródło na tym urządzeniu. Ustawienie tego pola na highlights spowoduje błąd INVALID_ARGUMENT.

pageSize

integer

Opcjonalnie. Maksymalna liczba elementów multimedialnych do zwrócenia.

Usługa uwzględni Twoje pageSize zapytanie, ale może zwrócić mniej elementów niż określono (w tym zero wyników).

Jeśli parametr pageSize nie jest określony lub ma wartość 0, zwróci się maksymalnie 50 multimediów. Wartości większe niż 100 zostaną sprowadzone do maksymalnej dozwolonej wartości 100. Podanie wartości ujemnej spowoduje błąd INVALID_ARGUMENT.

pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania funkcji mediaItems.list. Podaj ten parametr, aby pobrać kolejną stronę.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na metodę mediaItems.list.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
Pola
mediaItems[]

object (AmbientMediaItem)

strona z elementami multimediów do wyświetlania na wygaszaczu z powiadomieniami na urządzeniu.

nextPageToken

string

Jeśli to pole jest ustawione, może ono służyć jako pageToken w kolejnych wywołaniach mediaItems.list, aby pobrać kolejną stronę elementów.

Pominięcie tego pola niekoniecznie oznacza, że nie ma już więcej treści do pobrania, ale że następna strona treści może zawierać elementy multimedialne, które zostały już zwrócone na poprzednich stronach.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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