Method: mediaItems.list

返回指定设备的用户配置媒体来源中的氛围媒体内容列表。

默认情况下,listMediaItems 会提供氛围模式体验,从所有用户配置的来源返回一组精选媒体内容。

您可以酌情在请求中添加 mediaSourceId,以从特定媒体来源检索分页的项列表,从而实现更传统的过滤。

客户端应用的限制为每部设备每天 240 次请求。

如果用户未配置任何媒体来源,则会发生 FAILED_PRECONDITION 错误。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
deviceId

string

必需。此设备的唯一标识符。

mediaSourceId

string

可选。对于氛围模式,请忽略此字段。这将返回从所有已配置来源精选的一组媒体内容。返回的项数将遵循您的 pageSize 请求,最多 100 项。如果指定,则仅返回指定媒体来源中的项。

id 必须是用户为指定设备选择的来源(即 AmbientDevice.media_sources.id 之一)。

请注意,即使用户为此设备选择了 highlights,系统也不支持 highlights。将此字段设置为 highlights 将返回 INVALID_ARGUMENT 错误。

pageSize

integer

可选。要返回的媒体内容数量上限。

该服务会遵循您的 pageSize 请求,但返回的项数量可能会少于指定的数量(包括零个结果)。

如果未指定 pageSize 或将其设为 0,则最多返回 50 个媒体内容。大于 100 的值将强制转换为允许的最大值 100。提供负值将导致 INVALID_ARGUMENT 错误。

pageToken

string

可选。从之前的 mediaItems.list 调用接收的页面令牌。利用其进行后续页面检索。

请求正文

请求正文必须为空。

响应正文

mediaItems.list 方法的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
字段
mediaItems[]

object (AmbientMediaItem)

用于在设备上显示的氛围媒体内容页面。

nextPageToken

string

如果设置了此字段,则可以在后续的 mediaItems.list 调用中将其用作 pageToken 来检索下一页内容。

如果省略此字段,并不一定表示没有可提取的其他内容,而是表示后续内容页面可能包含之前页面中已返回的媒体项。

授权范围

需要以下 OAuth 范围:

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