Method: projects.locations.collections.engines.sessions.files.list

現在のセッション内のすべてのファイルのメタデータを一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/sessions/*}/files

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

パスパラメータ

パラメータ
parent

string

必須。セッションのリソース名。形式: ファイルが属するセッション リソースの projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} 名。

クエリ パラメータ

パラメータ
filter

string

省略可。フィルタ構文は、フィルタ対象となるファイルの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。フィルタ式では大文字と小文字が区別されます。

現在サポートされているフィールド名は次のとおりです。

  • upload_time
  • last_add_time
  • last_use_time
  • file_name
  • mime_type

フィルタの例を次に示します。

  • "file_name = 'file_1'"
  • "file_name = 'file_1' AND mime_type = 'text/plain'"
  • 「last_use_time > '2025-06-14T12:00:00Z'」

フィルタ形式の詳細については、https://google.aip.dev/160 をご覧ください。
pageSize

integer

省略可。返されるファイルの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 100 個のファイルが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。ユーザーが 0 以下の値を指定した場合、リクエストは INVALID_ARGUMENT エラーで拒否されます。
pageToken

string

省略可。前回の files.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、files.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります（pageSize は異なる場合があります）。
orderBy

string

省略可。ファイルが返される順序を指定します。

値は、並べ替えに使用するフィールドのカンマ区切りの文字列です。

昇順の場合 - フィールド名のみが使用されます。降順の場合 - フィールド名の末尾に desc が付加されます。並べ替えは安定しており、文字列で指定されたフィールドの順序に従って順番に適用されます。

並べ替えに対応するフィールド:

  • upload_time: ファイルがアップロードされた時刻。
  • file_name: ファイルの名前。
  • mime_type: ファイルの MIME タイプ。
  • session_name: ファイルが属するセッションの名前。

デフォルトの動作:

orderBy フィールドが指定されていない場合、ファイルは作成時刻の降順で並べ替えられて返されます。

例:

  1. ファイル名を昇順で並べ替えます: file_name

  2. アップロード時間を降順で並べ替えます: upload_time desc

  3. ファイル名（昇順）、コンテンツ タイプ（MIME タイプ）（降順）、アップロード時間（昇順）で並べ替えます。file_name, mime_type desc, upload_time

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

SessionService.ListFiles メソッドに対するレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "files": [
    {
      object (FileMetadata)
    }
  ],
  "nextPageToken": string
}
フィールド
files[]

object (FileMetadata)

FileMetadata。
nextPageToken

string

結果の次のページを取得するためのトークン。この値を次の files.list メソッド呼び出しの ListFilesRequest.page_token フィールドで渡して、結果の次ページを取得します。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.sessions.listSessionFileMetadata

詳細については、IAM のドキュメントをご覧ください。

FileMetadata

セッションに添付されたファイル（コンテキスト ファイル）を表します

JSON 表現 
{
  "fileId": string,
  "name": string,
  "mimeType": string,
  "byteSize": string,
  "originalUri": string,
  "originalSourceType": enum (FileSource),
  "uploadTime": string,
  "lastAddTime": string,
  "metadata": {
    string: string,
    ...
  },
  "downloadUri": string,
  "fileOriginType": enum (FileOriginType),
  "views": {
    string: {
      object (FileView)
    },
    ...
  }
}
フィールド
fileId

string

出力専用。ファイルの ID。
name

string

出力専用。アップロードされたファイルの名前。
mimeType

string

ファイルのコンテンツ タイプ。https://www.iana.org/assignments/media-types/media-types.xhtml をご覧ください。
byteSize

string (int64 format)

出力専用。コンテキスト ファイルのサイズ（バイト単位）。
originalUri

string

省略可。ファイルの元の場所。ローカル ファイルパス、または外部システムでファイルにアクセスできるその他の URI を指定できます。この URL が空になるシナリオは 2 つあります。1. ファイルがインライン データとして送信された場合（クリップボードから貼り付けられた場合など）。2. 元の場所が利用できない場合。

URI が有効なファイルまたは実際に存在するファイルを指している保証はありません。たとえば、ファイルがセッションにアップロードされた後、元のソースから削除された場合などです。
originalSourceType

enum (FileSource)

省略可。ファイルの元のソースのタイプ。
uploadTime

string (Timestamp format)

出力専用。ファイルがアップロードされた時刻（内部プロセスで生成され、セッションで使用可能になったファイルの場合は、その時点を示します）。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
lastAddTime

string (Timestamp format)

出力専用。ファイルがセッションに追加された時刻。ファイルを追加してから外部で変更し、再度追加した場合、追加時間は更新されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
metadata

map (key: string, value: string)

省略可。特定のユースケースに適したファイルに関連するメタデータを表します。接頭辞「google.」は、Google が使用するキー用に予約されていますが、他の接頭辞は自由に使用できます。
downloadUri

string

出力専用。ファイルをダウンロードするための AssistantService.DownloadSessionFile URL。この URL には AssistantService.ListSessionFileMetadata メソッドと同じ認証情報が必要で、リソースが提供されます。
fileOriginType

enum (FileOriginType)

省略可。ファイルの生成元。
views

map (key: string, value: object (FileView))

出力専用。このファイル オブジェクトの代替ビュー。各ファイルビューは特定のロールに関連付けられています。キーの例: - 「thumbnail」 - 「mobile_thumbnail」 - 「clip」 - 「summary」 - 「translation」

FileOriginType

ファイルの生成元。

列挙型
FILE_ORIGIN_TYPE_UNSPECIFIED デフォルト値。
USER_PROVIDED ユーザーが提供したファイル。
AI_GENERATED ファイルは AI モデルによって生成されました。
INTERNALLY_GENERATED ファイルは内部プロセスによって他のファイルから生成されました。

FileView

ファイル オブジェクトの特定の代替バージョンまたは「ビュー」（概要、サムネイル、翻訳版など）を表します。

JSON 表現 
{
  "viewId": string,
  "uri": string,
  "mimeType": string,
  "byteSize": string,
  "createTime": string,

  // Union field characteristics can be only one of the following:
  "imageCharacteristics": {
    object (ImageCharacteristics)
  },
  "videoCharacteristics": {
    object (VideoCharacteristics)
  },
  "fileCharacteristics": {
    object (FileCharacteristics)
  }
  // End of list of possible types for union field characteristics.
}
フィールド
viewId

string

出力専用。この特定のビューのグローバルに一意な ID。
uri

string

出力専用。このメディアビューにアクセスするための URI。
mimeType

string

出力専用。MIME タイプ（例: "image/jpeg", "image/png", "text/plain", "video/mp4")
byteSize

string (int64 format)

出力専用。ビューのサイズ（バイト単位）。
createTime

string (Timestamp format)

出力専用。ビューが作成された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
共用体フィールド characteristics。メディアビューの特性。柔軟な拡張が可能になります。メタデータは、ビューを作成するプロセスによって常に内部的に生成されます。characteristics は次のいずれかになります。
imageCharacteristics

object (ImageCharacteristics)

出力専用。画像メディアビューの特性。
videoCharacteristics

object (VideoCharacteristics)

出力専用。動画メディア ビューの特性。
fileCharacteristics

object (FileCharacteristics)

出力専用。その他のファイル形式の特徴。

ImageCharacteristics

画像メディア ビューの標準的な特性。

JSON 表現 
{
  "width": integer,
  "height": integer,
  "colorSpace": enum (ColorSpace),
  "bitDepth": integer
}
フィールド
width

integer

出力専用。画像の幅（ピクセル単位）。
height

integer

出力専用。画像の高さ（ピクセル単位）。
colorSpace

enum (ColorSpace)

出力専用。画像のカラースペース（例: 「RGB」、「CMYK」、「Grayscale」）。
bitDepth

integer

出力専用。画像のビット深度（8 ビット、16 ビット）。

ColorSpace

画像の可能なカラースペース（例: 「RGB」、「CMYK」、「Grayscale」）。

列挙型
COLOR_SPACE_UNSPECIFIED デフォルト値。不明な色空間。
RGB 赤、緑、青のカラースペース。
CMYK シアン、マゼンタ、イエロー、ブラックのカラースペース。
GRAYSCALE グレースケール色空間。
YUV YUV 色空間。
OTHER_COLOR_SPACE その他のカラースペース。

VideoCharacteristics

動画メディア ビューの標準的な特性。

JSON 表現 
{
  "width": integer,
  "height": integer,
  "duration": string,
  "frameRate": number,
  "audioCodecs": [
    string
  ],
  "videoCodecs": [
    string
  ],
  "videoBitrateKbps": integer,
  "audioBitrateKbps": integer
}
フィールド
width

integer

出力専用。動画の幅（ピクセル単位）。
height

integer

出力専用。動画の高さ（ピクセル単位）。
duration

string (Duration format)

出力専用。動画の再生時間。

s で終わる小数点以下 9 桁までの秒単位の期間。例: "3.5s"。
frameRate

number

出力専用。フレームレート（フレーム数/秒）。
audioCodecs[]

string

出力専用。動画で使用されているオーディオ コーデック。
videoCodecs[]

string

出力専用。動画で使用されている動画コーデック。
videoBitrateKbps

integer

出力専用。動画のビットレート（kbps）。
audioBitrateKbps

integer

出力専用。音声のビットレート（kbps）。

FileCharacteristics

他のファイル形式の特徴。

JSON 表現 
{
  "characteristics": {
    string: string,
    ...
  }
}
フィールド
characteristics

map (key: string, value: string)

出力専用。特性の一般的なマップ。