Drive のルートまたは指定ディレクトリ内のファイルとサブディレクトリを取得します。
Drive は現在 Beta 機能です。API 定義、レスポンス構造、動作は変更される可能性があります。ドキュメントの更新を確認し、本番環境で使用する前に互換性を検証してください。
GET /api/v1/forward/drives/entries
リクエストヘッダー
| Header | 必須 | 説明 |
|---|---|---|
| Authorization | はい | Bearer <PAT or SAT> |
クエリパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| identity_id | string | はい | 現在の認証範囲内の Identity ID。必ず 1 回だけ指定します。Identity レベルの SAT は、紐付けられた Identity のみを選択できます。 |
| path | string | いいえ | ディレクトリの相対パス。デフォルトは空文字列で、ルートを表します。 |
| limit | integer | いいえ | デフォルト 20、範囲 1~100。指定できるのは 1 回のみです。 |
| page_token | string | いいえ | 前回のレスポンスの next_page_token。初回は省略します。同じ認証情報のリソース範囲、Identity、ディレクトリで使用してください。最大 8192 バイトで、変更できません。 |
パスのルール
path を省略するか空文字列を指定するとルートを表します。空でないパスには以下のルールが適用されます:
projects/reportsなど、有効な UTF-8 の相対パスを使用します。/projects/reportsやC:/projects/reportsなどの絶対パスは使用できません。- ディレクトリは
/で区切ります。先頭・末尾・連続する/、バックスラッシュ、.および..のパス要素は使用できません。 - 先頭・末尾の空白、制御文字、
%(projects%2Freportsのようなエスケープ済み文字列を含む)は使用できません。
path=projects/reportsのように区切り文字/を保持し、%2Fにエンコードしないでください。- 中国語と予約文字には標準のフォーム URL エンコードを使用し、空白には
+を使用します。
リクエスト例
レスポンス例
HTTP 200 OK
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
| entries | array | 現在のディレクトリの直下の項目をパスの辞書順で返します。ディレクトリが存在しない場合や空の場合は []。 |
| entries[].path | string | Drive 内の相対パス。ディレクトリの末尾に / は付きません。 |
| entries[].name | string | 現在の階層のファイル名またはディレクトリ名。 |
| entries[].type | string | file または directory。 |
| entries[].size | integer | ファイルサイズ(バイト)。0 バイトのファイルは 0、ディレクトリでは省略されます。 |
| entries[].etag | string | ファイルの ETag。空でない場合に返され、ディレクトリでは省略されます。 |
| entries[].last_modified | string | ファイルの最終更新時刻(RFC 3339)。時刻がない場合やディレクトリでは省略されます。 |
| next_page_token | string | 次のページがある場合に返され、最終ページでは省略されます。次のリクエストの page_token にそのまま渡してください。 |
エラー
| HTTP | Code | 発生条件 |
|---|---|---|
| 400 | invalid_drive_path | パス、クエリ内のパスのエンコード、または Identity 識別子の形式が無効です。 |
| 400 | invalid_limit | ページサイズが 1~100 の整数ではないか、複数回指定されています。 |
| 400 | invalid_page_token | ページトークンが無効、変更済み、または別のリソース範囲、Identity、ディレクトリに使用されています。 |
| 400 | invalid_identity_id | identity_id が未指定、空、または複数回指定されています。 |
| 401 | — | 認証情報が未指定または無効です。Service Account Key は事前に SAT と交換してください。 |
| 403 | identity_mismatch | Identity レベルの SAT で別の Identity を選択しています。 |
| 404 | identity_not_found | 現在の認証範囲内に Identity が見つかりません。 |
| 500 | — | 内部サーバーエラー。 |
| 503 | drive_unavailable | Drive のストレージ、署名、または依存機能が一時的に利用できません。 |
HTTP エラーレスポンス
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
| type | string | 常に error。 |
| request_id | string | リクエスト追跡 ID。利用可能な場合に返されます。 |
| error.type | string | エラーの分類。例:invalid_request_error、authentication_error、permission_error、not_found_error、conflict_error、api_error。 |
| error.code | string | 業務エラーコード。一部の共通エラーでは返されません。 |
| error.message | string | エラーの説明。 |

