Method: mediaItems.list

指定したデバイスのユーザーが設定したメディアソースのアンビエント メディア アイテムのリストを返します。

デフォルトでは、listMediaItems はアンビエント エクスペリエンスを提供します。ユーザーが設定したすべてのソースから、厳選された一連のメディア アイテムを返します。

必要に応じて、リクエストに mediaSourceId を含めて、特定のメディアソースからアイテムのページネーション リストを取得し、従来のフィルタリングを行うことができます。

クライアント アプリケーションは、デバイスごとに 1 日あたり 240 件のリクエストに制限されています。

ユーザーがメディアソースを構成していない場合、FAILED_PRECONDITION エラーが発生します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
deviceId

string

必須。このデバイスの一意の識別子。

mediaSourceId

string

省略可。アンビエント エクスペリエンスの場合は、このフィールドを省略します。これにより、設定されたすべてのソースからキュレートされたメディア アイテムのセットが返されます。返されるアイテムの数は、pageSize リクエストに基づいて最大 100 個になります。指定すると、指定したメディアソースのアイテムのみが返されます。

id は、指定されたデバイスに対してユーザーが選択したソース(AmbientDevice.media_sources.id のいずれか)である必要があります。

なお、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