Method: mediaItems.search

HTTP リクエスト

POST https://photoslibrary.googleapis.com/v1/mediaItems:search

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

{
  "albumId": string,
  "pageSize": integer,
  "pageToken": string,
  "filters": {
    object (Filters)
  },
  "orderBy": string
}

レスポンスの本文

{
  "mediaItems": [
    {
      object (MediaItem)
    }
  ],
  "nextPageToken": string
}

認可スコープ

次の OAuth スコープのいずれかが必要です。

• https://www.googleapis.com/auth/photoslibrary
• https://www.googleapis.com/auth/photoslibrary.readonly
• https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata

メディア アイテムの検索に適用できるフィルタです。複数のフィルタ オプションを指定すると、AND 条件として扱われます。

このフィルタは、返されるメディアに許可される日付または期間を定義します。特定の日付のセットと期間のセットを指定できます。メディア アイテムをキャプチャした日付を指定するメタデータなしでアップロードされたメディア アイテムは、日付フィルタを使用したクエリでは返されません。この場合、Google フォト サーバーへのアップロード時間はフォールバックとして使用されません。

カレンダーの日付全体を表します。月と年のみが重要な場合（2018 年 12 月全体など）は、day を 0 に設定します。年のみが重要である場合（2018 年全体など）は、day と month を 0 に設定します。日と月のみ（記念日や誕生日など）が重要な場合は、year を 0 に設定します。

サポート対象外: すべての値を 0 に設定する、month のみを 0 に設定する、day と year の両方を同時に 0 に設定する。

日付の範囲を定義します。開始日と終了日は同じ形式にする必要があります。詳しくは Date をご覧ください。

このフィルタを使用すると、コンテンツ タイプに基づいてメディア アイテムを返すことができます。

含めるカテゴリのリストや除外するカテゴリのリストを指定できます。各リストでは、カテゴリは OR 条件として処理されます。

コンテンツ フィルタを includedContentCategories: [c1, c2, c3] と指定すると、c1、c2、c3 のいずれかを含むメディア アイテムが取得されます。

コンテンツ フィルタを excludedContentCategories: [c1, c2, c3] と指定すると、c1、c2、c3 のいずれかを含むメディア アイテムは除外されます。

一部のカテゴリを含み、同時に一部のカテゴリを除外することもできます。その場合、includedContentCategories: [c1, c2] と excludedContentCategories: [c3, c4] のように指定します。

上記の例では、（c1 または c2）かつ（c3 または c4）を含まないメディア アイテムが取得されます。includedContentategories に指定したカテゴリを excludedContentCategories に指定することはできません。

事前定義済みのフィルタ可能なコンテンツ カテゴリのセットです。

このフィルタでは、返されるメディア アイテムのタイプを定義します（動画や写真など）。サポートされるメディアタイプは 1 つのみです。

検索可能なメディアタイプのセットです。

このフィルタでは、メディア アイテムに含まれている必要がある機能を定義します。

フィルタできる機能のセットです。