GET/users/{userId}/drive/favorites

よく使う項目に含まれるフォルダのリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/drive/favorites

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{externalKey})
  • 自身 ("me")

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
files array (File) 

ファイル情報

 
responseMetaData object (responseMetaData) 

応答のメタデータ

 

File

PropertyTypeDescription
accessedTime string 

アクセス日時


readOnly : true 
createdTime string 

作成日時


readOnly : true 
modifiedTime string 

更新日時


readOnly : true 
fileId string 

ファイル ID


readOnly : true 
parentFileId string 

親ファイル ID


readOnly : true 
fileName string 

ファイル名


readOnly : true 
fileSize integer 

ファイルサイズ


format : int64
readOnly : true 
filePath string 

ファイルパス


readOnly : true 
fileType string 

ファイルタイプ

  • AUDIO : オーディオファイル
  • DOC : 文書ファイル
  • ETC : その他のファイル
  • EXE : 実行ファイル
  • FOLDER : フォルダ
  • IMAGE : 画像ファイル
  • VIDEO : 動画ファイル
  • ZIP : 圧縮ファイル

Allowed values : AUDIO, DOC, ETC, EXE, FOLDER, IMAGE, VIDEO, ZIP 
hasPermission boolean 

アクセス権限有りフラグ


readOnly : true
nullable : false 
permissionRootFileId string 

アクセス権限ルートファイル ID


readOnly : true
nullable : true 
shared boolean 

共有状態


readOnly : true
nullable : false 
shareRootFileId string 

共有したフォルダのルートフォルダ ID


readOnly : true
nullable : true 
resourceLocation integer 

リソースロケーションコード


format : int32
readOnly : true 
statuses array (FileStatus) 

ファイルステータス


Allowed values : LOCKED, MALWARE, PROTECTED, IN_PROGRESS 
driveInfo object (driveInfo) 

File Resource を含むドライブ情報

 

FileStatus

PropertyTypeDescription
FileStatus string 

ファイルステータス

  • LOCKED : ロックされたファイル
  • MALWARE : マルウェアファイル
  • PROTECTED : 重要表示されたファイル
  • IN_PROGRESS : アップロード中

Allowed values : LOCKED, MALWARE, PROTECTED, IN_PROGRESS 

driveInfo

PropertyTypeDescription
driveType string 

ドライブタイプ

  • MY_DRIVE: マイドライブ
  • SHARED_FOLDER: 共有されたフォルダ
  • SHARE_DRIVE: 共有ドライブ
  • CHANNEL_FOLDER: 組織/グループ/トークルームフォルダ

Allowed values : MY_DRIVE, SHARED_FOLDER, SHARE_DRIVE, CHANNEL_FOLDER 
id string 

driveType に応じた値が返る。


readOnly : true
nullable : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値


readOnly : true 

Response Example

example

1{2  "files": [3    {4      "fileId": "QDIxMDAwMDAwMDAwMTcwfDExODE1MDg3MzQ0NzJ8RHww",5      "parentFileId": "QDIxMDAwMDAwMDAwMTcwfDExNzgyODY2MjgxMDR8RHww",6      "resourceLocation": 24101,7      "fileSize": 10,8      "fileName": "works.txt",9      "filePath": "/ShareDriveName/works.txt",10      "fileType": "DOC",11      "createdTime": "2020-11-13T18:20:05+09:00",12      "modifiedTime": "2021-04-05T21:14:05+09:00",13      "accessedTime": "2021-04-05T21:14:05+09:00",14      "statuses": [],15      "hasPermission": false,16      "permissionRootFileId": null,17      "driveInfo": {18        "driveType": "SHARE_DRIVE",19        "id": "@248080202002"20      }21    },22    {23      "fileId": "MTU1NzYwMDF8MzQ3MjQ3MTI0MDkxNzYzNTMzN3xEfDA",24      "parentFileId": "MTU1NzYwMDF8MzQ3MjQ3MTI0MDY1MTQxMTcyMHxEfDA",25      "resourceLocation": 24101,26      "fileSize": 0,27      "fileName": "worksFolder",28      "filePath": "/GroupFolderName/worksFolder/",29      "fileType": "FOLDER",30      "createdTime": "2020-11-13T18:20:05+09:00",31      "modifiedTime": "2021-04-05T21:14:05+09:00",32      "accessedTime": "2021-04-05T21:14:05+09:00",33      "statuses": [],34      "hasPermission": false,35      "permissionRootFileId": null,36      "driveInfo": {37        "driveType": "CHANNEL_FOLDER",38        "id": "@93000099002912"39      }40    }41  ],42  "responseMetaData": {43    "nextCursor": "lIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="44  }45}