Method: mediaItems.list

Retorna uma lista de itens de mídia ambiente de fontes de mídia configuradas pelo usuário para o dispositivo especificado.

Por padrão, o listMediaItems oferece a experiência do Ambient, retornando um conjunto selecionado de itens de mídia de todas as fontes configuradas pelo usuário.

Opcionalmente, é possível incluir mediaSourceId na solicitação para recuperar uma lista paginada de itens de uma fonte de mídia específica, permitindo uma filtragem mais tradicional.

Os aplicativos clientes são limitados a 240 solicitações por dispositivo por dia.

Um erro FAILED_PRECONDITION ocorre se o usuário não tiver configurado nenhuma fonte de mídia.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
deviceId

string

Obrigatório. O identificador exclusivo desse dispositivo.

mediaSourceId

string

Opcional. Para a experiência de ambiente, omita esse campo. Isso vai retornar um conjunto selecionado de itens de mídia de todas as origens configuradas. O número de itens retornados vai atender à sua solicitação pageSize, até um máximo de 100 itens. Se especificado, apenas os itens da fonte de mídia especificada serão retornados.

O id precisa ser de uma fonte selecionada pelo usuário para o dispositivo especificado (ou seja, uma das AmbientDevice.media_sources.id).

Não há suporte para highlights, mesmo que seja uma fonte selecionada para o dispositivo pelo usuário. Definir esse campo como highlights vai retornar um erro INVALID_ARGUMENT.

pageSize

integer

Opcional. O número máximo de itens de mídia a serem retornados.

O serviço vai honrar sua solicitação pageSize, mas pode retornar menos itens do que o especificado, incluindo zero resultados.

Se pageSize não for especificado ou for definido como 0, no máximo 50 itens de mídia serão retornados. Valores maiores que 100 serão convertidos para o valor máximo permitido de 100. Fornecer um valor negativo resultará em um erro INVALID_ARGUMENT.

pageToken

string

Opcional. Um token de página recebido de uma chamada mediaItems.list anterior. Forneça isso para recuperar a página subsequente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para o método mediaItems.list.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
Campos
mediaItems[]

object (AmbientMediaItem)

Uma página de itens de mídia ambiente para o dispositivo mostrar.

nextPageToken

string

Se definido, esse campo pode ser usado como pageToken em uma chamada mediaItems.list subsequente para recuperar a próxima página de itens.

Se esse campo for omitido, não significa necessariamente que não há mais conteúdo disponível para ser buscado, mas sim que a página de conteúdo subsequente pode conter itens de mídia que já foram retornados nas páginas anteriores.

Escopos de autorização

Requer o seguinte escopo OAuth:

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